@arbidocs/client 0.3.27 → 0.3.29
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +2 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +983 -249
- package/dist/index.d.ts +983 -249
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -5,6 +5,177 @@ import createFetchClient, { Middleware } from 'openapi-fetch';
|
|
|
5
5
|
* Do not make direct changes to the file.
|
|
6
6
|
*/
|
|
7
7
|
interface paths {
|
|
8
|
+
'/v1/user/projects/': {
|
|
9
|
+
parameters: {
|
|
10
|
+
query?: never;
|
|
11
|
+
header?: never;
|
|
12
|
+
path?: never;
|
|
13
|
+
cookie?: never;
|
|
14
|
+
};
|
|
15
|
+
/**
|
|
16
|
+
* List Projects
|
|
17
|
+
* @description List all projects owned by the current user.
|
|
18
|
+
*/
|
|
19
|
+
get: operations['list_projects'];
|
|
20
|
+
put?: never;
|
|
21
|
+
/**
|
|
22
|
+
* Create Project
|
|
23
|
+
* @description Create a new project.
|
|
24
|
+
*/
|
|
25
|
+
post: operations['create_project'];
|
|
26
|
+
delete?: never;
|
|
27
|
+
options?: never;
|
|
28
|
+
head?: never;
|
|
29
|
+
patch?: never;
|
|
30
|
+
trace?: never;
|
|
31
|
+
};
|
|
32
|
+
'/v1/user/projects/{project_ext_id}': {
|
|
33
|
+
parameters: {
|
|
34
|
+
query?: never;
|
|
35
|
+
header?: never;
|
|
36
|
+
path?: never;
|
|
37
|
+
cookie?: never;
|
|
38
|
+
};
|
|
39
|
+
get?: never;
|
|
40
|
+
put?: never;
|
|
41
|
+
post?: never;
|
|
42
|
+
/**
|
|
43
|
+
* Delete Project
|
|
44
|
+
* @description Delete a project. Only allowed when empty (no workspaces, no subscription).
|
|
45
|
+
*/
|
|
46
|
+
delete: operations['delete_project'];
|
|
47
|
+
options?: never;
|
|
48
|
+
head?: never;
|
|
49
|
+
/**
|
|
50
|
+
* Update Project
|
|
51
|
+
* @description Update project name.
|
|
52
|
+
*/
|
|
53
|
+
patch: operations['update_project'];
|
|
54
|
+
trace?: never;
|
|
55
|
+
};
|
|
56
|
+
'/v1/user/projects/{project_ext_id}/checkout': {
|
|
57
|
+
parameters: {
|
|
58
|
+
query?: never;
|
|
59
|
+
header?: never;
|
|
60
|
+
path?: never;
|
|
61
|
+
cookie?: never;
|
|
62
|
+
};
|
|
63
|
+
get?: never;
|
|
64
|
+
put?: never;
|
|
65
|
+
/**
|
|
66
|
+
* Create Project Checkout
|
|
67
|
+
* @description Create a Stripe checkout session for this project.
|
|
68
|
+
*/
|
|
69
|
+
post: operations['create_project_checkout'];
|
|
70
|
+
delete?: never;
|
|
71
|
+
options?: never;
|
|
72
|
+
head?: never;
|
|
73
|
+
patch?: never;
|
|
74
|
+
trace?: never;
|
|
75
|
+
};
|
|
76
|
+
'/v1/user/projects/{project_ext_id}/change-plan': {
|
|
77
|
+
parameters: {
|
|
78
|
+
query?: never;
|
|
79
|
+
header?: never;
|
|
80
|
+
path?: never;
|
|
81
|
+
cookie?: never;
|
|
82
|
+
};
|
|
83
|
+
get?: never;
|
|
84
|
+
put?: never;
|
|
85
|
+
/**
|
|
86
|
+
* Change Project Plan
|
|
87
|
+
* @description Change pack quantity for a project.
|
|
88
|
+
*
|
|
89
|
+
* - Increase: proration_behavior="create_prorations" (charges difference immediately)
|
|
90
|
+
* - Decrease: proration_behavior="none" (keeps current packs until period end)
|
|
91
|
+
*/
|
|
92
|
+
post: operations['change_project_plan'];
|
|
93
|
+
delete?: never;
|
|
94
|
+
options?: never;
|
|
95
|
+
head?: never;
|
|
96
|
+
patch?: never;
|
|
97
|
+
trace?: never;
|
|
98
|
+
};
|
|
99
|
+
'/v1/user/projects/{project_ext_id}/refresh': {
|
|
100
|
+
parameters: {
|
|
101
|
+
query?: never;
|
|
102
|
+
header?: never;
|
|
103
|
+
path?: never;
|
|
104
|
+
cookie?: never;
|
|
105
|
+
};
|
|
106
|
+
get?: never;
|
|
107
|
+
put?: never;
|
|
108
|
+
/**
|
|
109
|
+
* Refresh Project
|
|
110
|
+
* @description Refresh project status from Stripe (call after checkout completes).
|
|
111
|
+
*/
|
|
112
|
+
post: operations['refresh_project'];
|
|
113
|
+
delete?: never;
|
|
114
|
+
options?: never;
|
|
115
|
+
head?: never;
|
|
116
|
+
patch?: never;
|
|
117
|
+
trace?: never;
|
|
118
|
+
};
|
|
119
|
+
'/v1/user/projects/{project_ext_id}/usage': {
|
|
120
|
+
parameters: {
|
|
121
|
+
query?: never;
|
|
122
|
+
header?: never;
|
|
123
|
+
path?: never;
|
|
124
|
+
cookie?: never;
|
|
125
|
+
};
|
|
126
|
+
/**
|
|
127
|
+
* Get Project Usage Endpoint
|
|
128
|
+
* @description Get AI usage breakdown for a project's billing period.
|
|
129
|
+
*/
|
|
130
|
+
get: operations['get_project_usage'];
|
|
131
|
+
put?: never;
|
|
132
|
+
post?: never;
|
|
133
|
+
delete?: never;
|
|
134
|
+
options?: never;
|
|
135
|
+
head?: never;
|
|
136
|
+
patch?: never;
|
|
137
|
+
trace?: never;
|
|
138
|
+
};
|
|
139
|
+
'/v1/user/projects/{project_ext_id}/invoices': {
|
|
140
|
+
parameters: {
|
|
141
|
+
query?: never;
|
|
142
|
+
header?: never;
|
|
143
|
+
path?: never;
|
|
144
|
+
cookie?: never;
|
|
145
|
+
};
|
|
146
|
+
/**
|
|
147
|
+
* Get Project Invoices
|
|
148
|
+
* @description List Stripe invoices for a project's subscription.
|
|
149
|
+
*/
|
|
150
|
+
get: operations['get_project_invoices'];
|
|
151
|
+
put?: never;
|
|
152
|
+
post?: never;
|
|
153
|
+
delete?: never;
|
|
154
|
+
options?: never;
|
|
155
|
+
head?: never;
|
|
156
|
+
patch?: never;
|
|
157
|
+
trace?: never;
|
|
158
|
+
};
|
|
159
|
+
'/v1/user/projects/{project_ext_id}/cancel': {
|
|
160
|
+
parameters: {
|
|
161
|
+
query?: never;
|
|
162
|
+
header?: never;
|
|
163
|
+
path?: never;
|
|
164
|
+
cookie?: never;
|
|
165
|
+
};
|
|
166
|
+
get?: never;
|
|
167
|
+
put?: never;
|
|
168
|
+
/**
|
|
169
|
+
* Cancel Project Subscription
|
|
170
|
+
* @description Cancel a project's subscription at the end of the current billing period.
|
|
171
|
+
*/
|
|
172
|
+
post: operations['cancel_project_subscription'];
|
|
173
|
+
delete?: never;
|
|
174
|
+
options?: never;
|
|
175
|
+
head?: never;
|
|
176
|
+
patch?: never;
|
|
177
|
+
trace?: never;
|
|
178
|
+
};
|
|
8
179
|
'/v1/user/verify-email': {
|
|
9
180
|
parameters: {
|
|
10
181
|
query?: never;
|
|
@@ -387,33 +558,6 @@ interface paths {
|
|
|
387
558
|
patch?: never;
|
|
388
559
|
trace?: never;
|
|
389
560
|
};
|
|
390
|
-
'/v1/user/subscription': {
|
|
391
|
-
parameters: {
|
|
392
|
-
query?: never;
|
|
393
|
-
header?: never;
|
|
394
|
-
path?: never;
|
|
395
|
-
cookie?: never;
|
|
396
|
-
};
|
|
397
|
-
/**
|
|
398
|
-
* Get Stripe Subscription
|
|
399
|
-
* @description Get detailed Stripe subscription information including portal URL for management.
|
|
400
|
-
*
|
|
401
|
-
* First updates local subscription status based on Stripe subscription tier (to refresh after purchase),
|
|
402
|
-
* then fetches detailed subscription information from Stripe Subscriptions API.
|
|
403
|
-
*/
|
|
404
|
-
get: operations['get_subscription'];
|
|
405
|
-
put?: never;
|
|
406
|
-
/**
|
|
407
|
-
* Create Subscription
|
|
408
|
-
* @description Create a new Stripe checkout session for subscription purchase.
|
|
409
|
-
*/
|
|
410
|
-
post: operations['create_subscription'];
|
|
411
|
-
delete?: never;
|
|
412
|
-
options?: never;
|
|
413
|
-
head?: never;
|
|
414
|
-
patch?: never;
|
|
415
|
-
trace?: never;
|
|
416
|
-
};
|
|
417
561
|
'/v1/workspace/create_protected': {
|
|
418
562
|
parameters: {
|
|
419
563
|
query?: never;
|
|
@@ -708,7 +852,7 @@ interface paths {
|
|
|
708
852
|
* - tag_ext_id: Links document to a tag
|
|
709
853
|
* - folder: Logical folder path for grouping (URL safe, e.g., 'skills/weather')
|
|
710
854
|
*
|
|
711
|
-
* Requires active subscription
|
|
855
|
+
* Requires active subscription if Stripe is configured.
|
|
712
856
|
*/
|
|
713
857
|
post: operations['upload_documents'];
|
|
714
858
|
delete?: never;
|
|
@@ -731,7 +875,7 @@ interface paths {
|
|
|
731
875
|
* @description Download and upload documents from URLs to a workspace with encryption.
|
|
732
876
|
* Documents are queued for processing, parsed, and indexed for vector search.
|
|
733
877
|
*
|
|
734
|
-
* Requires active subscription
|
|
878
|
+
* Requires active subscription if Stripe is configured.
|
|
735
879
|
*/
|
|
736
880
|
post: operations['upload_from_url'];
|
|
737
881
|
delete?: never;
|
|
@@ -996,7 +1140,7 @@ interface paths {
|
|
|
996
1140
|
* @description Process a user query against documents in a workspace.
|
|
997
1141
|
* Performs retrieval augmented generation with streaming response.
|
|
998
1142
|
*
|
|
999
|
-
* Requires active
|
|
1143
|
+
* Requires active project if Stripe is configured.
|
|
1000
1144
|
*/
|
|
1001
1145
|
post: operations['generate'];
|
|
1002
1146
|
delete?: never;
|
|
@@ -1832,6 +1976,33 @@ interface components {
|
|
|
1832
1976
|
*/
|
|
1833
1977
|
AGENT_SYSTEM_PROMPT: string;
|
|
1834
1978
|
};
|
|
1979
|
+
/** AgentsUserConfig */
|
|
1980
|
+
AgentsUserConfig: {
|
|
1981
|
+
/**
|
|
1982
|
+
* Enabled
|
|
1983
|
+
* @description Whether to use agents mode for queries.
|
|
1984
|
+
* @default true
|
|
1985
|
+
*/
|
|
1986
|
+
ENABLED: boolean;
|
|
1987
|
+
/**
|
|
1988
|
+
* Memory Enabled
|
|
1989
|
+
* @description Run memory synthesis (skills, memories) after agent queries.
|
|
1990
|
+
* @default false
|
|
1991
|
+
*/
|
|
1992
|
+
MEMORY_ENABLED: boolean;
|
|
1993
|
+
/**
|
|
1994
|
+
* Persona
|
|
1995
|
+
* @description Agent persona prepended to the system prompt. Customise to change the agent's identity and tone.
|
|
1996
|
+
* @default You are ARBI, an AI assistant created by ARBI CITY. Be proactive, helpful and professional.
|
|
1997
|
+
*/
|
|
1998
|
+
PERSONA: string;
|
|
1999
|
+
/**
|
|
2000
|
+
* Agent Model Name
|
|
2001
|
+
* @description The name of the model to be used for the agent decision-making.
|
|
2002
|
+
* @default auto
|
|
2003
|
+
*/
|
|
2004
|
+
AGENT_MODEL_NAME: string;
|
|
2005
|
+
};
|
|
1835
2006
|
/** AllConfigs */
|
|
1836
2007
|
AllConfigs: {
|
|
1837
2008
|
/**
|
|
@@ -1944,6 +2115,8 @@ interface components {
|
|
|
1944
2115
|
* "TEMPERATURE": 0.1,
|
|
1945
2116
|
* "MAX_TOKENS": 2000,
|
|
1946
2117
|
* "MAX_CONCURRENT_DOCS": 10,
|
|
2118
|
+
* "AUTO_RENAME": false,
|
|
2119
|
+
* "AUTO_RENAME_INSTRUCTION": "Create a short substantive title for the document of no more than 10 words. E.g. \"Email from X to Y re ABC\", \"Service Agreement between A and B\".",
|
|
1947
2120
|
* "DEFAULT_METADATA_TAGS": [
|
|
1948
2121
|
* {
|
|
1949
2122
|
* "instruction": "What is the primary date of this document (creation date, signing date, or effective date)? Identify the most significant date such as the document's creation, signing, or effective date.",
|
|
@@ -2895,22 +3068,6 @@ interface components {
|
|
|
2895
3068
|
*/
|
|
2896
3069
|
query: string;
|
|
2897
3070
|
};
|
|
2898
|
-
/**
|
|
2899
|
-
* CreateSubscriptionRequest
|
|
2900
|
-
* @description Request to create a new subscription checkout session.
|
|
2901
|
-
*/
|
|
2902
|
-
CreateSubscriptionRequest: {
|
|
2903
|
-
/** Price Id */
|
|
2904
|
-
price_id: string;
|
|
2905
|
-
};
|
|
2906
|
-
/**
|
|
2907
|
-
* CreateSubscriptionResponse
|
|
2908
|
-
* @description Response containing Stripe checkout session client secret.
|
|
2909
|
-
*/
|
|
2910
|
-
CreateSubscriptionResponse: {
|
|
2911
|
-
/** Client Secret */
|
|
2912
|
-
client_secret: string;
|
|
2913
|
-
};
|
|
2914
3071
|
/**
|
|
2915
3072
|
* CreateTagRequest
|
|
2916
3073
|
* @description Request to create a new tag in a workspace.
|
|
@@ -2926,6 +3083,36 @@ interface components {
|
|
|
2926
3083
|
/** Parent Ext Id */
|
|
2927
3084
|
parent_ext_id?: string | null;
|
|
2928
3085
|
};
|
|
3086
|
+
/**
|
|
3087
|
+
* DailyUsage
|
|
3088
|
+
* @description Usage for a single day.
|
|
3089
|
+
*/
|
|
3090
|
+
DailyUsage: {
|
|
3091
|
+
/** Date */
|
|
3092
|
+
date: string;
|
|
3093
|
+
/**
|
|
3094
|
+
* Spend
|
|
3095
|
+
* @default 0
|
|
3096
|
+
*/
|
|
3097
|
+
spend: number;
|
|
3098
|
+
/**
|
|
3099
|
+
* Total Tokens
|
|
3100
|
+
* @default 0
|
|
3101
|
+
*/
|
|
3102
|
+
total_tokens: number;
|
|
3103
|
+
/**
|
|
3104
|
+
* Api Requests
|
|
3105
|
+
* @default 0
|
|
3106
|
+
*/
|
|
3107
|
+
api_requests: number;
|
|
3108
|
+
/**
|
|
3109
|
+
* Model Groups
|
|
3110
|
+
* @default {}
|
|
3111
|
+
*/
|
|
3112
|
+
model_groups: {
|
|
3113
|
+
[key: string]: components['schemas']['ModelGroupUsage'];
|
|
3114
|
+
};
|
|
3115
|
+
};
|
|
2929
3116
|
/**
|
|
2930
3117
|
* DeleteAgentsRequest
|
|
2931
3118
|
* @description Request to delete agents by external ID.
|
|
@@ -3125,6 +3312,11 @@ interface components {
|
|
|
3125
3312
|
* @description Logical folder path (URL safe)
|
|
3126
3313
|
*/
|
|
3127
3314
|
folder?: string | null;
|
|
3315
|
+
/**
|
|
3316
|
+
* Config Ext Id
|
|
3317
|
+
* @description Configuration to use for reprocessing. If provided, overrides the document's stored config.
|
|
3318
|
+
*/
|
|
3319
|
+
config_ext_id?: string | null;
|
|
3128
3320
|
};
|
|
3129
3321
|
/**
|
|
3130
3322
|
* DoctagLLMConfig
|
|
@@ -3186,57 +3378,43 @@ interface components {
|
|
|
3186
3378
|
* @default 10
|
|
3187
3379
|
*/
|
|
3188
3380
|
MAX_CONCURRENT_DOCS: number;
|
|
3381
|
+
/**
|
|
3382
|
+
* Auto Rename
|
|
3383
|
+
* @description Generate a descriptive document title via LLM instead of using the filename. The generated title replaces the filename-derived title in doc_metadata.
|
|
3384
|
+
* @default false
|
|
3385
|
+
*/
|
|
3386
|
+
AUTO_RENAME: boolean;
|
|
3387
|
+
/**
|
|
3388
|
+
* Auto Rename Instruction
|
|
3389
|
+
* @description Instruction for generating document titles when AUTO_RENAME is enabled.
|
|
3390
|
+
* @default Create a short substantive title for the document of no more than 10 words. E.g. "Email from X to Y re ABC", "Service Agreement between A and B".
|
|
3391
|
+
*/
|
|
3392
|
+
AUTO_RENAME_INSTRUCTION: string;
|
|
3189
3393
|
/**
|
|
3190
3394
|
* Default Metadata Tags
|
|
3191
|
-
* @description Metadata templates used for automatic document metadata extraction during indexing.
|
|
3192
|
-
|
|
3193
|
-
|
|
3194
|
-
|
|
3195
|
-
|
|
3196
|
-
|
|
3197
|
-
|
|
3198
|
-
*
|
|
3199
|
-
*
|
|
3200
|
-
*
|
|
3201
|
-
|
|
3202
|
-
|
|
3203
|
-
|
|
3204
|
-
*
|
|
3205
|
-
*
|
|
3206
|
-
*
|
|
3207
|
-
|
|
3208
|
-
|
|
3209
|
-
|
|
3210
|
-
*
|
|
3211
|
-
*
|
|
3212
|
-
* "Financial",
|
|
3213
|
-
* "Form",
|
|
3214
|
-
* "Index",
|
|
3215
|
-
* "Submission",
|
|
3216
|
-
* "Other"
|
|
3217
|
-
* ],
|
|
3218
|
-
* "type": "select"
|
|
3219
|
-
* }
|
|
3220
|
-
* },
|
|
3221
|
-
* {
|
|
3222
|
-
* "name": "doc_author",
|
|
3223
|
-
* "instruction": "Who is the author or creator of this document? If there are multiple authors, list up to 3 followed by 'et al.' if more exist.",
|
|
3224
|
-
* "tag_type": {
|
|
3225
|
-
* "options": [],
|
|
3226
|
-
* "type": "text"
|
|
3227
|
-
* }
|
|
3228
|
-
* },
|
|
3229
|
-
* {
|
|
3230
|
-
* "name": "doc_subject",
|
|
3231
|
-
* "instruction": "What is the main subject or purpose of this document? Provide a brief 1-2 sentence description.",
|
|
3232
|
-
* "tag_type": {
|
|
3233
|
-
* "options": [],
|
|
3234
|
-
* "type": "text"
|
|
3235
|
-
* }
|
|
3236
|
-
* }
|
|
3237
|
-
* ]
|
|
3395
|
+
* @description Metadata templates used for automatic document metadata extraction during indexing. Built-in tags cannot be removed; additional tags may be appended.
|
|
3396
|
+
*/
|
|
3397
|
+
DEFAULT_METADATA_TAGS?: components['schemas']['TagTemplate'][];
|
|
3398
|
+
};
|
|
3399
|
+
/** DoctagLLMUserConfig */
|
|
3400
|
+
DoctagLLMUserConfig: {
|
|
3401
|
+
/**
|
|
3402
|
+
* Auto Rename
|
|
3403
|
+
* @description Generate a descriptive document title via LLM instead of using the filename. The generated title replaces the filename-derived title in doc_metadata.
|
|
3404
|
+
* @default false
|
|
3405
|
+
*/
|
|
3406
|
+
AUTO_RENAME: boolean;
|
|
3407
|
+
/**
|
|
3408
|
+
* Auto Rename Instruction
|
|
3409
|
+
* @description Instruction for generating document titles when AUTO_RENAME is enabled.
|
|
3410
|
+
* @default Create a short substantive title for the document of no more than 10 words. E.g. "Email from X to Y re ABC", "Service Agreement between A and B".
|
|
3411
|
+
*/
|
|
3412
|
+
AUTO_RENAME_INSTRUCTION: string;
|
|
3413
|
+
/**
|
|
3414
|
+
* Default Metadata Tags
|
|
3415
|
+
* @description Metadata templates used for automatic document metadata extraction during indexing. Built-in tags cannot be removed; additional tags may be appended.
|
|
3238
3416
|
*/
|
|
3239
|
-
DEFAULT_METADATA_TAGS
|
|
3417
|
+
DEFAULT_METADATA_TAGS?: components['schemas']['TagTemplate'][];
|
|
3240
3418
|
};
|
|
3241
3419
|
/** EmbedderConfig */
|
|
3242
3420
|
EmbedderConfig: {
|
|
@@ -4004,6 +4182,49 @@ interface components {
|
|
|
4004
4182
|
[key: string]: components['schemas']['CitationData'];
|
|
4005
4183
|
};
|
|
4006
4184
|
};
|
|
4185
|
+
/**
|
|
4186
|
+
* ModelGroupUsage
|
|
4187
|
+
* @description Usage metrics for a model group (e.g. Fast, Wise, Premium) with per-model detail.
|
|
4188
|
+
*/
|
|
4189
|
+
ModelGroupUsage: {
|
|
4190
|
+
/**
|
|
4191
|
+
* Spend
|
|
4192
|
+
* @default 0
|
|
4193
|
+
*/
|
|
4194
|
+
spend: number;
|
|
4195
|
+
/**
|
|
4196
|
+
* Prompt Tokens
|
|
4197
|
+
* @default 0
|
|
4198
|
+
*/
|
|
4199
|
+
prompt_tokens: number;
|
|
4200
|
+
/**
|
|
4201
|
+
* Completion Tokens
|
|
4202
|
+
* @default 0
|
|
4203
|
+
*/
|
|
4204
|
+
completion_tokens: number;
|
|
4205
|
+
/**
|
|
4206
|
+
* Total Tokens
|
|
4207
|
+
* @default 0
|
|
4208
|
+
*/
|
|
4209
|
+
total_tokens: number;
|
|
4210
|
+
/**
|
|
4211
|
+
* Successful Requests
|
|
4212
|
+
* @default 0
|
|
4213
|
+
*/
|
|
4214
|
+
successful_requests: number;
|
|
4215
|
+
/**
|
|
4216
|
+
* Failed Requests
|
|
4217
|
+
* @default 0
|
|
4218
|
+
*/
|
|
4219
|
+
failed_requests: number;
|
|
4220
|
+
/**
|
|
4221
|
+
* Models
|
|
4222
|
+
* @default {}
|
|
4223
|
+
*/
|
|
4224
|
+
models: {
|
|
4225
|
+
[key: string]: components['schemas']['ModelUsage'];
|
|
4226
|
+
};
|
|
4227
|
+
};
|
|
4007
4228
|
/** ModelInfo */
|
|
4008
4229
|
ModelInfo: {
|
|
4009
4230
|
/** Model Name */
|
|
@@ -4042,9 +4263,45 @@ interface components {
|
|
|
4042
4263
|
/** Detail */
|
|
4043
4264
|
detail?: string | null;
|
|
4044
4265
|
};
|
|
4045
|
-
/**
|
|
4046
|
-
|
|
4047
|
-
|
|
4266
|
+
/**
|
|
4267
|
+
* ModelUsage
|
|
4268
|
+
* @description Usage metrics for a single model.
|
|
4269
|
+
*/
|
|
4270
|
+
ModelUsage: {
|
|
4271
|
+
/**
|
|
4272
|
+
* Spend
|
|
4273
|
+
* @default 0
|
|
4274
|
+
*/
|
|
4275
|
+
spend: number;
|
|
4276
|
+
/**
|
|
4277
|
+
* Prompt Tokens
|
|
4278
|
+
* @default 0
|
|
4279
|
+
*/
|
|
4280
|
+
prompt_tokens: number;
|
|
4281
|
+
/**
|
|
4282
|
+
* Completion Tokens
|
|
4283
|
+
* @default 0
|
|
4284
|
+
*/
|
|
4285
|
+
completion_tokens: number;
|
|
4286
|
+
/**
|
|
4287
|
+
* Total Tokens
|
|
4288
|
+
* @default 0
|
|
4289
|
+
*/
|
|
4290
|
+
total_tokens: number;
|
|
4291
|
+
/**
|
|
4292
|
+
* Successful Requests
|
|
4293
|
+
* @default 0
|
|
4294
|
+
*/
|
|
4295
|
+
successful_requests: number;
|
|
4296
|
+
/**
|
|
4297
|
+
* Failed Requests
|
|
4298
|
+
* @default 0
|
|
4299
|
+
*/
|
|
4300
|
+
failed_requests: number;
|
|
4301
|
+
};
|
|
4302
|
+
/** ModelsHealthStatus */
|
|
4303
|
+
ModelsHealthStatus: {
|
|
4304
|
+
/** Application */
|
|
4048
4305
|
application: string;
|
|
4049
4306
|
/** Models */
|
|
4050
4307
|
models: components['schemas']['ModelStatus'][];
|
|
@@ -4054,15 +4311,11 @@ interface components {
|
|
|
4054
4311
|
/** Models */
|
|
4055
4312
|
models: components['schemas']['ModelInfo'][];
|
|
4056
4313
|
};
|
|
4057
|
-
/**
|
|
4058
|
-
* NonDeveloperConfig
|
|
4059
|
-
* @description Limited configuration response for non-developer users
|
|
4060
|
-
*/
|
|
4314
|
+
/** NonDeveloperConfig */
|
|
4061
4315
|
NonDeveloperConfig: {
|
|
4062
|
-
|
|
4063
|
-
|
|
4064
|
-
|
|
4065
|
-
};
|
|
4316
|
+
Agents: components['schemas']['AgentsUserConfig'];
|
|
4317
|
+
DoctagLLM: components['schemas']['DoctagLLMUserConfig'];
|
|
4318
|
+
Parser: components['schemas']['ParserUserConfig'];
|
|
4066
4319
|
};
|
|
4067
4320
|
/**
|
|
4068
4321
|
* NotificationResponse
|
|
@@ -4238,6 +4491,15 @@ interface components {
|
|
|
4238
4491
|
*/
|
|
4239
4492
|
SKIP_DUPLICATES: boolean;
|
|
4240
4493
|
};
|
|
4494
|
+
/** ParserUserConfig */
|
|
4495
|
+
ParserUserConfig: {
|
|
4496
|
+
/**
|
|
4497
|
+
* Skip Duplicates
|
|
4498
|
+
* @description Skip files with identical content already in the workspace.
|
|
4499
|
+
* @default false
|
|
4500
|
+
*/
|
|
4501
|
+
SKIP_DUPLICATES: boolean;
|
|
4502
|
+
};
|
|
4241
4503
|
/**
|
|
4242
4504
|
* PersonalAgentDetail
|
|
4243
4505
|
* @description Detail for a personal_agent tool call.
|
|
@@ -4377,6 +4639,16 @@ interface components {
|
|
|
4377
4639
|
/** Timestamp */
|
|
4378
4640
|
timestamp: string;
|
|
4379
4641
|
};
|
|
4642
|
+
/**
|
|
4643
|
+
* PriceTier
|
|
4644
|
+
* @description Stripe volume pricing tier.
|
|
4645
|
+
*/
|
|
4646
|
+
PriceTier: {
|
|
4647
|
+
/** Up To */
|
|
4648
|
+
up_to?: number | null;
|
|
4649
|
+
/** Unit Amount */
|
|
4650
|
+
unit_amount: number;
|
|
4651
|
+
};
|
|
4380
4652
|
/**
|
|
4381
4653
|
* ProductPrice
|
|
4382
4654
|
* @description Stripe product price information.
|
|
@@ -4385,7 +4657,7 @@ interface components {
|
|
|
4385
4657
|
/** Price Id */
|
|
4386
4658
|
price_id: string;
|
|
4387
4659
|
/** Amount */
|
|
4388
|
-
amount
|
|
4660
|
+
amount?: number | null;
|
|
4389
4661
|
/** Currency */
|
|
4390
4662
|
currency: string;
|
|
4391
4663
|
/** Interval */
|
|
@@ -4394,6 +4666,13 @@ interface components {
|
|
|
4394
4666
|
interval_count: number;
|
|
4395
4667
|
/** Default Price */
|
|
4396
4668
|
default_price: boolean;
|
|
4669
|
+
/**
|
|
4670
|
+
* Billing Scheme
|
|
4671
|
+
* @default per_unit
|
|
4672
|
+
*/
|
|
4673
|
+
billing_scheme: string;
|
|
4674
|
+
/** Tiers */
|
|
4675
|
+
tiers?: components['schemas']['PriceTier'][] | null;
|
|
4397
4676
|
};
|
|
4398
4677
|
/**
|
|
4399
4678
|
* ProductResponse
|
|
@@ -4409,6 +4688,200 @@ interface components {
|
|
|
4409
4688
|
/** Prices */
|
|
4410
4689
|
prices: components['schemas']['ProductPrice'][];
|
|
4411
4690
|
};
|
|
4691
|
+
/**
|
|
4692
|
+
* ProjectCheckoutRequest
|
|
4693
|
+
* @description Create a Stripe checkout session for this project.
|
|
4694
|
+
*/
|
|
4695
|
+
ProjectCheckoutRequest: {
|
|
4696
|
+
/** Price Id */
|
|
4697
|
+
price_id: string;
|
|
4698
|
+
/**
|
|
4699
|
+
* Quantity
|
|
4700
|
+
* @description Number of Pro Packs
|
|
4701
|
+
* @default 1
|
|
4702
|
+
*/
|
|
4703
|
+
quantity: number;
|
|
4704
|
+
/**
|
|
4705
|
+
* Promo Code
|
|
4706
|
+
* @description Promo code to auto-apply
|
|
4707
|
+
*/
|
|
4708
|
+
promo_code?: string | null;
|
|
4709
|
+
};
|
|
4710
|
+
/**
|
|
4711
|
+
* ProjectCheckoutResponse
|
|
4712
|
+
* @description Stripe checkout session client secret.
|
|
4713
|
+
*/
|
|
4714
|
+
ProjectCheckoutResponse: {
|
|
4715
|
+
/** Client Secret */
|
|
4716
|
+
client_secret: string;
|
|
4717
|
+
};
|
|
4718
|
+
/**
|
|
4719
|
+
* ProjectCreateRequest
|
|
4720
|
+
* @description Create a new project.
|
|
4721
|
+
*/
|
|
4722
|
+
ProjectCreateRequest: {
|
|
4723
|
+
/** Name */
|
|
4724
|
+
name: string;
|
|
4725
|
+
};
|
|
4726
|
+
/**
|
|
4727
|
+
* ProjectInvoice
|
|
4728
|
+
* @description Single Stripe invoice/receipt for a project.
|
|
4729
|
+
*/
|
|
4730
|
+
ProjectInvoice: {
|
|
4731
|
+
/** Date */
|
|
4732
|
+
date: string;
|
|
4733
|
+
/** Amount */
|
|
4734
|
+
amount: number;
|
|
4735
|
+
/** Currency */
|
|
4736
|
+
currency: string;
|
|
4737
|
+
/** Status */
|
|
4738
|
+
status: string;
|
|
4739
|
+
/** Url */
|
|
4740
|
+
url?: string | null;
|
|
4741
|
+
/** Pdf Url */
|
|
4742
|
+
pdf_url?: string | null;
|
|
4743
|
+
};
|
|
4744
|
+
/**
|
|
4745
|
+
* ProjectInvoicesResponse
|
|
4746
|
+
* @description Invoices for a project subscription.
|
|
4747
|
+
*/
|
|
4748
|
+
ProjectInvoicesResponse: {
|
|
4749
|
+
/** Project Ext Id */
|
|
4750
|
+
project_ext_id: string;
|
|
4751
|
+
/**
|
|
4752
|
+
* Invoices
|
|
4753
|
+
* @default []
|
|
4754
|
+
*/
|
|
4755
|
+
invoices: components['schemas']['ProjectInvoice'][];
|
|
4756
|
+
};
|
|
4757
|
+
/**
|
|
4758
|
+
* ProjectQuotas
|
|
4759
|
+
* @description All quota metrics for a project, derived from packs.
|
|
4760
|
+
*/
|
|
4761
|
+
ProjectQuotas: {
|
|
4762
|
+
storage_gb: components['schemas']['QuotaUsage'];
|
|
4763
|
+
ai_credits: components['schemas']['QuotaUsage'];
|
|
4764
|
+
collaborators: components['schemas']['QuotaUsage'];
|
|
4765
|
+
};
|
|
4766
|
+
/**
|
|
4767
|
+
* ProjectResponse
|
|
4768
|
+
* @description Project summary returned in list and detail views.
|
|
4769
|
+
*/
|
|
4770
|
+
ProjectResponse: {
|
|
4771
|
+
/** External Id */
|
|
4772
|
+
external_id: string;
|
|
4773
|
+
/** Name */
|
|
4774
|
+
name: string;
|
|
4775
|
+
/** Packs */
|
|
4776
|
+
packs: number;
|
|
4777
|
+
/** Subscription */
|
|
4778
|
+
subscription: string;
|
|
4779
|
+
/**
|
|
4780
|
+
* Created At
|
|
4781
|
+
* Format: date-time
|
|
4782
|
+
*/
|
|
4783
|
+
created_at: string;
|
|
4784
|
+
quotas: components['schemas']['ProjectQuotas'];
|
|
4785
|
+
/** Price Id */
|
|
4786
|
+
price_id?: string | null;
|
|
4787
|
+
/** Plan */
|
|
4788
|
+
plan?: string | null;
|
|
4789
|
+
/** Amount */
|
|
4790
|
+
amount?: number | null;
|
|
4791
|
+
/** Currency */
|
|
4792
|
+
currency?: string | null;
|
|
4793
|
+
/** Current Period End */
|
|
4794
|
+
current_period_end?: number | null;
|
|
4795
|
+
/** Cancel At Period End */
|
|
4796
|
+
cancel_at_period_end?: boolean | null;
|
|
4797
|
+
/** Portal Url */
|
|
4798
|
+
portal_url?: string | null;
|
|
4799
|
+
};
|
|
4800
|
+
/**
|
|
4801
|
+
* ProjectUpdateRequest
|
|
4802
|
+
* @description Update project name.
|
|
4803
|
+
*/
|
|
4804
|
+
ProjectUpdateRequest: {
|
|
4805
|
+
/** Name */
|
|
4806
|
+
name?: string | null;
|
|
4807
|
+
};
|
|
4808
|
+
/**
|
|
4809
|
+
* ProjectUpgradeRequest
|
|
4810
|
+
* @description Change pack quantity on an existing project.
|
|
4811
|
+
*/
|
|
4812
|
+
ProjectUpgradeRequest: {
|
|
4813
|
+
/** Price Id */
|
|
4814
|
+
price_id: string;
|
|
4815
|
+
/** Quantity */
|
|
4816
|
+
quantity: number;
|
|
4817
|
+
/**
|
|
4818
|
+
* Proration Behavior
|
|
4819
|
+
* @default create_prorations
|
|
4820
|
+
*/
|
|
4821
|
+
proration_behavior: string;
|
|
4822
|
+
};
|
|
4823
|
+
/**
|
|
4824
|
+
* ProjectUsageResponse
|
|
4825
|
+
* @description Usage breakdown for a project's billing period.
|
|
4826
|
+
*/
|
|
4827
|
+
ProjectUsageResponse: {
|
|
4828
|
+
/** Project Ext Id */
|
|
4829
|
+
project_ext_id: string;
|
|
4830
|
+
/** Period Start */
|
|
4831
|
+
period_start: string;
|
|
4832
|
+
/** Period End */
|
|
4833
|
+
period_end: string;
|
|
4834
|
+
/**
|
|
4835
|
+
* Total Spend
|
|
4836
|
+
* @default 0
|
|
4837
|
+
*/
|
|
4838
|
+
total_spend: number;
|
|
4839
|
+
/**
|
|
4840
|
+
* Total Tokens
|
|
4841
|
+
* @default 0
|
|
4842
|
+
*/
|
|
4843
|
+
total_tokens: number;
|
|
4844
|
+
/**
|
|
4845
|
+
* Total Requests
|
|
4846
|
+
* @default 0
|
|
4847
|
+
*/
|
|
4848
|
+
total_requests: number;
|
|
4849
|
+
/**
|
|
4850
|
+
* Daily
|
|
4851
|
+
* @default []
|
|
4852
|
+
*/
|
|
4853
|
+
daily: components['schemas']['DailyUsage'][];
|
|
4854
|
+
/**
|
|
4855
|
+
* Model Groups
|
|
4856
|
+
* @default {}
|
|
4857
|
+
*/
|
|
4858
|
+
model_groups: {
|
|
4859
|
+
[key: string]: components['schemas']['ModelGroupUsage'];
|
|
4860
|
+
};
|
|
4861
|
+
/**
|
|
4862
|
+
* By Workspace
|
|
4863
|
+
* @default {}
|
|
4864
|
+
*/
|
|
4865
|
+
by_workspace: {
|
|
4866
|
+
[key: string]: components['schemas']['TagBreakdown'];
|
|
4867
|
+
};
|
|
4868
|
+
/**
|
|
4869
|
+
* By User
|
|
4870
|
+
* @default {}
|
|
4871
|
+
*/
|
|
4872
|
+
by_user: {
|
|
4873
|
+
[key: string]: components['schemas']['TagBreakdown'];
|
|
4874
|
+
};
|
|
4875
|
+
/**
|
|
4876
|
+
* By Feature
|
|
4877
|
+
* @default {}
|
|
4878
|
+
*/
|
|
4879
|
+
by_feature: {
|
|
4880
|
+
[key: string]: components['schemas']['TagBreakdown'];
|
|
4881
|
+
};
|
|
4882
|
+
/** Invoice Pdf */
|
|
4883
|
+
invoice_pdf?: string | null;
|
|
4884
|
+
};
|
|
4412
4885
|
/** QueryLLMConfig */
|
|
4413
4886
|
QueryLLMConfig: {
|
|
4414
4887
|
/**
|
|
@@ -4455,6 +4928,16 @@ interface components {
|
|
|
4455
4928
|
*/
|
|
4456
4929
|
MAX_TOKENS: number;
|
|
4457
4930
|
};
|
|
4931
|
+
/**
|
|
4932
|
+
* QuotaUsage
|
|
4933
|
+
* @description Single quota metric: current usage vs limit.
|
|
4934
|
+
*/
|
|
4935
|
+
QuotaUsage: {
|
|
4936
|
+
/** Used */
|
|
4937
|
+
used: number;
|
|
4938
|
+
/** Limit */
|
|
4939
|
+
limit: number;
|
|
4940
|
+
};
|
|
4458
4941
|
/**
|
|
4459
4942
|
* ReadDocumentDetail
|
|
4460
4943
|
* @description Detail for a read_document tool call.
|
|
@@ -5631,6 +6114,16 @@ interface components {
|
|
|
5631
6114
|
*/
|
|
5632
6115
|
detail: string;
|
|
5633
6116
|
};
|
|
6117
|
+
/**
|
|
6118
|
+
* SkippedFile
|
|
6119
|
+
* @description A file that was skipped during upload with the reason.
|
|
6120
|
+
*/
|
|
6121
|
+
SkippedFile: {
|
|
6122
|
+
/** File Name */
|
|
6123
|
+
file_name: string;
|
|
6124
|
+
/** Reason */
|
|
6125
|
+
reason: string;
|
|
6126
|
+
};
|
|
5634
6127
|
/**
|
|
5635
6128
|
* StepUsage
|
|
5636
6129
|
* @description Per-step token usage from a single LLM call.
|
|
@@ -5684,54 +6177,9 @@ interface components {
|
|
|
5684
6177
|
SubscriptionInfo: {
|
|
5685
6178
|
/**
|
|
5686
6179
|
* Status
|
|
5687
|
-
* @default
|
|
6180
|
+
* @default active
|
|
5688
6181
|
*/
|
|
5689
6182
|
status: string;
|
|
5690
|
-
/** Trial Expires */
|
|
5691
|
-
trial_expires?: number | null;
|
|
5692
|
-
};
|
|
5693
|
-
/**
|
|
5694
|
-
* SubscriptionStatusResponse
|
|
5695
|
-
* @description Subscription status response - unified model for all subscription states.
|
|
5696
|
-
*
|
|
5697
|
-
* Status is one of the tier names configured in STRIPE_TIERS, plus system tiers:
|
|
5698
|
-
* - Paid tiers (e.g., "pro", "pro_plus"): Active Stripe subscription
|
|
5699
|
-
* - "trial": User is on trial (has trial_expires, days_remaining)
|
|
5700
|
-
* - "dev": Developer access
|
|
5701
|
-
* - "restricted": No access (trial expired or no subscription)
|
|
5702
|
-
* - "inactive": Expired/canceled/unpaid Stripe subscription
|
|
5703
|
-
*/
|
|
5704
|
-
SubscriptionStatusResponse: {
|
|
5705
|
-
/** Status */
|
|
5706
|
-
status: string;
|
|
5707
|
-
/** Trial Expires */
|
|
5708
|
-
trial_expires?: number | null;
|
|
5709
|
-
/** Days Remaining */
|
|
5710
|
-
days_remaining?: number | null;
|
|
5711
|
-
/** Price Id */
|
|
5712
|
-
price_id?: string | null;
|
|
5713
|
-
/** Plan */
|
|
5714
|
-
plan?: string | null;
|
|
5715
|
-
/** Amount */
|
|
5716
|
-
amount?: number | null;
|
|
5717
|
-
/** Currency */
|
|
5718
|
-
currency?: string | null;
|
|
5719
|
-
/** Current Period End */
|
|
5720
|
-
current_period_end?: number | null;
|
|
5721
|
-
/** Cancel At Period End */
|
|
5722
|
-
cancel_at_period_end?: boolean | null;
|
|
5723
|
-
/** Portal Url */
|
|
5724
|
-
portal_url?: string | null;
|
|
5725
|
-
/** Spend */
|
|
5726
|
-
spend?: number | null;
|
|
5727
|
-
/** Max Budget */
|
|
5728
|
-
max_budget?: number | null;
|
|
5729
|
-
/** Budget Reset At */
|
|
5730
|
-
budget_reset_at?: number | null;
|
|
5731
|
-
/** Total Files Mb */
|
|
5732
|
-
total_files_mb?: number | null;
|
|
5733
|
-
/** Storage Quota Mb */
|
|
5734
|
-
storage_quota_mb?: number | null;
|
|
5735
6183
|
};
|
|
5736
6184
|
/**
|
|
5737
6185
|
* SummariseLLMConfig
|
|
@@ -5816,6 +6264,27 @@ interface components {
|
|
|
5816
6264
|
/** Columns */
|
|
5817
6265
|
columns: string[];
|
|
5818
6266
|
};
|
|
6267
|
+
/**
|
|
6268
|
+
* TagBreakdown
|
|
6269
|
+
* @description Spend/token breakdown keyed by tag value (e.g. wrk-xxx, usr-xxx).
|
|
6270
|
+
*/
|
|
6271
|
+
TagBreakdown: {
|
|
6272
|
+
/**
|
|
6273
|
+
* Spend
|
|
6274
|
+
* @default 0
|
|
6275
|
+
*/
|
|
6276
|
+
spend: number;
|
|
6277
|
+
/**
|
|
6278
|
+
* Total Tokens
|
|
6279
|
+
* @default 0
|
|
6280
|
+
*/
|
|
6281
|
+
total_tokens: number;
|
|
6282
|
+
/**
|
|
6283
|
+
* Requests
|
|
6284
|
+
* @default 0
|
|
6285
|
+
*/
|
|
6286
|
+
requests: number;
|
|
6287
|
+
};
|
|
5819
6288
|
/**
|
|
5820
6289
|
* TagFormat
|
|
5821
6290
|
* @description Tag format configuration stored as JSONB.
|
|
@@ -5902,7 +6371,7 @@ interface components {
|
|
|
5902
6371
|
* Status
|
|
5903
6372
|
* @enum {string}
|
|
5904
6373
|
*/
|
|
5905
|
-
status: 'queued' | 'parsing' | 'encrypting' | 'indexing' | 'analysing' | 'completed' | 'failed' | 'skipped';
|
|
6374
|
+
status: 'queued' | 'parsing' | 'encrypting' | 'indexing' | 'analysing' | 'completed' | 'failed' | 'skipped' | 'empty';
|
|
5906
6375
|
/** Progress */
|
|
5907
6376
|
progress: number;
|
|
5908
6377
|
};
|
|
@@ -6123,14 +6592,6 @@ interface components {
|
|
|
6123
6592
|
[key: string]: unknown;
|
|
6124
6593
|
}[];
|
|
6125
6594
|
};
|
|
6126
|
-
/**
|
|
6127
|
-
* TrialUpdate
|
|
6128
|
-
* @description Trial update - only trial_expires can be set, and only if currently null.
|
|
6129
|
-
*/
|
|
6130
|
-
TrialUpdate: {
|
|
6131
|
-
/** Trial Expires */
|
|
6132
|
-
trial_expires?: number | null;
|
|
6133
|
-
};
|
|
6134
6595
|
/**
|
|
6135
6596
|
* UpdateDocTagRequest
|
|
6136
6597
|
* @description Update a doctag's note or citations. Identified by (tag_ext_id, doc_ext_id) pair.
|
|
@@ -6191,17 +6652,22 @@ interface components {
|
|
|
6191
6652
|
* UploadDocumentsResponse
|
|
6192
6653
|
* @description Response for document upload operations.
|
|
6193
6654
|
*
|
|
6194
|
-
* Returns array of document IDs
|
|
6195
|
-
*
|
|
6655
|
+
* Returns array of document IDs for successfully uploaded files.
|
|
6656
|
+
* Files that fail validation are skipped and listed with reasons.
|
|
6196
6657
|
*/
|
|
6197
6658
|
UploadDocumentsResponse: {
|
|
6198
6659
|
/** Doc Ext Ids */
|
|
6199
|
-
doc_ext_ids
|
|
6660
|
+
doc_ext_ids?: string[];
|
|
6661
|
+
/**
|
|
6662
|
+
* Batch Id
|
|
6663
|
+
* @description Batch ID for tracking completion via WebSocket batch_complete events
|
|
6664
|
+
*/
|
|
6665
|
+
batch_id?: string | null;
|
|
6200
6666
|
/**
|
|
6201
|
-
*
|
|
6202
|
-
* @description
|
|
6667
|
+
* Skipped
|
|
6668
|
+
* @description Files that were skipped during upload with reasons
|
|
6203
6669
|
*/
|
|
6204
|
-
|
|
6670
|
+
skipped?: components['schemas']['SkippedFile'][];
|
|
6205
6671
|
};
|
|
6206
6672
|
/**
|
|
6207
6673
|
* UserInputBody
|
|
@@ -6340,6 +6806,8 @@ interface components {
|
|
|
6340
6806
|
subscription?: components['schemas']['SubscriptionInfo'] | null;
|
|
6341
6807
|
/** Last Workspace */
|
|
6342
6808
|
last_workspace?: string | null;
|
|
6809
|
+
/** Last Config */
|
|
6810
|
+
last_config?: string | null;
|
|
6343
6811
|
/**
|
|
6344
6812
|
* Pinned Workspaces
|
|
6345
6813
|
* @default []
|
|
@@ -6370,11 +6838,6 @@ interface components {
|
|
|
6370
6838
|
* @default false
|
|
6371
6839
|
*/
|
|
6372
6840
|
show_thread_visualization: boolean;
|
|
6373
|
-
/**
|
|
6374
|
-
* Show Smart Search
|
|
6375
|
-
* @default false
|
|
6376
|
-
*/
|
|
6377
|
-
show_smart_search: boolean;
|
|
6378
6841
|
/**
|
|
6379
6842
|
* Show Security Settings
|
|
6380
6843
|
* @default false
|
|
@@ -6425,12 +6888,8 @@ interface components {
|
|
|
6425
6888
|
/**
|
|
6426
6889
|
* UserSettingsUpdate
|
|
6427
6890
|
* @description User settings update request - allows partial updates.
|
|
6428
|
-
*
|
|
6429
|
-
* Note: stripe_customer_id and status are not patchable.
|
|
6430
|
-
* trial_expires can only be set once (to start trial).
|
|
6431
6891
|
*/
|
|
6432
6892
|
UserSettingsUpdate: {
|
|
6433
|
-
subscription?: components['schemas']['TrialUpdate'] | null;
|
|
6434
6893
|
/** Pinned Workspaces */
|
|
6435
6894
|
pinned_workspaces?: string[] | null;
|
|
6436
6895
|
/** Pinned Templates */
|
|
@@ -6441,8 +6900,6 @@ interface components {
|
|
|
6441
6900
|
show_document_navigator?: boolean | null;
|
|
6442
6901
|
/** Show Thread Visualization */
|
|
6443
6902
|
show_thread_visualization?: boolean | null;
|
|
6444
|
-
/** Show Smart Search */
|
|
6445
|
-
show_smart_search?: boolean | null;
|
|
6446
6903
|
/** Show Security Settings */
|
|
6447
6904
|
show_security_settings?: boolean | null;
|
|
6448
6905
|
/** Show Invite Tab */
|
|
@@ -6638,6 +7095,8 @@ interface components {
|
|
|
6638
7095
|
is_public: boolean;
|
|
6639
7096
|
/** Workspace Key */
|
|
6640
7097
|
workspace_key: string;
|
|
7098
|
+
/** Project Ext Id */
|
|
7099
|
+
project_ext_id: string;
|
|
6641
7100
|
};
|
|
6642
7101
|
/**
|
|
6643
7102
|
* WorkspaceOpenRequest
|
|
@@ -6719,6 +7178,14 @@ interface components {
|
|
|
6719
7178
|
* @default []
|
|
6720
7179
|
*/
|
|
6721
7180
|
users: components['schemas']['WorkspaceUserResponse'][];
|
|
7181
|
+
/** Project Ext Id */
|
|
7182
|
+
project_ext_id?: string | null;
|
|
7183
|
+
/** Project Name */
|
|
7184
|
+
project_name?: string | null;
|
|
7185
|
+
/** Project Subscription */
|
|
7186
|
+
project_subscription?: string | null;
|
|
7187
|
+
/** Project Owner Ext Id */
|
|
7188
|
+
project_owner_ext_id?: string | null;
|
|
6722
7189
|
};
|
|
6723
7190
|
/**
|
|
6724
7191
|
* WorkspaceRole
|
|
@@ -6734,6 +7201,8 @@ interface components {
|
|
|
6734
7201
|
description?: string | null;
|
|
6735
7202
|
/** Is Public */
|
|
6736
7203
|
is_public?: boolean | null;
|
|
7204
|
+
/** Project Ext Id */
|
|
7205
|
+
project_ext_id?: string | null;
|
|
6737
7206
|
};
|
|
6738
7207
|
/**
|
|
6739
7208
|
* WorkspaceUserResponse
|
|
@@ -6777,7 +7246,27 @@ interface components {
|
|
|
6777
7246
|
}
|
|
6778
7247
|
type $defs = Record<string, never>;
|
|
6779
7248
|
interface operations {
|
|
6780
|
-
|
|
7249
|
+
list_projects: {
|
|
7250
|
+
parameters: {
|
|
7251
|
+
query?: never;
|
|
7252
|
+
header?: never;
|
|
7253
|
+
path?: never;
|
|
7254
|
+
cookie?: never;
|
|
7255
|
+
};
|
|
7256
|
+
requestBody?: never;
|
|
7257
|
+
responses: {
|
|
7258
|
+
/** @description Successful Response */
|
|
7259
|
+
200: {
|
|
7260
|
+
headers: {
|
|
7261
|
+
[name: string]: unknown;
|
|
7262
|
+
};
|
|
7263
|
+
content: {
|
|
7264
|
+
'application/json': components['schemas']['ProjectResponse'][];
|
|
7265
|
+
};
|
|
7266
|
+
};
|
|
7267
|
+
};
|
|
7268
|
+
};
|
|
7269
|
+
create_project: {
|
|
6781
7270
|
parameters: {
|
|
6782
7271
|
query?: never;
|
|
6783
7272
|
header?: never;
|
|
@@ -6786,17 +7275,17 @@ interface operations {
|
|
|
6786
7275
|
};
|
|
6787
7276
|
requestBody: {
|
|
6788
7277
|
content: {
|
|
6789
|
-
'application/json': components['schemas']['
|
|
7278
|
+
'application/json': components['schemas']['ProjectCreateRequest'];
|
|
6790
7279
|
};
|
|
6791
7280
|
};
|
|
6792
7281
|
responses: {
|
|
6793
7282
|
/** @description Successful Response */
|
|
6794
|
-
|
|
7283
|
+
201: {
|
|
6795
7284
|
headers: {
|
|
6796
7285
|
[name: string]: unknown;
|
|
6797
7286
|
};
|
|
6798
7287
|
content: {
|
|
6799
|
-
'application/json': components['schemas']['
|
|
7288
|
+
'application/json': components['schemas']['ProjectResponse'];
|
|
6800
7289
|
};
|
|
6801
7290
|
};
|
|
6802
7291
|
/** @description Validation Error */
|
|
@@ -6810,36 +7299,47 @@ interface operations {
|
|
|
6810
7299
|
};
|
|
6811
7300
|
};
|
|
6812
7301
|
};
|
|
6813
|
-
|
|
7302
|
+
delete_project: {
|
|
6814
7303
|
parameters: {
|
|
6815
7304
|
query?: never;
|
|
6816
7305
|
header?: never;
|
|
6817
|
-
path
|
|
7306
|
+
path: {
|
|
7307
|
+
project_ext_id: string;
|
|
7308
|
+
};
|
|
6818
7309
|
cookie?: never;
|
|
6819
7310
|
};
|
|
6820
7311
|
requestBody?: never;
|
|
6821
7312
|
responses: {
|
|
6822
7313
|
/** @description Successful Response */
|
|
6823
|
-
|
|
7314
|
+
204: {
|
|
7315
|
+
headers: {
|
|
7316
|
+
[name: string]: unknown;
|
|
7317
|
+
};
|
|
7318
|
+
content?: never;
|
|
7319
|
+
};
|
|
7320
|
+
/** @description Validation Error */
|
|
7321
|
+
422: {
|
|
6824
7322
|
headers: {
|
|
6825
7323
|
[name: string]: unknown;
|
|
6826
7324
|
};
|
|
6827
7325
|
content: {
|
|
6828
|
-
'application/json': components['schemas']['
|
|
7326
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
6829
7327
|
};
|
|
6830
7328
|
};
|
|
6831
7329
|
};
|
|
6832
7330
|
};
|
|
6833
|
-
|
|
7331
|
+
update_project: {
|
|
6834
7332
|
parameters: {
|
|
6835
7333
|
query?: never;
|
|
6836
7334
|
header?: never;
|
|
6837
|
-
path
|
|
7335
|
+
path: {
|
|
7336
|
+
project_ext_id: string;
|
|
7337
|
+
};
|
|
6838
7338
|
cookie?: never;
|
|
6839
7339
|
};
|
|
6840
7340
|
requestBody: {
|
|
6841
7341
|
content: {
|
|
6842
|
-
'application/json': components['schemas']['
|
|
7342
|
+
'application/json': components['schemas']['ProjectUpdateRequest'];
|
|
6843
7343
|
};
|
|
6844
7344
|
};
|
|
6845
7345
|
responses: {
|
|
@@ -6849,7 +7349,7 @@ interface operations {
|
|
|
6849
7349
|
[name: string]: unknown;
|
|
6850
7350
|
};
|
|
6851
7351
|
content: {
|
|
6852
|
-
'application/json': components['schemas']['
|
|
7352
|
+
'application/json': components['schemas']['ProjectResponse'];
|
|
6853
7353
|
};
|
|
6854
7354
|
};
|
|
6855
7355
|
/** @description Validation Error */
|
|
@@ -6863,11 +7363,298 @@ interface operations {
|
|
|
6863
7363
|
};
|
|
6864
7364
|
};
|
|
6865
7365
|
};
|
|
6866
|
-
|
|
7366
|
+
create_project_checkout: {
|
|
6867
7367
|
parameters: {
|
|
6868
7368
|
query?: never;
|
|
6869
|
-
header?:
|
|
6870
|
-
|
|
7369
|
+
header?: {
|
|
7370
|
+
origin?: string;
|
|
7371
|
+
referer?: string;
|
|
7372
|
+
'x-frontend-origin'?: string;
|
|
7373
|
+
};
|
|
7374
|
+
path: {
|
|
7375
|
+
project_ext_id: string;
|
|
7376
|
+
};
|
|
7377
|
+
cookie?: never;
|
|
7378
|
+
};
|
|
7379
|
+
requestBody: {
|
|
7380
|
+
content: {
|
|
7381
|
+
'application/json': components['schemas']['ProjectCheckoutRequest'];
|
|
7382
|
+
};
|
|
7383
|
+
};
|
|
7384
|
+
responses: {
|
|
7385
|
+
/** @description Successful Response */
|
|
7386
|
+
200: {
|
|
7387
|
+
headers: {
|
|
7388
|
+
[name: string]: unknown;
|
|
7389
|
+
};
|
|
7390
|
+
content: {
|
|
7391
|
+
'application/json': components['schemas']['ProjectCheckoutResponse'];
|
|
7392
|
+
};
|
|
7393
|
+
};
|
|
7394
|
+
/** @description Validation Error */
|
|
7395
|
+
422: {
|
|
7396
|
+
headers: {
|
|
7397
|
+
[name: string]: unknown;
|
|
7398
|
+
};
|
|
7399
|
+
content: {
|
|
7400
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
7401
|
+
};
|
|
7402
|
+
};
|
|
7403
|
+
};
|
|
7404
|
+
};
|
|
7405
|
+
change_project_plan: {
|
|
7406
|
+
parameters: {
|
|
7407
|
+
query?: never;
|
|
7408
|
+
header?: never;
|
|
7409
|
+
path: {
|
|
7410
|
+
project_ext_id: string;
|
|
7411
|
+
};
|
|
7412
|
+
cookie?: never;
|
|
7413
|
+
};
|
|
7414
|
+
requestBody: {
|
|
7415
|
+
content: {
|
|
7416
|
+
'application/json': components['schemas']['ProjectUpgradeRequest'];
|
|
7417
|
+
};
|
|
7418
|
+
};
|
|
7419
|
+
responses: {
|
|
7420
|
+
/** @description Successful Response */
|
|
7421
|
+
200: {
|
|
7422
|
+
headers: {
|
|
7423
|
+
[name: string]: unknown;
|
|
7424
|
+
};
|
|
7425
|
+
content: {
|
|
7426
|
+
'application/json': components['schemas']['ProjectResponse'];
|
|
7427
|
+
};
|
|
7428
|
+
};
|
|
7429
|
+
/** @description Validation Error */
|
|
7430
|
+
422: {
|
|
7431
|
+
headers: {
|
|
7432
|
+
[name: string]: unknown;
|
|
7433
|
+
};
|
|
7434
|
+
content: {
|
|
7435
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
7436
|
+
};
|
|
7437
|
+
};
|
|
7438
|
+
};
|
|
7439
|
+
};
|
|
7440
|
+
refresh_project: {
|
|
7441
|
+
parameters: {
|
|
7442
|
+
query?: never;
|
|
7443
|
+
header?: never;
|
|
7444
|
+
path: {
|
|
7445
|
+
project_ext_id: string;
|
|
7446
|
+
};
|
|
7447
|
+
cookie?: never;
|
|
7448
|
+
};
|
|
7449
|
+
requestBody?: never;
|
|
7450
|
+
responses: {
|
|
7451
|
+
/** @description Successful Response */
|
|
7452
|
+
200: {
|
|
7453
|
+
headers: {
|
|
7454
|
+
[name: string]: unknown;
|
|
7455
|
+
};
|
|
7456
|
+
content: {
|
|
7457
|
+
'application/json': components['schemas']['ProjectResponse'];
|
|
7458
|
+
};
|
|
7459
|
+
};
|
|
7460
|
+
/** @description Validation Error */
|
|
7461
|
+
422: {
|
|
7462
|
+
headers: {
|
|
7463
|
+
[name: string]: unknown;
|
|
7464
|
+
};
|
|
7465
|
+
content: {
|
|
7466
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
7467
|
+
};
|
|
7468
|
+
};
|
|
7469
|
+
};
|
|
7470
|
+
};
|
|
7471
|
+
get_project_usage: {
|
|
7472
|
+
parameters: {
|
|
7473
|
+
query?: {
|
|
7474
|
+
/** @description 0 = current billing period, 1 = previous month, etc. */
|
|
7475
|
+
months_back?: number;
|
|
7476
|
+
};
|
|
7477
|
+
header?: never;
|
|
7478
|
+
path: {
|
|
7479
|
+
project_ext_id: string;
|
|
7480
|
+
};
|
|
7481
|
+
cookie?: never;
|
|
7482
|
+
};
|
|
7483
|
+
requestBody?: never;
|
|
7484
|
+
responses: {
|
|
7485
|
+
/** @description Successful Response */
|
|
7486
|
+
200: {
|
|
7487
|
+
headers: {
|
|
7488
|
+
[name: string]: unknown;
|
|
7489
|
+
};
|
|
7490
|
+
content: {
|
|
7491
|
+
'application/json': components['schemas']['ProjectUsageResponse'];
|
|
7492
|
+
};
|
|
7493
|
+
};
|
|
7494
|
+
/** @description Validation Error */
|
|
7495
|
+
422: {
|
|
7496
|
+
headers: {
|
|
7497
|
+
[name: string]: unknown;
|
|
7498
|
+
};
|
|
7499
|
+
content: {
|
|
7500
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
7501
|
+
};
|
|
7502
|
+
};
|
|
7503
|
+
};
|
|
7504
|
+
};
|
|
7505
|
+
get_project_invoices: {
|
|
7506
|
+
parameters: {
|
|
7507
|
+
query?: never;
|
|
7508
|
+
header?: never;
|
|
7509
|
+
path: {
|
|
7510
|
+
project_ext_id: string;
|
|
7511
|
+
};
|
|
7512
|
+
cookie?: never;
|
|
7513
|
+
};
|
|
7514
|
+
requestBody?: never;
|
|
7515
|
+
responses: {
|
|
7516
|
+
/** @description Successful Response */
|
|
7517
|
+
200: {
|
|
7518
|
+
headers: {
|
|
7519
|
+
[name: string]: unknown;
|
|
7520
|
+
};
|
|
7521
|
+
content: {
|
|
7522
|
+
'application/json': components['schemas']['ProjectInvoicesResponse'];
|
|
7523
|
+
};
|
|
7524
|
+
};
|
|
7525
|
+
/** @description Validation Error */
|
|
7526
|
+
422: {
|
|
7527
|
+
headers: {
|
|
7528
|
+
[name: string]: unknown;
|
|
7529
|
+
};
|
|
7530
|
+
content: {
|
|
7531
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
7532
|
+
};
|
|
7533
|
+
};
|
|
7534
|
+
};
|
|
7535
|
+
};
|
|
7536
|
+
cancel_project_subscription: {
|
|
7537
|
+
parameters: {
|
|
7538
|
+
query?: never;
|
|
7539
|
+
header?: never;
|
|
7540
|
+
path: {
|
|
7541
|
+
project_ext_id: string;
|
|
7542
|
+
};
|
|
7543
|
+
cookie?: never;
|
|
7544
|
+
};
|
|
7545
|
+
requestBody?: never;
|
|
7546
|
+
responses: {
|
|
7547
|
+
/** @description Successful Response */
|
|
7548
|
+
200: {
|
|
7549
|
+
headers: {
|
|
7550
|
+
[name: string]: unknown;
|
|
7551
|
+
};
|
|
7552
|
+
content: {
|
|
7553
|
+
'application/json': components['schemas']['ProjectResponse'];
|
|
7554
|
+
};
|
|
7555
|
+
};
|
|
7556
|
+
/** @description Validation Error */
|
|
7557
|
+
422: {
|
|
7558
|
+
headers: {
|
|
7559
|
+
[name: string]: unknown;
|
|
7560
|
+
};
|
|
7561
|
+
content: {
|
|
7562
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
7563
|
+
};
|
|
7564
|
+
};
|
|
7565
|
+
};
|
|
7566
|
+
};
|
|
7567
|
+
verify_email: {
|
|
7568
|
+
parameters: {
|
|
7569
|
+
query?: never;
|
|
7570
|
+
header?: never;
|
|
7571
|
+
path?: never;
|
|
7572
|
+
cookie?: never;
|
|
7573
|
+
};
|
|
7574
|
+
requestBody: {
|
|
7575
|
+
content: {
|
|
7576
|
+
'application/json': components['schemas']['VerifyEmailRequest'];
|
|
7577
|
+
};
|
|
7578
|
+
};
|
|
7579
|
+
responses: {
|
|
7580
|
+
/** @description Successful Response */
|
|
7581
|
+
200: {
|
|
7582
|
+
headers: {
|
|
7583
|
+
[name: string]: unknown;
|
|
7584
|
+
};
|
|
7585
|
+
content: {
|
|
7586
|
+
'application/json': components['schemas']['VerifyEmailResponse'];
|
|
7587
|
+
};
|
|
7588
|
+
};
|
|
7589
|
+
/** @description Validation Error */
|
|
7590
|
+
422: {
|
|
7591
|
+
headers: {
|
|
7592
|
+
[name: string]: unknown;
|
|
7593
|
+
};
|
|
7594
|
+
content: {
|
|
7595
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
7596
|
+
};
|
|
7597
|
+
};
|
|
7598
|
+
};
|
|
7599
|
+
};
|
|
7600
|
+
get_user_contacts: {
|
|
7601
|
+
parameters: {
|
|
7602
|
+
query?: never;
|
|
7603
|
+
header?: never;
|
|
7604
|
+
path?: never;
|
|
7605
|
+
cookie?: never;
|
|
7606
|
+
};
|
|
7607
|
+
requestBody?: never;
|
|
7608
|
+
responses: {
|
|
7609
|
+
/** @description Successful Response */
|
|
7610
|
+
200: {
|
|
7611
|
+
headers: {
|
|
7612
|
+
[name: string]: unknown;
|
|
7613
|
+
};
|
|
7614
|
+
content: {
|
|
7615
|
+
'application/json': components['schemas']['ContactResponse'][];
|
|
7616
|
+
};
|
|
7617
|
+
};
|
|
7618
|
+
};
|
|
7619
|
+
};
|
|
7620
|
+
add_contacts: {
|
|
7621
|
+
parameters: {
|
|
7622
|
+
query?: never;
|
|
7623
|
+
header?: never;
|
|
7624
|
+
path?: never;
|
|
7625
|
+
cookie?: never;
|
|
7626
|
+
};
|
|
7627
|
+
requestBody: {
|
|
7628
|
+
content: {
|
|
7629
|
+
'application/json': components['schemas']['AddContactsRequest'];
|
|
7630
|
+
};
|
|
7631
|
+
};
|
|
7632
|
+
responses: {
|
|
7633
|
+
/** @description Successful Response */
|
|
7634
|
+
200: {
|
|
7635
|
+
headers: {
|
|
7636
|
+
[name: string]: unknown;
|
|
7637
|
+
};
|
|
7638
|
+
content: {
|
|
7639
|
+
'application/json': components['schemas']['ContactResponse'][];
|
|
7640
|
+
};
|
|
7641
|
+
};
|
|
7642
|
+
/** @description Validation Error */
|
|
7643
|
+
422: {
|
|
7644
|
+
headers: {
|
|
7645
|
+
[name: string]: unknown;
|
|
7646
|
+
};
|
|
7647
|
+
content: {
|
|
7648
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
7649
|
+
};
|
|
7650
|
+
};
|
|
7651
|
+
};
|
|
7652
|
+
};
|
|
7653
|
+
delete_user_contacts: {
|
|
7654
|
+
parameters: {
|
|
7655
|
+
query?: never;
|
|
7656
|
+
header?: never;
|
|
7657
|
+
path?: never;
|
|
6871
7658
|
cookie?: never;
|
|
6872
7659
|
};
|
|
6873
7660
|
requestBody: {
|
|
@@ -7310,61 +8097,6 @@ interface operations {
|
|
|
7310
8097
|
};
|
|
7311
8098
|
};
|
|
7312
8099
|
};
|
|
7313
|
-
get_subscription: {
|
|
7314
|
-
parameters: {
|
|
7315
|
-
query?: never;
|
|
7316
|
-
header?: never;
|
|
7317
|
-
path?: never;
|
|
7318
|
-
cookie?: never;
|
|
7319
|
-
};
|
|
7320
|
-
requestBody?: never;
|
|
7321
|
-
responses: {
|
|
7322
|
-
/** @description Successful Response */
|
|
7323
|
-
200: {
|
|
7324
|
-
headers: {
|
|
7325
|
-
[name: string]: unknown;
|
|
7326
|
-
};
|
|
7327
|
-
content: {
|
|
7328
|
-
'application/json': components['schemas']['SubscriptionStatusResponse'];
|
|
7329
|
-
};
|
|
7330
|
-
};
|
|
7331
|
-
};
|
|
7332
|
-
};
|
|
7333
|
-
create_subscription: {
|
|
7334
|
-
parameters: {
|
|
7335
|
-
query?: never;
|
|
7336
|
-
header?: {
|
|
7337
|
-
origin?: string;
|
|
7338
|
-
};
|
|
7339
|
-
path?: never;
|
|
7340
|
-
cookie?: never;
|
|
7341
|
-
};
|
|
7342
|
-
requestBody: {
|
|
7343
|
-
content: {
|
|
7344
|
-
'application/json': components['schemas']['CreateSubscriptionRequest'];
|
|
7345
|
-
};
|
|
7346
|
-
};
|
|
7347
|
-
responses: {
|
|
7348
|
-
/** @description Successful Response */
|
|
7349
|
-
200: {
|
|
7350
|
-
headers: {
|
|
7351
|
-
[name: string]: unknown;
|
|
7352
|
-
};
|
|
7353
|
-
content: {
|
|
7354
|
-
'application/json': components['schemas']['CreateSubscriptionResponse'];
|
|
7355
|
-
};
|
|
7356
|
-
};
|
|
7357
|
-
/** @description Validation Error */
|
|
7358
|
-
422: {
|
|
7359
|
-
headers: {
|
|
7360
|
-
[name: string]: unknown;
|
|
7361
|
-
};
|
|
7362
|
-
content: {
|
|
7363
|
-
'application/json': components['schemas']['HTTPValidationError'];
|
|
7364
|
-
};
|
|
7365
|
-
};
|
|
7366
|
-
};
|
|
7367
|
-
};
|
|
7368
8100
|
create_workspace: {
|
|
7369
8101
|
parameters: {
|
|
7370
8102
|
query?: never;
|
|
@@ -7670,7 +8402,7 @@ interface operations {
|
|
|
7670
8402
|
get_similar_documents: {
|
|
7671
8403
|
parameters: {
|
|
7672
8404
|
query?: {
|
|
7673
|
-
/** @description Minimum similarity score (0.
|
|
8405
|
+
/** @description Minimum similarity score (default 0.92 for near-duplicates) */
|
|
7674
8406
|
threshold?: number;
|
|
7675
8407
|
/** @description Filter pairs involving a specific document */
|
|
7676
8408
|
doc_ext_id?: string | null;
|
|
@@ -9202,6 +9934,8 @@ interface AutoReloginMiddlewareConfig {
|
|
|
9202
9934
|
/** URL substrings that should never trigger re-login (e.g. the login endpoint itself) */
|
|
9203
9935
|
reloginExcludePatterns?: string[];
|
|
9204
9936
|
onRetryCloneFailed?: () => void;
|
|
9937
|
+
/** Called when re-login was attempted but failed (returned null). Use to clear stale auth state. */
|
|
9938
|
+
onReloginFailed?: () => void;
|
|
9205
9939
|
}
|
|
9206
9940
|
|
|
9207
9941
|
/**
|