@arbidocs/sdk 0.3.7 → 0.3.9
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 +36 -39
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +808 -568
- package/dist/index.d.ts +808 -568
- package/dist/index.js +36 -40
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -5,27 +5,7 @@ import createFetchClient, { Middleware } from 'openapi-fetch';
|
|
|
5
5
|
* Do not make direct changes to the file.
|
|
6
6
|
*/
|
|
7
7
|
interface paths {
|
|
8
|
-
'/
|
|
9
|
-
parameters: {
|
|
10
|
-
query?: never;
|
|
11
|
-
header?: never;
|
|
12
|
-
path?: never;
|
|
13
|
-
cookie?: never;
|
|
14
|
-
};
|
|
15
|
-
/**
|
|
16
|
-
* Admin Index
|
|
17
|
-
* @description Serves the admin application page with necessary configuration variables.
|
|
18
|
-
*/
|
|
19
|
-
get: operations['admin_index_api_get'];
|
|
20
|
-
put?: never;
|
|
21
|
-
post?: never;
|
|
22
|
-
delete?: never;
|
|
23
|
-
options?: never;
|
|
24
|
-
head?: never;
|
|
25
|
-
patch?: never;
|
|
26
|
-
trace?: never;
|
|
27
|
-
};
|
|
28
|
-
'/api/user/verify-email': {
|
|
8
|
+
'/v1/user/verify-email': {
|
|
29
9
|
parameters: {
|
|
30
10
|
query?: never;
|
|
31
11
|
header?: never;
|
|
@@ -49,7 +29,7 @@ interface paths {
|
|
|
49
29
|
patch?: never;
|
|
50
30
|
trace?: never;
|
|
51
31
|
};
|
|
52
|
-
'/
|
|
32
|
+
'/v1/user/contacts': {
|
|
53
33
|
parameters: {
|
|
54
34
|
query?: never;
|
|
55
35
|
header?: never;
|
|
@@ -87,7 +67,7 @@ interface paths {
|
|
|
87
67
|
patch?: never;
|
|
88
68
|
trace?: never;
|
|
89
69
|
};
|
|
90
|
-
'/
|
|
70
|
+
'/v1/user/sso-status': {
|
|
91
71
|
parameters: {
|
|
92
72
|
query?: never;
|
|
93
73
|
header?: never;
|
|
@@ -117,7 +97,7 @@ interface paths {
|
|
|
117
97
|
patch?: never;
|
|
118
98
|
trace?: never;
|
|
119
99
|
};
|
|
120
|
-
'/
|
|
100
|
+
'/v1/user/register': {
|
|
121
101
|
parameters: {
|
|
122
102
|
query?: never;
|
|
123
103
|
header?: never;
|
|
@@ -143,7 +123,7 @@ interface paths {
|
|
|
143
123
|
patch?: never;
|
|
144
124
|
trace?: never;
|
|
145
125
|
};
|
|
146
|
-
'/
|
|
126
|
+
'/v1/user/login': {
|
|
147
127
|
parameters: {
|
|
148
128
|
query?: never;
|
|
149
129
|
header?: never;
|
|
@@ -173,7 +153,7 @@ interface paths {
|
|
|
173
153
|
patch?: never;
|
|
174
154
|
trace?: never;
|
|
175
155
|
};
|
|
176
|
-
'/
|
|
156
|
+
'/v1/user/logout': {
|
|
177
157
|
parameters: {
|
|
178
158
|
query?: never;
|
|
179
159
|
header?: never;
|
|
@@ -193,7 +173,7 @@ interface paths {
|
|
|
193
173
|
patch?: never;
|
|
194
174
|
trace?: never;
|
|
195
175
|
};
|
|
196
|
-
'/
|
|
176
|
+
'/v1/user/change_password': {
|
|
197
177
|
parameters: {
|
|
198
178
|
query?: never;
|
|
199
179
|
header?: never;
|
|
@@ -226,7 +206,7 @@ interface paths {
|
|
|
226
206
|
patch?: never;
|
|
227
207
|
trace?: never;
|
|
228
208
|
};
|
|
229
|
-
'/
|
|
209
|
+
'/v1/user/sso-send-verification-email': {
|
|
230
210
|
parameters: {
|
|
231
211
|
query?: never;
|
|
232
212
|
header?: never;
|
|
@@ -239,14 +219,14 @@ interface paths {
|
|
|
239
219
|
* Sso Send Verification Email
|
|
240
220
|
* @description Prompt Auth0 to send a verification email to the user's email address.
|
|
241
221
|
*/
|
|
242
|
-
post: operations['
|
|
222
|
+
post: operations['sso_send_verification_email_v1_user_sso_send_verification_email_post'];
|
|
243
223
|
delete?: never;
|
|
244
224
|
options?: never;
|
|
245
225
|
head?: never;
|
|
246
226
|
patch?: never;
|
|
247
227
|
trace?: never;
|
|
248
228
|
};
|
|
249
|
-
'/
|
|
229
|
+
'/v1/user/workspaces': {
|
|
250
230
|
parameters: {
|
|
251
231
|
query?: never;
|
|
252
232
|
header?: never;
|
|
@@ -269,7 +249,7 @@ interface paths {
|
|
|
269
249
|
patch?: never;
|
|
270
250
|
trace?: never;
|
|
271
251
|
};
|
|
272
|
-
'/
|
|
252
|
+
'/v1/user/settings': {
|
|
273
253
|
parameters: {
|
|
274
254
|
query?: never;
|
|
275
255
|
header?: never;
|
|
@@ -297,7 +277,7 @@ interface paths {
|
|
|
297
277
|
patch: operations['update_user_settings'];
|
|
298
278
|
trace?: never;
|
|
299
279
|
};
|
|
300
|
-
'/
|
|
280
|
+
'/v1/user/products': {
|
|
301
281
|
parameters: {
|
|
302
282
|
query?: never;
|
|
303
283
|
header?: never;
|
|
@@ -317,7 +297,7 @@ interface paths {
|
|
|
317
297
|
patch?: never;
|
|
318
298
|
trace?: never;
|
|
319
299
|
};
|
|
320
|
-
'/
|
|
300
|
+
'/v1/user/subscription': {
|
|
321
301
|
parameters: {
|
|
322
302
|
query?: never;
|
|
323
303
|
header?: never;
|
|
@@ -344,7 +324,7 @@ interface paths {
|
|
|
344
324
|
patch?: never;
|
|
345
325
|
trace?: never;
|
|
346
326
|
};
|
|
347
|
-
'/
|
|
327
|
+
'/v1/workspace/create_protected': {
|
|
348
328
|
parameters: {
|
|
349
329
|
query?: never;
|
|
350
330
|
header?: never;
|
|
@@ -376,7 +356,33 @@ interface paths {
|
|
|
376
356
|
patch?: never;
|
|
377
357
|
trace?: never;
|
|
378
358
|
};
|
|
379
|
-
'/
|
|
359
|
+
'/v1/workspace/{workspace_ext_id}/open': {
|
|
360
|
+
parameters: {
|
|
361
|
+
query?: never;
|
|
362
|
+
header?: never;
|
|
363
|
+
path?: never;
|
|
364
|
+
cookie?: never;
|
|
365
|
+
};
|
|
366
|
+
get?: never;
|
|
367
|
+
put?: never;
|
|
368
|
+
/**
|
|
369
|
+
* Open Workspace
|
|
370
|
+
* @description Open a workspace: decrypt workspace key, issue a workspace-scoped JWT, and return workspace data.
|
|
371
|
+
*
|
|
372
|
+
* The workspace key is provided in the request body (same SealedBox-encrypted format as the
|
|
373
|
+
* workspace-key header). A new JWT is issued with embedded workspace claims so subsequent API
|
|
374
|
+
* calls only need the Authorization header — no workspace-key header required.
|
|
375
|
+
*
|
|
376
|
+
* Returns the workspace-scoped JWT along with conversations, documents, and tags.
|
|
377
|
+
*/
|
|
378
|
+
post: operations['open_workspace'];
|
|
379
|
+
delete?: never;
|
|
380
|
+
options?: never;
|
|
381
|
+
head?: never;
|
|
382
|
+
patch?: never;
|
|
383
|
+
trace?: never;
|
|
384
|
+
};
|
|
385
|
+
'/v1/workspace/users': {
|
|
380
386
|
parameters: {
|
|
381
387
|
query?: never;
|
|
382
388
|
header?: never;
|
|
@@ -385,7 +391,7 @@ interface paths {
|
|
|
385
391
|
};
|
|
386
392
|
/**
|
|
387
393
|
* Get Workspace Users
|
|
388
|
-
* @description Retrieve users with access to
|
|
394
|
+
* @description Retrieve users with access to the current workspace.
|
|
389
395
|
* RLS handles access control: members can view private workspaces,
|
|
390
396
|
* anyone can view public workspaces.
|
|
391
397
|
*/
|
|
@@ -395,8 +401,8 @@ interface paths {
|
|
|
395
401
|
* Add Workspace Users
|
|
396
402
|
* @description Add users to a workspace (bulk operation). Only workspace owners can add users.
|
|
397
403
|
*
|
|
398
|
-
* Client provides
|
|
399
|
-
*
|
|
404
|
+
* Client provides workspace-scoped JWT. Server decrypts workspace key from JWT claims,
|
|
405
|
+
* then wraps it with each recipient's public key.
|
|
400
406
|
* Returns the full WorkspaceUserResponse for each successfully added user.
|
|
401
407
|
*/
|
|
402
408
|
post: operations['add_workspace_users'];
|
|
@@ -416,7 +422,7 @@ interface paths {
|
|
|
416
422
|
patch: operations['update_workspace_user_roles'];
|
|
417
423
|
trace?: never;
|
|
418
424
|
};
|
|
419
|
-
'/
|
|
425
|
+
'/v1/workspace/copy': {
|
|
420
426
|
parameters: {
|
|
421
427
|
query?: never;
|
|
422
428
|
header?: never;
|
|
@@ -427,13 +433,10 @@ interface paths {
|
|
|
427
433
|
put?: never;
|
|
428
434
|
/**
|
|
429
435
|
* Copy Workspace Data
|
|
430
|
-
* @description Copy documents from source workspace to target workspace.
|
|
436
|
+
* @description Copy documents from source workspace (current) to target workspace.
|
|
431
437
|
*
|
|
432
|
-
* Requires
|
|
433
|
-
*
|
|
434
|
-
* - Target workspace must exist and user must have access
|
|
435
|
-
* - Workspace-Key header with source workspace key (optional for public workspaces, required for private)
|
|
436
|
-
* - Target-Workspace-Key header with target workspace key (required)
|
|
438
|
+
* Requires workspace-scoped JWT for the source workspace.
|
|
439
|
+
* Target workspace key is provided in the request body (SealedBox-encrypted).
|
|
437
440
|
*
|
|
438
441
|
* Copies:
|
|
439
442
|
* - Document metadata (title, doc_date, shared status, etc.)
|
|
@@ -447,57 +450,35 @@ interface paths {
|
|
|
447
450
|
patch?: never;
|
|
448
451
|
trace?: never;
|
|
449
452
|
};
|
|
450
|
-
'/
|
|
453
|
+
'/v1/workspace/': {
|
|
451
454
|
parameters: {
|
|
452
455
|
query?: never;
|
|
453
456
|
header?: never;
|
|
454
457
|
path?: never;
|
|
455
458
|
cookie?: never;
|
|
456
459
|
};
|
|
457
|
-
|
|
458
|
-
* Get User Workspace Conversations
|
|
459
|
-
* @description Retrieve conversations for a workspace where the current user is:
|
|
460
|
-
* - The creator of the conversation, or
|
|
461
|
-
* - Listed in the ConvoUsers table.
|
|
462
|
-
*
|
|
463
|
-
* Return conversation metadata including:
|
|
464
|
-
* - External ID
|
|
465
|
-
* - Title
|
|
466
|
-
* - Last updated date
|
|
467
|
-
* - Number of messages
|
|
468
|
-
* - Whether the current user is the creator
|
|
469
|
-
*/
|
|
470
|
-
get: operations['get_workspace_conversations'];
|
|
460
|
+
get?: never;
|
|
471
461
|
put?: never;
|
|
472
462
|
post?: never;
|
|
473
|
-
delete?: never;
|
|
474
|
-
options?: never;
|
|
475
|
-
head?: never;
|
|
476
|
-
patch?: never;
|
|
477
|
-
trace?: never;
|
|
478
|
-
};
|
|
479
|
-
'/api/workspace/{workspace_ext_id}/documents': {
|
|
480
|
-
parameters: {
|
|
481
|
-
query?: never;
|
|
482
|
-
header?: never;
|
|
483
|
-
path?: never;
|
|
484
|
-
cookie?: never;
|
|
485
|
-
};
|
|
486
463
|
/**
|
|
487
|
-
*
|
|
488
|
-
* @description
|
|
489
|
-
* Decrypts document metadata for authorized users.
|
|
464
|
+
* Delete Workspaces
|
|
465
|
+
* @description Delete one or more workspaces by external ID.
|
|
490
466
|
*/
|
|
491
|
-
|
|
492
|
-
put?: never;
|
|
493
|
-
post?: never;
|
|
494
|
-
delete?: never;
|
|
467
|
+
delete: operations['delete_workspaces'];
|
|
495
468
|
options?: never;
|
|
496
469
|
head?: never;
|
|
497
|
-
|
|
470
|
+
/**
|
|
471
|
+
* Update Workspace
|
|
472
|
+
* @description Update workspace metadata such as name, description, or public status.
|
|
473
|
+
* Changes are persisted to the database.
|
|
474
|
+
*
|
|
475
|
+
* Only developers can change the is_public field.
|
|
476
|
+
* When making a workspace public, the workspace key from the JWT is used.
|
|
477
|
+
*/
|
|
478
|
+
patch: operations['update_workspace'];
|
|
498
479
|
trace?: never;
|
|
499
480
|
};
|
|
500
|
-
'/
|
|
481
|
+
'/v1/document/list': {
|
|
501
482
|
parameters: {
|
|
502
483
|
query?: never;
|
|
503
484
|
header?: never;
|
|
@@ -505,10 +486,10 @@ interface paths {
|
|
|
505
486
|
cookie?: never;
|
|
506
487
|
};
|
|
507
488
|
/**
|
|
508
|
-
*
|
|
509
|
-
* @description
|
|
489
|
+
* List Documents
|
|
490
|
+
* @description List all documents in the current workspace.
|
|
510
491
|
*/
|
|
511
|
-
get: operations['
|
|
492
|
+
get: operations['list_documents'];
|
|
512
493
|
put?: never;
|
|
513
494
|
post?: never;
|
|
514
495
|
delete?: never;
|
|
@@ -517,39 +498,7 @@ interface paths {
|
|
|
517
498
|
patch?: never;
|
|
518
499
|
trace?: never;
|
|
519
500
|
};
|
|
520
|
-
'/
|
|
521
|
-
parameters: {
|
|
522
|
-
query?: never;
|
|
523
|
-
header?: never;
|
|
524
|
-
path?: never;
|
|
525
|
-
cookie?: never;
|
|
526
|
-
};
|
|
527
|
-
get?: never;
|
|
528
|
-
put?: never;
|
|
529
|
-
post?: never;
|
|
530
|
-
/**
|
|
531
|
-
* Delete Workspace
|
|
532
|
-
* @description Delete a workspace.
|
|
533
|
-
*
|
|
534
|
-
* Only the creator of the workspace is allowed to delete it.
|
|
535
|
-
* Workspaces with other members cannot be deleted - remove all members first.
|
|
536
|
-
* If the workspace deletion fails (e.g., due to RLS policy), the operation aborts.
|
|
537
|
-
*/
|
|
538
|
-
delete: operations['delete_workspace'];
|
|
539
|
-
options?: never;
|
|
540
|
-
head?: never;
|
|
541
|
-
/**
|
|
542
|
-
* Update Workspace
|
|
543
|
-
* @description Update workspace metadata such as name, description, or public status.
|
|
544
|
-
* Changes are persisted to the database.
|
|
545
|
-
*
|
|
546
|
-
* Only developers can change the is_public field.
|
|
547
|
-
* When making a workspace public, the backend uses the Workspace-Key header to get the workspace key.
|
|
548
|
-
*/
|
|
549
|
-
patch: operations['update_workspace'];
|
|
550
|
-
trace?: never;
|
|
551
|
-
};
|
|
552
|
-
'/api/document/': {
|
|
501
|
+
'/v1/document/': {
|
|
553
502
|
parameters: {
|
|
554
503
|
query?: never;
|
|
555
504
|
header?: never;
|
|
@@ -581,7 +530,7 @@ interface paths {
|
|
|
581
530
|
patch: operations['update_documents'];
|
|
582
531
|
trace?: never;
|
|
583
532
|
};
|
|
584
|
-
'/
|
|
533
|
+
'/v1/document/doctag': {
|
|
585
534
|
parameters: {
|
|
586
535
|
query?: never;
|
|
587
536
|
header?: never;
|
|
@@ -609,7 +558,7 @@ interface paths {
|
|
|
609
558
|
patch: operations['update_doctag'];
|
|
610
559
|
trace?: never;
|
|
611
560
|
};
|
|
612
|
-
'/
|
|
561
|
+
'/v1/document/upload': {
|
|
613
562
|
parameters: {
|
|
614
563
|
query?: never;
|
|
615
564
|
header?: never;
|
|
@@ -641,7 +590,7 @@ interface paths {
|
|
|
641
590
|
patch?: never;
|
|
642
591
|
trace?: never;
|
|
643
592
|
};
|
|
644
|
-
'/
|
|
593
|
+
'/v1/document/upload-url': {
|
|
645
594
|
parameters: {
|
|
646
595
|
query?: never;
|
|
647
596
|
header?: never;
|
|
@@ -664,7 +613,7 @@ interface paths {
|
|
|
664
613
|
patch?: never;
|
|
665
614
|
trace?: never;
|
|
666
615
|
};
|
|
667
|
-
'/
|
|
616
|
+
'/v1/document/{document_ext_id}/download': {
|
|
668
617
|
parameters: {
|
|
669
618
|
query?: never;
|
|
670
619
|
header?: never;
|
|
@@ -685,7 +634,7 @@ interface paths {
|
|
|
685
634
|
patch?: never;
|
|
686
635
|
trace?: never;
|
|
687
636
|
};
|
|
688
|
-
'/
|
|
637
|
+
'/v1/document/{document_ext_id}/view': {
|
|
689
638
|
parameters: {
|
|
690
639
|
query?: never;
|
|
691
640
|
header?: never;
|
|
@@ -706,7 +655,7 @@ interface paths {
|
|
|
706
655
|
patch?: never;
|
|
707
656
|
trace?: never;
|
|
708
657
|
};
|
|
709
|
-
'/
|
|
658
|
+
'/v1/document/{document_ext_id}/parsed-{stage}': {
|
|
710
659
|
parameters: {
|
|
711
660
|
query?: never;
|
|
712
661
|
header?: never;
|
|
@@ -727,7 +676,7 @@ interface paths {
|
|
|
727
676
|
patch?: never;
|
|
728
677
|
trace?: never;
|
|
729
678
|
};
|
|
730
|
-
'/
|
|
679
|
+
'/v1/document/doctag/generate': {
|
|
731
680
|
parameters: {
|
|
732
681
|
query?: never;
|
|
733
682
|
header?: never;
|
|
@@ -753,7 +702,27 @@ interface paths {
|
|
|
753
702
|
patch?: never;
|
|
754
703
|
trace?: never;
|
|
755
704
|
};
|
|
756
|
-
'/
|
|
705
|
+
'/v1/conversation/list': {
|
|
706
|
+
parameters: {
|
|
707
|
+
query?: never;
|
|
708
|
+
header?: never;
|
|
709
|
+
path?: never;
|
|
710
|
+
cookie?: never;
|
|
711
|
+
};
|
|
712
|
+
/**
|
|
713
|
+
* List Conversations
|
|
714
|
+
* @description List all conversations in the current workspace.
|
|
715
|
+
*/
|
|
716
|
+
get: operations['list_conversations'];
|
|
717
|
+
put?: never;
|
|
718
|
+
post?: never;
|
|
719
|
+
delete?: never;
|
|
720
|
+
options?: never;
|
|
721
|
+
head?: never;
|
|
722
|
+
patch?: never;
|
|
723
|
+
trace?: never;
|
|
724
|
+
};
|
|
725
|
+
'/v1/conversation/message/{message_ext_id}': {
|
|
757
726
|
parameters: {
|
|
758
727
|
query?: never;
|
|
759
728
|
header?: never;
|
|
@@ -778,7 +747,7 @@ interface paths {
|
|
|
778
747
|
patch?: never;
|
|
779
748
|
trace?: never;
|
|
780
749
|
};
|
|
781
|
-
'/
|
|
750
|
+
'/v1/conversation/{conversation_ext_id}/threads': {
|
|
782
751
|
parameters: {
|
|
783
752
|
query?: never;
|
|
784
753
|
header?: never;
|
|
@@ -798,7 +767,7 @@ interface paths {
|
|
|
798
767
|
patch?: never;
|
|
799
768
|
trace?: never;
|
|
800
769
|
};
|
|
801
|
-
'/
|
|
770
|
+
'/v1/conversation/{conversation_ext_id}': {
|
|
802
771
|
parameters: {
|
|
803
772
|
query?: never;
|
|
804
773
|
header?: never;
|
|
@@ -820,36 +789,7 @@ interface paths {
|
|
|
820
789
|
patch?: never;
|
|
821
790
|
trace?: never;
|
|
822
791
|
};
|
|
823
|
-
'/
|
|
824
|
-
parameters: {
|
|
825
|
-
query?: never;
|
|
826
|
-
header?: never;
|
|
827
|
-
path?: never;
|
|
828
|
-
cookie?: never;
|
|
829
|
-
};
|
|
830
|
-
get?: never;
|
|
831
|
-
put?: never;
|
|
832
|
-
/**
|
|
833
|
-
* Add User To Conversation
|
|
834
|
-
* @description Add a user to a conversation.
|
|
835
|
-
*
|
|
836
|
-
* RLS ensures the user can only add users to conversations they have access to.
|
|
837
|
-
* PostgreSQL constraints handle duplicate users.
|
|
838
|
-
*/
|
|
839
|
-
post: operations['add_user_to_conversation'];
|
|
840
|
-
/**
|
|
841
|
-
* Remove User From Conversation
|
|
842
|
-
* @description Remove a user from a conversation.
|
|
843
|
-
*
|
|
844
|
-
* RLS ensures the user can only modify conversations they have access to.
|
|
845
|
-
*/
|
|
846
|
-
delete: operations['remove_user_from_conversation'];
|
|
847
|
-
options?: never;
|
|
848
|
-
head?: never;
|
|
849
|
-
patch?: never;
|
|
850
|
-
trace?: never;
|
|
851
|
-
};
|
|
852
|
-
'/api/conversation/{conversation_ext_id}/share': {
|
|
792
|
+
'/v1/conversation/{conversation_ext_id}/share': {
|
|
853
793
|
parameters: {
|
|
854
794
|
query?: never;
|
|
855
795
|
header?: never;
|
|
@@ -871,7 +811,7 @@ interface paths {
|
|
|
871
811
|
patch?: never;
|
|
872
812
|
trace?: never;
|
|
873
813
|
};
|
|
874
|
-
'/
|
|
814
|
+
'/v1/conversation/{conversation_ext_id}/title': {
|
|
875
815
|
parameters: {
|
|
876
816
|
query?: never;
|
|
877
817
|
header?: never;
|
|
@@ -892,7 +832,7 @@ interface paths {
|
|
|
892
832
|
patch: operations['update_conversation_title'];
|
|
893
833
|
trace?: never;
|
|
894
834
|
};
|
|
895
|
-
'/
|
|
835
|
+
'/v1/assistant/sse-schema': {
|
|
896
836
|
parameters: {
|
|
897
837
|
query?: never;
|
|
898
838
|
header?: never;
|
|
@@ -915,7 +855,7 @@ interface paths {
|
|
|
915
855
|
patch?: never;
|
|
916
856
|
trace?: never;
|
|
917
857
|
};
|
|
918
|
-
'/
|
|
858
|
+
'/v1/assistant/query': {
|
|
919
859
|
parameters: {
|
|
920
860
|
query?: never;
|
|
921
861
|
header?: never;
|
|
@@ -938,7 +878,7 @@ interface paths {
|
|
|
938
878
|
patch?: never;
|
|
939
879
|
trace?: never;
|
|
940
880
|
};
|
|
941
|
-
'/
|
|
881
|
+
'/v1/assistant/respond': {
|
|
942
882
|
parameters: {
|
|
943
883
|
query?: never;
|
|
944
884
|
header?: never;
|
|
@@ -961,7 +901,7 @@ interface paths {
|
|
|
961
901
|
patch?: never;
|
|
962
902
|
trace?: never;
|
|
963
903
|
};
|
|
964
|
-
'/
|
|
904
|
+
'/v1/assistant/retrieve': {
|
|
965
905
|
parameters: {
|
|
966
906
|
query?: never;
|
|
967
907
|
header?: never;
|
|
@@ -982,7 +922,7 @@ interface paths {
|
|
|
982
922
|
patch?: never;
|
|
983
923
|
trace?: never;
|
|
984
924
|
};
|
|
985
|
-
'/
|
|
925
|
+
'/v1/health/': {
|
|
986
926
|
parameters: {
|
|
987
927
|
query?: never;
|
|
988
928
|
header?: never;
|
|
@@ -1003,7 +943,7 @@ interface paths {
|
|
|
1003
943
|
patch?: never;
|
|
1004
944
|
trace?: never;
|
|
1005
945
|
};
|
|
1006
|
-
'/
|
|
946
|
+
'/v1/health/remote-models': {
|
|
1007
947
|
parameters: {
|
|
1008
948
|
query?: never;
|
|
1009
949
|
header?: never;
|
|
@@ -1024,7 +964,7 @@ interface paths {
|
|
|
1024
964
|
patch?: never;
|
|
1025
965
|
trace?: never;
|
|
1026
966
|
};
|
|
1027
|
-
'/
|
|
967
|
+
'/v1/health/models': {
|
|
1028
968
|
parameters: {
|
|
1029
969
|
query?: never;
|
|
1030
970
|
header?: never;
|
|
@@ -1044,7 +984,7 @@ interface paths {
|
|
|
1044
984
|
patch?: never;
|
|
1045
985
|
trace?: never;
|
|
1046
986
|
};
|
|
1047
|
-
'/
|
|
987
|
+
'/v1/health/mcp-tools': {
|
|
1048
988
|
parameters: {
|
|
1049
989
|
query?: never;
|
|
1050
990
|
header?: never;
|
|
@@ -1064,7 +1004,27 @@ interface paths {
|
|
|
1064
1004
|
patch?: never;
|
|
1065
1005
|
trace?: never;
|
|
1066
1006
|
};
|
|
1067
|
-
'/
|
|
1007
|
+
'/v1/tag/list': {
|
|
1008
|
+
parameters: {
|
|
1009
|
+
query?: never;
|
|
1010
|
+
header?: never;
|
|
1011
|
+
path?: never;
|
|
1012
|
+
cookie?: never;
|
|
1013
|
+
};
|
|
1014
|
+
/**
|
|
1015
|
+
* List Tags
|
|
1016
|
+
* @description List all tags in the current workspace.
|
|
1017
|
+
*/
|
|
1018
|
+
get: operations['list_tags'];
|
|
1019
|
+
put?: never;
|
|
1020
|
+
post?: never;
|
|
1021
|
+
delete?: never;
|
|
1022
|
+
options?: never;
|
|
1023
|
+
head?: never;
|
|
1024
|
+
patch?: never;
|
|
1025
|
+
trace?: never;
|
|
1026
|
+
};
|
|
1027
|
+
'/v1/tag/': {
|
|
1068
1028
|
parameters: {
|
|
1069
1029
|
query?: never;
|
|
1070
1030
|
header?: never;
|
|
@@ -1087,7 +1047,7 @@ interface paths {
|
|
|
1087
1047
|
patch?: never;
|
|
1088
1048
|
trace?: never;
|
|
1089
1049
|
};
|
|
1090
|
-
'/
|
|
1050
|
+
'/v1/tag/{tag_ext_id}': {
|
|
1091
1051
|
parameters: {
|
|
1092
1052
|
query?: never;
|
|
1093
1053
|
header?: never;
|
|
@@ -1111,7 +1071,7 @@ interface paths {
|
|
|
1111
1071
|
patch: operations['update_tag'];
|
|
1112
1072
|
trace?: never;
|
|
1113
1073
|
};
|
|
1114
|
-
'/
|
|
1074
|
+
'/v1/notifications/ws-schemas': {
|
|
1115
1075
|
parameters: {
|
|
1116
1076
|
query?: never;
|
|
1117
1077
|
header?: never;
|
|
@@ -1136,7 +1096,7 @@ interface paths {
|
|
|
1136
1096
|
patch?: never;
|
|
1137
1097
|
trace?: never;
|
|
1138
1098
|
};
|
|
1139
|
-
'/
|
|
1099
|
+
'/v1/notifications/': {
|
|
1140
1100
|
parameters: {
|
|
1141
1101
|
query?: never;
|
|
1142
1102
|
header?: never;
|
|
@@ -1184,7 +1144,7 @@ interface paths {
|
|
|
1184
1144
|
patch: operations['update_notifications'];
|
|
1185
1145
|
trace?: never;
|
|
1186
1146
|
};
|
|
1187
|
-
'/
|
|
1147
|
+
'/v1/configs/schema': {
|
|
1188
1148
|
parameters: {
|
|
1189
1149
|
query?: never;
|
|
1190
1150
|
header?: never;
|
|
@@ -1204,7 +1164,7 @@ interface paths {
|
|
|
1204
1164
|
patch?: never;
|
|
1205
1165
|
trace?: never;
|
|
1206
1166
|
};
|
|
1207
|
-
'/
|
|
1167
|
+
'/v1/configs/versions': {
|
|
1208
1168
|
parameters: {
|
|
1209
1169
|
query?: never;
|
|
1210
1170
|
header?: never;
|
|
@@ -1224,7 +1184,7 @@ interface paths {
|
|
|
1224
1184
|
patch?: never;
|
|
1225
1185
|
trace?: never;
|
|
1226
1186
|
};
|
|
1227
|
-
'/
|
|
1187
|
+
'/v1/configs/{config_ext_id}': {
|
|
1228
1188
|
parameters: {
|
|
1229
1189
|
query?: never;
|
|
1230
1190
|
header?: never;
|
|
@@ -1248,7 +1208,7 @@ interface paths {
|
|
|
1248
1208
|
patch?: never;
|
|
1249
1209
|
trace?: never;
|
|
1250
1210
|
};
|
|
1251
|
-
'/
|
|
1211
|
+
'/v1/configs/': {
|
|
1252
1212
|
parameters: {
|
|
1253
1213
|
query?: never;
|
|
1254
1214
|
header?: never;
|
|
@@ -1272,6 +1232,105 @@ interface paths {
|
|
|
1272
1232
|
patch?: never;
|
|
1273
1233
|
trace?: never;
|
|
1274
1234
|
};
|
|
1235
|
+
'/v1/files': {
|
|
1236
|
+
parameters: {
|
|
1237
|
+
query?: never;
|
|
1238
|
+
header?: never;
|
|
1239
|
+
path?: never;
|
|
1240
|
+
cookie?: never;
|
|
1241
|
+
};
|
|
1242
|
+
/**
|
|
1243
|
+
* List Files
|
|
1244
|
+
* @description List all files in the workspace (OpenAI-compatible).
|
|
1245
|
+
*/
|
|
1246
|
+
get: operations['list_files'];
|
|
1247
|
+
put?: never;
|
|
1248
|
+
/**
|
|
1249
|
+
* Upload File
|
|
1250
|
+
* @description Upload a file (OpenAI-compatible).
|
|
1251
|
+
*
|
|
1252
|
+
* Accepts a single file upload and queues it for processing.
|
|
1253
|
+
*/
|
|
1254
|
+
post: operations['upload_file'];
|
|
1255
|
+
delete?: never;
|
|
1256
|
+
options?: never;
|
|
1257
|
+
head?: never;
|
|
1258
|
+
patch?: never;
|
|
1259
|
+
trace?: never;
|
|
1260
|
+
};
|
|
1261
|
+
'/v1/files/{file_id}': {
|
|
1262
|
+
parameters: {
|
|
1263
|
+
query?: never;
|
|
1264
|
+
header?: never;
|
|
1265
|
+
path?: never;
|
|
1266
|
+
cookie?: never;
|
|
1267
|
+
};
|
|
1268
|
+
/**
|
|
1269
|
+
* Get File
|
|
1270
|
+
* @description Retrieve a single file by ID (OpenAI-compatible).
|
|
1271
|
+
*/
|
|
1272
|
+
get: operations['get_file'];
|
|
1273
|
+
put?: never;
|
|
1274
|
+
post?: never;
|
|
1275
|
+
/**
|
|
1276
|
+
* Delete File
|
|
1277
|
+
* @description Delete a file by ID (OpenAI-compatible).
|
|
1278
|
+
*/
|
|
1279
|
+
delete: operations['delete_file'];
|
|
1280
|
+
options?: never;
|
|
1281
|
+
head?: never;
|
|
1282
|
+
patch?: never;
|
|
1283
|
+
trace?: never;
|
|
1284
|
+
};
|
|
1285
|
+
'/v1/chat/completions': {
|
|
1286
|
+
parameters: {
|
|
1287
|
+
query?: never;
|
|
1288
|
+
header?: never;
|
|
1289
|
+
path?: never;
|
|
1290
|
+
cookie?: never;
|
|
1291
|
+
};
|
|
1292
|
+
get?: never;
|
|
1293
|
+
put?: never;
|
|
1294
|
+
/**
|
|
1295
|
+
* Chat Completions
|
|
1296
|
+
* @description OpenAI-compatible chat completions endpoint.
|
|
1297
|
+
*
|
|
1298
|
+
* Supports:
|
|
1299
|
+
* - Standard chat completion (pure LLM proxy)
|
|
1300
|
+
* - file_search tool interception for RAG-augmented responses
|
|
1301
|
+
* - Both streaming (SSE) and non-streaming modes
|
|
1302
|
+
* - Citation generation when retrieval is used
|
|
1303
|
+
*/
|
|
1304
|
+
post: operations['chat_completions'];
|
|
1305
|
+
delete?: never;
|
|
1306
|
+
options?: never;
|
|
1307
|
+
head?: never;
|
|
1308
|
+
patch?: never;
|
|
1309
|
+
trace?: never;
|
|
1310
|
+
};
|
|
1311
|
+
'/v1/responses': {
|
|
1312
|
+
parameters: {
|
|
1313
|
+
query?: never;
|
|
1314
|
+
header?: never;
|
|
1315
|
+
path?: never;
|
|
1316
|
+
cookie?: never;
|
|
1317
|
+
};
|
|
1318
|
+
get?: never;
|
|
1319
|
+
put?: never;
|
|
1320
|
+
/**
|
|
1321
|
+
* Query
|
|
1322
|
+
* @description Process a user query against documents in a workspace.
|
|
1323
|
+
* Performs retrieval augmented generation with streaming response.
|
|
1324
|
+
*
|
|
1325
|
+
* Requires active subscription (paid/trial/dev) if Stripe is configured.
|
|
1326
|
+
*/
|
|
1327
|
+
post: operations['query_v1_responses_post'];
|
|
1328
|
+
delete?: never;
|
|
1329
|
+
options?: never;
|
|
1330
|
+
head?: never;
|
|
1331
|
+
patch?: never;
|
|
1332
|
+
trace?: never;
|
|
1333
|
+
};
|
|
1275
1334
|
}
|
|
1276
1335
|
type webhooks = Record<string, never>;
|
|
1277
1336
|
interface components {
|
|
@@ -1284,19 +1343,6 @@ interface components {
|
|
|
1284
1343
|
/** Emails */
|
|
1285
1344
|
emails: string[];
|
|
1286
1345
|
};
|
|
1287
|
-
/** AddUserToConversationRequest */
|
|
1288
|
-
AddUserToConversationRequest: {
|
|
1289
|
-
/** User Ext Id */
|
|
1290
|
-
user_ext_id: string;
|
|
1291
|
-
};
|
|
1292
|
-
/** AddUserToConversationResponse */
|
|
1293
|
-
AddUserToConversationResponse: {
|
|
1294
|
-
/**
|
|
1295
|
-
* Detail
|
|
1296
|
-
* @default User added to conversation successfully
|
|
1297
|
-
*/
|
|
1298
|
-
detail: string;
|
|
1299
|
-
};
|
|
1300
1346
|
/**
|
|
1301
1347
|
* AddWorkspaceUsersRequest
|
|
1302
1348
|
* @description Request to add users to a workspace (POST /workspace/{id}/users).
|
|
@@ -1318,34 +1364,34 @@ interface components {
|
|
|
1318
1364
|
* The content field carries extended text (e.g. the research plan).
|
|
1319
1365
|
*
|
|
1320
1366
|
* Examples:
|
|
1321
|
-
* {"type": "agent_step", "index": 1, "step": "planning",
|
|
1367
|
+
* {"type": "arbi.agent_step", "index": 1, "step": "planning",
|
|
1322
1368
|
* "content": "1. Search for force majeure clauses across all three contracts\n2. Compare scope and exclusions"}
|
|
1323
|
-
* {"type": "agent_step", "index": 2,
|
|
1369
|
+
* {"type": "arbi.agent_step", "index": 2,
|
|
1324
1370
|
* "focus": "Searching for force majeure clauses across the selected contracts.",
|
|
1325
1371
|
* "detail": [
|
|
1326
1372
|
* {"tool": "search_documents", "query": "force majeure", "search_mode": "hybrid"},
|
|
1327
1373
|
* {"tool": "get_table_of_contents", "doc_count": 2}
|
|
1328
1374
|
* ]}
|
|
1329
|
-
* {"type": "agent_step", "index": 3,
|
|
1375
|
+
* {"type": "arbi.agent_step", "index": 3,
|
|
1330
1376
|
* "focus": "Comparing the provisions found in Contract A with Contract B.",
|
|
1331
1377
|
* "detail": [
|
|
1332
1378
|
* {"tool": "get_document_passages", "doc_ext_id": "doc-abc12345", "from_ref": "5", "to_ref": "8"}
|
|
1333
1379
|
* ]}
|
|
1334
|
-
* {"type": "agent_step", "index": 3, "detail": [
|
|
1380
|
+
* {"type": "arbi.agent_step", "index": 3, "detail": [
|
|
1335
1381
|
* {"tool": "web_search", "query": "latest arbitration developments 2026"}
|
|
1336
1382
|
* ]}
|
|
1337
|
-
* {"type": "agent_step", "index": 3, "detail": [
|
|
1383
|
+
* {"type": "arbi.agent_step", "index": 3, "detail": [
|
|
1338
1384
|
* {"tool": "delegate_to_agent", "task": "Execute Python code to compute the SHA256 hash..."}
|
|
1339
1385
|
* ]}
|
|
1340
|
-
* {"type": "agent_step", "index": 4, "step": "evaluation", "detail": [
|
|
1386
|
+
* {"type": "arbi.agent_step", "index": 4, "step": "evaluation", "detail": [
|
|
1341
1387
|
* {"statement": "Newton prosecuted 28 coiners", "chunk_ids": ["chunk-abc"]},
|
|
1342
1388
|
* {"statement": "Counterfeiting was high treason", "chunk_ids": ["chunk-def"]}
|
|
1343
1389
|
* ]}
|
|
1344
|
-
* {"type": "agent_step", "index": 5, "step": "tool_progress", "detail": [
|
|
1390
|
+
* {"type": "arbi.agent_step", "index": 5, "step": "tool_progress", "detail": [
|
|
1345
1391
|
* {"tool": "read_urls", "message": "Fetching 2 pages"}
|
|
1346
1392
|
* ]}
|
|
1347
|
-
* {"type": "agent_step", "index": 6, "step": "answering"}
|
|
1348
|
-
* {"type": "agent_step", "index": 7, "step": "reviewing"}
|
|
1393
|
+
* {"type": "arbi.agent_step", "index": 6, "step": "answering"}
|
|
1394
|
+
* {"type": "arbi.agent_step", "index": 7, "step": "reviewing"}
|
|
1349
1395
|
*/
|
|
1350
1396
|
AgentStepEvent: {
|
|
1351
1397
|
/**
|
|
@@ -1355,10 +1401,10 @@ interface components {
|
|
|
1355
1401
|
t?: number | null;
|
|
1356
1402
|
/**
|
|
1357
1403
|
* Type
|
|
1358
|
-
* @default agent_step
|
|
1404
|
+
* @default arbi.agent_step
|
|
1359
1405
|
* @constant
|
|
1360
1406
|
*/
|
|
1361
|
-
type: 'agent_step';
|
|
1407
|
+
type: 'arbi.agent_step';
|
|
1362
1408
|
/**
|
|
1363
1409
|
* Index
|
|
1364
1410
|
* @description Sequential step number (1-based)
|
|
@@ -1788,9 +1834,9 @@ interface components {
|
|
|
1788
1834
|
* - Enable redline view when multiple versions exist
|
|
1789
1835
|
*
|
|
1790
1836
|
* Examples:
|
|
1791
|
-
* {"type": "artifact", "doc_ext_id": "doc-abc12345", "title": "Contract Summary",
|
|
1837
|
+
* {"type": "arbi.artifact", "doc_ext_id": "doc-abc12345", "title": "Contract Summary",
|
|
1792
1838
|
* "mode": "markdown", "content": "# Summary\n...", "is_complete": false}
|
|
1793
|
-
* {"type": "artifact", "doc_ext_id": "doc-abc12345", "title": "Contract Summary",
|
|
1839
|
+
* {"type": "arbi.artifact", "doc_ext_id": "doc-abc12345", "title": "Contract Summary",
|
|
1794
1840
|
* "mode": "markdown", "content": "# Summary\n...", "is_complete": true, "version": 1}
|
|
1795
1841
|
*/
|
|
1796
1842
|
ArtifactEvent: {
|
|
@@ -1801,10 +1847,10 @@ interface components {
|
|
|
1801
1847
|
t?: number | null;
|
|
1802
1848
|
/**
|
|
1803
1849
|
* Type
|
|
1804
|
-
* @default artifact
|
|
1850
|
+
* @default arbi.artifact
|
|
1805
1851
|
* @constant
|
|
1806
1852
|
*/
|
|
1807
|
-
type: 'artifact';
|
|
1853
|
+
type: 'arbi.artifact';
|
|
1808
1854
|
/**
|
|
1809
1855
|
* Doc Ext Id
|
|
1810
1856
|
* @description Document external ID (artifacts are documents)
|
|
@@ -1922,6 +1968,41 @@ interface components {
|
|
|
1922
1968
|
/** Workspaces Updated */
|
|
1923
1969
|
workspaces_updated: number;
|
|
1924
1970
|
};
|
|
1971
|
+
/**
|
|
1972
|
+
* ChatCompletionRequest
|
|
1973
|
+
* @description OpenAI-compatible chat completion request.
|
|
1974
|
+
*/
|
|
1975
|
+
ChatCompletionRequest: {
|
|
1976
|
+
/** Model */
|
|
1977
|
+
model: string;
|
|
1978
|
+
/** Messages */
|
|
1979
|
+
messages: {
|
|
1980
|
+
[key: string]: unknown;
|
|
1981
|
+
}[];
|
|
1982
|
+
/**
|
|
1983
|
+
* Stream
|
|
1984
|
+
* @default true
|
|
1985
|
+
*/
|
|
1986
|
+
stream: boolean;
|
|
1987
|
+
/** Temperature */
|
|
1988
|
+
temperature?: number | null;
|
|
1989
|
+
/** Max Tokens */
|
|
1990
|
+
max_tokens?: number | null;
|
|
1991
|
+
/** Tools */
|
|
1992
|
+
tools?: {
|
|
1993
|
+
[key: string]: unknown;
|
|
1994
|
+
}[] | null;
|
|
1995
|
+
/** Tool Choice */
|
|
1996
|
+
tool_choice?: string | {
|
|
1997
|
+
[key: string]: unknown;
|
|
1998
|
+
} | null;
|
|
1999
|
+
/** Response Format */
|
|
2000
|
+
response_format?: {
|
|
2001
|
+
[key: string]: unknown;
|
|
2002
|
+
} | null;
|
|
2003
|
+
} & {
|
|
2004
|
+
[key: string]: unknown;
|
|
2005
|
+
};
|
|
1925
2006
|
/** Chunk */
|
|
1926
2007
|
Chunk: {
|
|
1927
2008
|
metadata: components['schemas']['ChunkMetadata'];
|
|
@@ -2208,6 +2289,11 @@ interface components {
|
|
|
2208
2289
|
CopyRequest: {
|
|
2209
2290
|
/** Target Workspace Ext Id */
|
|
2210
2291
|
target_workspace_ext_id: string;
|
|
2292
|
+
/**
|
|
2293
|
+
* Target Workspace Key
|
|
2294
|
+
* @description SealedBox-encrypted target workspace key (same format as WorkspaceOpenRequest.workspace_key)
|
|
2295
|
+
*/
|
|
2296
|
+
target_workspace_key: string;
|
|
2211
2297
|
/**
|
|
2212
2298
|
* Items
|
|
2213
2299
|
* @description List of document external IDs to copy (e.g., ['doc-a1b2c3d4', 'doc-e5f6g7h8'])
|
|
@@ -2271,8 +2357,6 @@ interface components {
|
|
|
2271
2357
|
/** Instruction */
|
|
2272
2358
|
instruction?: string | null;
|
|
2273
2359
|
tag_type?: components['schemas']['TagFormat'];
|
|
2274
|
-
/** Workspace Ext Id */
|
|
2275
|
-
workspace_ext_id: string;
|
|
2276
2360
|
/** Shared */
|
|
2277
2361
|
shared?: boolean | null;
|
|
2278
2362
|
/** Parent Ext Id */
|
|
@@ -2317,10 +2401,13 @@ interface components {
|
|
|
2317
2401
|
/** Detail */
|
|
2318
2402
|
detail: string;
|
|
2319
2403
|
};
|
|
2320
|
-
/**
|
|
2321
|
-
|
|
2322
|
-
|
|
2323
|
-
|
|
2404
|
+
/**
|
|
2405
|
+
* DeleteWorkspacesRequest
|
|
2406
|
+
* @description Delete one or more workspaces by external ID.
|
|
2407
|
+
*/
|
|
2408
|
+
DeleteWorkspacesRequest: {
|
|
2409
|
+
/** External Ids */
|
|
2410
|
+
external_ids: string[];
|
|
2324
2411
|
};
|
|
2325
2412
|
/**
|
|
2326
2413
|
* DocMetadata
|
|
@@ -2588,29 +2675,10 @@ interface components {
|
|
|
2588
2675
|
QUERY_PREFIX: string;
|
|
2589
2676
|
};
|
|
2590
2677
|
/**
|
|
2591
|
-
*
|
|
2592
|
-
* @description
|
|
2678
|
+
* ErrorMessage
|
|
2679
|
+
* @description Sent when server fails to process a client message.
|
|
2593
2680
|
*/
|
|
2594
|
-
|
|
2595
|
-
/**
|
|
2596
|
-
* T
|
|
2597
|
-
* @description Seconds elapsed since stream start.
|
|
2598
|
-
*/
|
|
2599
|
-
t?: number | null;
|
|
2600
|
-
/**
|
|
2601
|
-
* Type
|
|
2602
|
-
* @default error
|
|
2603
|
-
* @constant
|
|
2604
|
-
*/
|
|
2605
|
-
type: 'error';
|
|
2606
|
-
/** Message */
|
|
2607
|
-
message: string;
|
|
2608
|
-
};
|
|
2609
|
-
/**
|
|
2610
|
-
* ErrorMessage
|
|
2611
|
-
* @description Sent when server fails to process a client message.
|
|
2612
|
-
*/
|
|
2613
|
-
ErrorMessage: {
|
|
2681
|
+
ErrorMessage: {
|
|
2614
2682
|
/**
|
|
2615
2683
|
* Type
|
|
2616
2684
|
* @default error
|
|
@@ -2660,6 +2728,63 @@ interface components {
|
|
|
2660
2728
|
*/
|
|
2661
2729
|
MAX_CHAR_SIZE_TO_ANSWER: number;
|
|
2662
2730
|
};
|
|
2731
|
+
/**
|
|
2732
|
+
* FileDeleteResponse
|
|
2733
|
+
* @description OpenAI-compatible file deletion response.
|
|
2734
|
+
*/
|
|
2735
|
+
FileDeleteResponse: {
|
|
2736
|
+
/** Id */
|
|
2737
|
+
id: string;
|
|
2738
|
+
/**
|
|
2739
|
+
* Object
|
|
2740
|
+
* @default file
|
|
2741
|
+
*/
|
|
2742
|
+
object: string;
|
|
2743
|
+
/**
|
|
2744
|
+
* Deleted
|
|
2745
|
+
* @default true
|
|
2746
|
+
*/
|
|
2747
|
+
deleted: boolean;
|
|
2748
|
+
};
|
|
2749
|
+
/**
|
|
2750
|
+
* FileListResponse
|
|
2751
|
+
* @description OpenAI-compatible file list response.
|
|
2752
|
+
*/
|
|
2753
|
+
FileListResponse: {
|
|
2754
|
+
/**
|
|
2755
|
+
* Object
|
|
2756
|
+
* @default list
|
|
2757
|
+
*/
|
|
2758
|
+
object: string;
|
|
2759
|
+
/** Data */
|
|
2760
|
+
data: components['schemas']['FileObject'][];
|
|
2761
|
+
};
|
|
2762
|
+
/**
|
|
2763
|
+
* FileObject
|
|
2764
|
+
* @description OpenAI-compatible file object response.
|
|
2765
|
+
*/
|
|
2766
|
+
FileObject: {
|
|
2767
|
+
/** Id */
|
|
2768
|
+
id: string;
|
|
2769
|
+
/**
|
|
2770
|
+
* Object
|
|
2771
|
+
* @default file
|
|
2772
|
+
*/
|
|
2773
|
+
object: string;
|
|
2774
|
+
/** Bytes */
|
|
2775
|
+
bytes?: number | null;
|
|
2776
|
+
/** Created At */
|
|
2777
|
+
created_at: number;
|
|
2778
|
+
/** Filename */
|
|
2779
|
+
filename?: string | null;
|
|
2780
|
+
/**
|
|
2781
|
+
* Purpose
|
|
2782
|
+
* @default assistants
|
|
2783
|
+
*/
|
|
2784
|
+
purpose: string;
|
|
2785
|
+
/** Status */
|
|
2786
|
+
status: string;
|
|
2787
|
+
};
|
|
2663
2788
|
/**
|
|
2664
2789
|
* GenerateAnnotationsRequest
|
|
2665
2790
|
* @description Request to generate AI annotations for documents using tag instructions.
|
|
@@ -2880,18 +3005,34 @@ interface components {
|
|
|
2880
3005
|
};
|
|
2881
3006
|
/** MessageInput */
|
|
2882
3007
|
MessageInput: {
|
|
2883
|
-
/**
|
|
2884
|
-
|
|
3008
|
+
/** Input */
|
|
3009
|
+
input: string;
|
|
2885
3010
|
/** Tools */
|
|
2886
3011
|
tools?: {
|
|
2887
3012
|
[key: string]: components['schemas']['ModelCitationTool'] | components['schemas']['RetrievalChunkTool'] | components['schemas']['RetrievalFullContextTool'] | components['schemas']['RetrievalTOCTool'] | components['schemas']['TraceTool'] | components['schemas']['CompactionTool'];
|
|
2888
3013
|
};
|
|
2889
|
-
/**
|
|
3014
|
+
/**
|
|
3015
|
+
* Workspace Ext Id
|
|
3016
|
+
* @default
|
|
3017
|
+
*/
|
|
2890
3018
|
workspace_ext_id: string;
|
|
2891
|
-
/**
|
|
2892
|
-
|
|
2893
|
-
/**
|
|
2894
|
-
|
|
3019
|
+
/** Previous Response Id */
|
|
3020
|
+
previous_response_id?: string | null;
|
|
3021
|
+
/** Model */
|
|
3022
|
+
model?: string | null;
|
|
3023
|
+
/**
|
|
3024
|
+
* Stream
|
|
3025
|
+
* @default true
|
|
3026
|
+
*/
|
|
3027
|
+
stream: boolean;
|
|
3028
|
+
/** Instructions */
|
|
3029
|
+
instructions?: string | null;
|
|
3030
|
+
/** Max Output Tokens */
|
|
3031
|
+
max_output_tokens?: number | null;
|
|
3032
|
+
/** Temperature */
|
|
3033
|
+
temperature?: number | null;
|
|
3034
|
+
/** Top P */
|
|
3035
|
+
top_p?: number | null;
|
|
2895
3036
|
};
|
|
2896
3037
|
/**
|
|
2897
3038
|
* MessageRecipient
|
|
@@ -3348,19 +3489,6 @@ interface components {
|
|
|
3348
3489
|
/** Picture */
|
|
3349
3490
|
picture?: string | null;
|
|
3350
3491
|
};
|
|
3351
|
-
/** RemoveUserFromConversationRequest */
|
|
3352
|
-
RemoveUserFromConversationRequest: {
|
|
3353
|
-
/** User Ext Id */
|
|
3354
|
-
user_ext_id: string;
|
|
3355
|
-
};
|
|
3356
|
-
/** RemoveUserFromConversationResponse */
|
|
3357
|
-
RemoveUserFromConversationResponse: {
|
|
3358
|
-
/**
|
|
3359
|
-
* Detail
|
|
3360
|
-
* @default User removed from conversation successfully
|
|
3361
|
-
*/
|
|
3362
|
-
detail: string;
|
|
3363
|
-
};
|
|
3364
3492
|
/**
|
|
3365
3493
|
* RemoveWorkspaceUserItem
|
|
3366
3494
|
* @description A user to remove from a workspace.
|
|
@@ -3411,6 +3539,93 @@ interface components {
|
|
|
3411
3539
|
*/
|
|
3412
3540
|
QUERY_INSTRUCTION: string;
|
|
3413
3541
|
};
|
|
3542
|
+
/**
|
|
3543
|
+
* ResponseCompletedEvent
|
|
3544
|
+
* @description OpenAI response.completed: terminal event with full response.
|
|
3545
|
+
*/
|
|
3546
|
+
ResponseCompletedEvent: {
|
|
3547
|
+
/**
|
|
3548
|
+
* T
|
|
3549
|
+
* @description Seconds elapsed since stream start.
|
|
3550
|
+
*/
|
|
3551
|
+
t?: number | null;
|
|
3552
|
+
/**
|
|
3553
|
+
* Type
|
|
3554
|
+
* @default response.completed
|
|
3555
|
+
* @constant
|
|
3556
|
+
*/
|
|
3557
|
+
type: 'response.completed';
|
|
3558
|
+
/** Response */
|
|
3559
|
+
response: {
|
|
3560
|
+
[key: string]: unknown;
|
|
3561
|
+
};
|
|
3562
|
+
};
|
|
3563
|
+
/**
|
|
3564
|
+
* ResponseCreatedEvent
|
|
3565
|
+
* @description OpenAI response.created: provides response ID and initial output structure.
|
|
3566
|
+
*/
|
|
3567
|
+
ResponseCreatedEvent: {
|
|
3568
|
+
/**
|
|
3569
|
+
* T
|
|
3570
|
+
* @description Seconds elapsed since stream start.
|
|
3571
|
+
*/
|
|
3572
|
+
t?: number | null;
|
|
3573
|
+
/**
|
|
3574
|
+
* Type
|
|
3575
|
+
* @default response.created
|
|
3576
|
+
* @constant
|
|
3577
|
+
*/
|
|
3578
|
+
type: 'response.created';
|
|
3579
|
+
/** Response */
|
|
3580
|
+
response: {
|
|
3581
|
+
[key: string]: unknown;
|
|
3582
|
+
};
|
|
3583
|
+
};
|
|
3584
|
+
/**
|
|
3585
|
+
* ResponseFailedEvent
|
|
3586
|
+
* @description OpenAI response.failed: terminal error event.
|
|
3587
|
+
*/
|
|
3588
|
+
ResponseFailedEvent: {
|
|
3589
|
+
/**
|
|
3590
|
+
* T
|
|
3591
|
+
* @description Seconds elapsed since stream start.
|
|
3592
|
+
*/
|
|
3593
|
+
t?: number | null;
|
|
3594
|
+
/**
|
|
3595
|
+
* Type
|
|
3596
|
+
* @default response.failed
|
|
3597
|
+
* @constant
|
|
3598
|
+
*/
|
|
3599
|
+
type: 'response.failed';
|
|
3600
|
+
/** Response */
|
|
3601
|
+
response: {
|
|
3602
|
+
[key: string]: unknown;
|
|
3603
|
+
};
|
|
3604
|
+
};
|
|
3605
|
+
/**
|
|
3606
|
+
* ResponseOutputTextDeltaEvent
|
|
3607
|
+
* @description OpenAI response.output_text.delta: a chunk of the assistant's answer text.
|
|
3608
|
+
*/
|
|
3609
|
+
ResponseOutputTextDeltaEvent: {
|
|
3610
|
+
/**
|
|
3611
|
+
* Type
|
|
3612
|
+
* @default response.output_text.delta
|
|
3613
|
+
* @constant
|
|
3614
|
+
*/
|
|
3615
|
+
type: 'response.output_text.delta';
|
|
3616
|
+
/** Delta */
|
|
3617
|
+
delta: string;
|
|
3618
|
+
/**
|
|
3619
|
+
* Output Index
|
|
3620
|
+
* @default 0
|
|
3621
|
+
*/
|
|
3622
|
+
output_index: number;
|
|
3623
|
+
/**
|
|
3624
|
+
* Content Index
|
|
3625
|
+
* @default 0
|
|
3626
|
+
*/
|
|
3627
|
+
content_index: number;
|
|
3628
|
+
};
|
|
3414
3629
|
/** RetrievalChunkTool */
|
|
3415
3630
|
RetrievalChunkTool: {
|
|
3416
3631
|
/**
|
|
@@ -3642,12 +3857,13 @@ interface components {
|
|
|
3642
3857
|
* schema components matter.
|
|
3643
3858
|
*/
|
|
3644
3859
|
SSESchemas: {
|
|
3645
|
-
|
|
3860
|
+
response_created?: components['schemas']['ResponseCreatedEvent'] | null;
|
|
3646
3861
|
agent_step?: components['schemas']['AgentStepEvent'] | null;
|
|
3647
3862
|
user_input_request?: components['schemas']['UserInputRequestEvent'] | null;
|
|
3648
|
-
|
|
3863
|
+
response_output_text_delta?: components['schemas']['ResponseOutputTextDeltaEvent'] | null;
|
|
3864
|
+
response_completed?: components['schemas']['ResponseCompletedEvent'] | null;
|
|
3865
|
+
response_failed?: components['schemas']['ResponseFailedEvent'] | null;
|
|
3649
3866
|
artifact?: components['schemas']['ArtifactEvent'] | null;
|
|
3650
|
-
error?: components['schemas']['ErrorEvent'] | null;
|
|
3651
3867
|
};
|
|
3652
3868
|
/** SSOSendVerificationEmailRequest */
|
|
3653
3869
|
SSOSendVerificationEmailRequest: {
|
|
@@ -3741,25 +3957,6 @@ interface components {
|
|
|
3741
3957
|
*/
|
|
3742
3958
|
detail: string;
|
|
3743
3959
|
};
|
|
3744
|
-
/**
|
|
3745
|
-
* StreamStartEvent
|
|
3746
|
-
* @description Provides the assistant message ID so frontend can set up the response container.
|
|
3747
|
-
*/
|
|
3748
|
-
StreamStartEvent: {
|
|
3749
|
-
/**
|
|
3750
|
-
* T
|
|
3751
|
-
* @description Seconds elapsed since stream start.
|
|
3752
|
-
*/
|
|
3753
|
-
t?: number | null;
|
|
3754
|
-
/**
|
|
3755
|
-
* Type
|
|
3756
|
-
* @default stream_start
|
|
3757
|
-
* @constant
|
|
3758
|
-
*/
|
|
3759
|
-
type: 'stream_start';
|
|
3760
|
-
/** Assistant Message Ext Id */
|
|
3761
|
-
assistant_message_ext_id: string;
|
|
3762
|
-
};
|
|
3763
3960
|
/**
|
|
3764
3961
|
* SubscriptionInfo
|
|
3765
3962
|
* @description Subscription info exposed to frontend in user settings.
|
|
@@ -4039,25 +4236,6 @@ interface components {
|
|
|
4039
4236
|
*/
|
|
4040
4237
|
MAX_TOKENS: number;
|
|
4041
4238
|
};
|
|
4042
|
-
/**
|
|
4043
|
-
* TokenEvent
|
|
4044
|
-
* @description A chunk of the assistant's answer text.
|
|
4045
|
-
*/
|
|
4046
|
-
TokenEvent: {
|
|
4047
|
-
/**
|
|
4048
|
-
* T
|
|
4049
|
-
* @description Seconds elapsed since stream start.
|
|
4050
|
-
*/
|
|
4051
|
-
t?: number | null;
|
|
4052
|
-
/**
|
|
4053
|
-
* Type
|
|
4054
|
-
* @default token
|
|
4055
|
-
* @constant
|
|
4056
|
-
*/
|
|
4057
|
-
type: 'token';
|
|
4058
|
-
/** Content */
|
|
4059
|
-
content: string;
|
|
4060
|
-
};
|
|
4061
4239
|
/**
|
|
4062
4240
|
* TraceTool
|
|
4063
4241
|
* @description Execution trace tool that captures the full execution history of a request.
|
|
@@ -4185,7 +4363,7 @@ interface components {
|
|
|
4185
4363
|
* using the assistant_message_ext_id from the stream_start event.
|
|
4186
4364
|
*
|
|
4187
4365
|
* Examples:
|
|
4188
|
-
* {"type": "user_input_request",
|
|
4366
|
+
* {"type": "arbi.user_input_request",
|
|
4189
4367
|
* "question": "Which clause should I focus on?",
|
|
4190
4368
|
* "options": ["Clause 5 - Force Majeure", "Clause 12 - Liability", "Other"],
|
|
4191
4369
|
* "timeout_seconds": 300}
|
|
@@ -4198,10 +4376,10 @@ interface components {
|
|
|
4198
4376
|
t?: number | null;
|
|
4199
4377
|
/**
|
|
4200
4378
|
* Type
|
|
4201
|
-
* @default user_input_request
|
|
4379
|
+
* @default arbi.user_input_request
|
|
4202
4380
|
* @constant
|
|
4203
4381
|
*/
|
|
4204
|
-
type: 'user_input_request';
|
|
4382
|
+
type: 'arbi.user_input_request';
|
|
4205
4383
|
/**
|
|
4206
4384
|
* Question
|
|
4207
4385
|
* @description The question to display to the user
|
|
@@ -4460,6 +4638,29 @@ interface components {
|
|
|
4460
4638
|
*/
|
|
4461
4639
|
is_public: boolean;
|
|
4462
4640
|
};
|
|
4641
|
+
/**
|
|
4642
|
+
* WorkspaceOpenRequest
|
|
4643
|
+
* @description Request to open a workspace and get a workspace-scoped JWT.
|
|
4644
|
+
*/
|
|
4645
|
+
WorkspaceOpenRequest: {
|
|
4646
|
+
/** Workspace Key */
|
|
4647
|
+
workspace_key: string;
|
|
4648
|
+
};
|
|
4649
|
+
/**
|
|
4650
|
+
* WorkspaceOpenResponse
|
|
4651
|
+
* @description Response from opening a workspace — includes workspace-scoped JWT and workspace data.
|
|
4652
|
+
*/
|
|
4653
|
+
WorkspaceOpenResponse: {
|
|
4654
|
+
/** Access Token */
|
|
4655
|
+
access_token: string;
|
|
4656
|
+
workspace: components['schemas']['WorkspaceResponse'];
|
|
4657
|
+
/** Conversations */
|
|
4658
|
+
conversations: components['schemas']['ConversationResponse'][];
|
|
4659
|
+
/** Documents */
|
|
4660
|
+
documents: unknown[];
|
|
4661
|
+
/** Tags */
|
|
4662
|
+
tags: unknown[];
|
|
4663
|
+
};
|
|
4463
4664
|
/** WorkspaceResponse */
|
|
4464
4665
|
WorkspaceResponse: {
|
|
4465
4666
|
/** External Id */
|
|
@@ -4564,26 +4765,6 @@ interface components {
|
|
|
4564
4765
|
}
|
|
4565
4766
|
type $defs = Record<string, never>;
|
|
4566
4767
|
interface operations {
|
|
4567
|
-
admin_index_api_get: {
|
|
4568
|
-
parameters: {
|
|
4569
|
-
query?: never;
|
|
4570
|
-
header?: never;
|
|
4571
|
-
path?: never;
|
|
4572
|
-
cookie?: never;
|
|
4573
|
-
};
|
|
4574
|
-
requestBody?: never;
|
|
4575
|
-
responses: {
|
|
4576
|
-
/** @description Successful Response */
|
|
4577
|
-
200: {
|
|
4578
|
-
headers: {
|
|
4579
|
-
[name: string]: unknown;
|
|
4580
|
-
};
|
|
4581
|
-
content: {
|
|
4582
|
-
'application/json': unknown;
|
|
4583
|
-
};
|
|
4584
|
-
};
|
|
4585
|
-
};
|
|
4586
|
-
};
|
|
4587
4768
|
verify_email: {
|
|
4588
4769
|
parameters: {
|
|
4589
4770
|
query?: never;
|
|
@@ -4853,7 +5034,7 @@ interface operations {
|
|
|
4853
5034
|
};
|
|
4854
5035
|
};
|
|
4855
5036
|
};
|
|
4856
|
-
|
|
5037
|
+
sso_send_verification_email_v1_user_sso_send_verification_email_post: {
|
|
4857
5038
|
parameters: {
|
|
4858
5039
|
query?: never;
|
|
4859
5040
|
header?: never;
|
|
@@ -5065,7 +5246,7 @@ interface operations {
|
|
|
5065
5246
|
};
|
|
5066
5247
|
};
|
|
5067
5248
|
};
|
|
5068
|
-
|
|
5249
|
+
open_workspace: {
|
|
5069
5250
|
parameters: {
|
|
5070
5251
|
query?: never;
|
|
5071
5252
|
header?: never;
|
|
@@ -5074,7 +5255,11 @@ interface operations {
|
|
|
5074
5255
|
};
|
|
5075
5256
|
cookie?: never;
|
|
5076
5257
|
};
|
|
5077
|
-
requestBody
|
|
5258
|
+
requestBody: {
|
|
5259
|
+
content: {
|
|
5260
|
+
'application/json': components['schemas']['WorkspaceOpenRequest'];
|
|
5261
|
+
};
|
|
5262
|
+
};
|
|
5078
5263
|
responses: {
|
|
5079
5264
|
/** @description Successful Response */
|
|
5080
5265
|
200: {
|
|
@@ -5082,7 +5267,7 @@ interface operations {
|
|
|
5082
5267
|
[name: string]: unknown;
|
|
5083
5268
|
};
|
|
5084
5269
|
content: {
|
|
5085
|
-
'application/json': components['schemas']['
|
|
5270
|
+
'application/json': components['schemas']['WorkspaceOpenResponse'];
|
|
5086
5271
|
};
|
|
5087
5272
|
};
|
|
5088
5273
|
/** @description Validation Error */
|
|
@@ -5096,15 +5281,31 @@ interface operations {
|
|
|
5096
5281
|
};
|
|
5097
5282
|
};
|
|
5098
5283
|
};
|
|
5099
|
-
|
|
5284
|
+
get_workspace_users: {
|
|
5100
5285
|
parameters: {
|
|
5101
5286
|
query?: never;
|
|
5102
|
-
header?:
|
|
5103
|
-
|
|
5104
|
-
|
|
5105
|
-
|
|
5106
|
-
|
|
5287
|
+
header?: never;
|
|
5288
|
+
path?: never;
|
|
5289
|
+
cookie?: never;
|
|
5290
|
+
};
|
|
5291
|
+
requestBody?: never;
|
|
5292
|
+
responses: {
|
|
5293
|
+
/** @description Successful Response */
|
|
5294
|
+
200: {
|
|
5295
|
+
headers: {
|
|
5296
|
+
[name: string]: unknown;
|
|
5297
|
+
};
|
|
5298
|
+
content: {
|
|
5299
|
+
'application/json': components['schemas']['WorkspaceUserResponse'][];
|
|
5300
|
+
};
|
|
5107
5301
|
};
|
|
5302
|
+
};
|
|
5303
|
+
};
|
|
5304
|
+
add_workspace_users: {
|
|
5305
|
+
parameters: {
|
|
5306
|
+
query?: never;
|
|
5307
|
+
header?: never;
|
|
5308
|
+
path?: never;
|
|
5108
5309
|
cookie?: never;
|
|
5109
5310
|
};
|
|
5110
5311
|
requestBody: {
|
|
@@ -5137,9 +5338,7 @@ interface operations {
|
|
|
5137
5338
|
parameters: {
|
|
5138
5339
|
query?: never;
|
|
5139
5340
|
header?: never;
|
|
5140
|
-
path
|
|
5141
|
-
workspace_ext_id: string;
|
|
5142
|
-
};
|
|
5341
|
+
path?: never;
|
|
5143
5342
|
cookie?: never;
|
|
5144
5343
|
};
|
|
5145
5344
|
requestBody: {
|
|
@@ -5170,9 +5369,7 @@ interface operations {
|
|
|
5170
5369
|
parameters: {
|
|
5171
5370
|
query?: never;
|
|
5172
5371
|
header?: never;
|
|
5173
|
-
path
|
|
5174
|
-
workspace_ext_id: string;
|
|
5175
|
-
};
|
|
5372
|
+
path?: never;
|
|
5176
5373
|
cookie?: never;
|
|
5177
5374
|
};
|
|
5178
5375
|
requestBody: {
|
|
@@ -5204,13 +5401,8 @@ interface operations {
|
|
|
5204
5401
|
copy_workspace_data: {
|
|
5205
5402
|
parameters: {
|
|
5206
5403
|
query?: never;
|
|
5207
|
-
header?:
|
|
5208
|
-
|
|
5209
|
-
'target-workspace-key'?: string;
|
|
5210
|
-
};
|
|
5211
|
-
path: {
|
|
5212
|
-
workspace_ext_id: string;
|
|
5213
|
-
};
|
|
5404
|
+
header?: never;
|
|
5405
|
+
path?: never;
|
|
5214
5406
|
cookie?: never;
|
|
5215
5407
|
};
|
|
5216
5408
|
requestBody: {
|
|
@@ -5239,27 +5431,25 @@ interface operations {
|
|
|
5239
5431
|
};
|
|
5240
5432
|
};
|
|
5241
5433
|
};
|
|
5242
|
-
|
|
5434
|
+
delete_workspaces: {
|
|
5243
5435
|
parameters: {
|
|
5244
5436
|
query?: never;
|
|
5245
|
-
header?:
|
|
5246
|
-
|
|
5247
|
-
};
|
|
5248
|
-
path: {
|
|
5249
|
-
workspace_ext_id: string;
|
|
5250
|
-
};
|
|
5437
|
+
header?: never;
|
|
5438
|
+
path?: never;
|
|
5251
5439
|
cookie?: never;
|
|
5252
5440
|
};
|
|
5253
|
-
requestBody
|
|
5441
|
+
requestBody: {
|
|
5442
|
+
content: {
|
|
5443
|
+
'application/json': components['schemas']['DeleteWorkspacesRequest'];
|
|
5444
|
+
};
|
|
5445
|
+
};
|
|
5254
5446
|
responses: {
|
|
5255
5447
|
/** @description Successful Response */
|
|
5256
|
-
|
|
5448
|
+
204: {
|
|
5257
5449
|
headers: {
|
|
5258
5450
|
[name: string]: unknown;
|
|
5259
5451
|
};
|
|
5260
|
-
content
|
|
5261
|
-
'application/json': components['schemas']['ConversationResponse'][];
|
|
5262
|
-
};
|
|
5452
|
+
content?: never;
|
|
5263
5453
|
};
|
|
5264
5454
|
/** @description Validation Error */
|
|
5265
5455
|
422: {
|
|
@@ -5272,18 +5462,18 @@ interface operations {
|
|
|
5272
5462
|
};
|
|
5273
5463
|
};
|
|
5274
5464
|
};
|
|
5275
|
-
|
|
5465
|
+
update_workspace: {
|
|
5276
5466
|
parameters: {
|
|
5277
5467
|
query?: never;
|
|
5278
|
-
header?:
|
|
5279
|
-
|
|
5280
|
-
};
|
|
5281
|
-
path: {
|
|
5282
|
-
workspace_ext_id: string;
|
|
5283
|
-
};
|
|
5468
|
+
header?: never;
|
|
5469
|
+
path?: never;
|
|
5284
5470
|
cookie?: never;
|
|
5285
5471
|
};
|
|
5286
|
-
requestBody
|
|
5472
|
+
requestBody: {
|
|
5473
|
+
content: {
|
|
5474
|
+
'application/json': components['schemas']['WorkspaceUpdateRequest'];
|
|
5475
|
+
};
|
|
5476
|
+
};
|
|
5287
5477
|
responses: {
|
|
5288
5478
|
/** @description Successful Response */
|
|
5289
5479
|
200: {
|
|
@@ -5291,7 +5481,7 @@ interface operations {
|
|
|
5291
5481
|
[name: string]: unknown;
|
|
5292
5482
|
};
|
|
5293
5483
|
content: {
|
|
5294
|
-
'application/json': components['schemas']['
|
|
5484
|
+
'application/json': components['schemas']['WorkspaceResponse'];
|
|
5295
5485
|
};
|
|
5296
5486
|
};
|
|
5297
5487
|
/** @description Validation Error */
|
|
@@ -5305,46 +5495,11 @@ interface operations {
|
|
|
5305
5495
|
};
|
|
5306
5496
|
};
|
|
5307
5497
|
};
|
|
5308
|
-
|
|
5309
|
-
parameters: {
|
|
5310
|
-
query?: never;
|
|
5311
|
-
header?: {
|
|
5312
|
-
'workspace-key'?: string;
|
|
5313
|
-
};
|
|
5314
|
-
path: {
|
|
5315
|
-
workspace_ext_id: string;
|
|
5316
|
-
};
|
|
5317
|
-
cookie?: never;
|
|
5318
|
-
};
|
|
5319
|
-
requestBody?: never;
|
|
5320
|
-
responses: {
|
|
5321
|
-
/** @description Successful Response */
|
|
5322
|
-
200: {
|
|
5323
|
-
headers: {
|
|
5324
|
-
[name: string]: unknown;
|
|
5325
|
-
};
|
|
5326
|
-
content: {
|
|
5327
|
-
'application/json': components['schemas']['TagResponse'][];
|
|
5328
|
-
};
|
|
5329
|
-
};
|
|
5330
|
-
/** @description Validation Error */
|
|
5331
|
-
422: {
|
|
5332
|
-
headers: {
|
|
5333
|
-
[name: string]: unknown;
|
|
5334
|
-
};
|
|
5335
|
-
content: {
|
|
5336
|
-
'application/json': components['schemas']['HTTPValidationError'];
|
|
5337
|
-
};
|
|
5338
|
-
};
|
|
5339
|
-
};
|
|
5340
|
-
};
|
|
5341
|
-
delete_workspace: {
|
|
5498
|
+
list_documents: {
|
|
5342
5499
|
parameters: {
|
|
5343
5500
|
query?: never;
|
|
5344
5501
|
header?: never;
|
|
5345
|
-
path
|
|
5346
|
-
workspace_ext_id: string;
|
|
5347
|
-
};
|
|
5502
|
+
path?: never;
|
|
5348
5503
|
cookie?: never;
|
|
5349
5504
|
};
|
|
5350
5505
|
requestBody?: never;
|
|
@@ -5355,53 +5510,7 @@ interface operations {
|
|
|
5355
5510
|
[name: string]: unknown;
|
|
5356
5511
|
};
|
|
5357
5512
|
content: {
|
|
5358
|
-
'application/json': components['schemas']['
|
|
5359
|
-
};
|
|
5360
|
-
};
|
|
5361
|
-
/** @description Validation Error */
|
|
5362
|
-
422: {
|
|
5363
|
-
headers: {
|
|
5364
|
-
[name: string]: unknown;
|
|
5365
|
-
};
|
|
5366
|
-
content: {
|
|
5367
|
-
'application/json': components['schemas']['HTTPValidationError'];
|
|
5368
|
-
};
|
|
5369
|
-
};
|
|
5370
|
-
};
|
|
5371
|
-
};
|
|
5372
|
-
update_workspace: {
|
|
5373
|
-
parameters: {
|
|
5374
|
-
query?: never;
|
|
5375
|
-
header?: {
|
|
5376
|
-
'workspace-key'?: string;
|
|
5377
|
-
};
|
|
5378
|
-
path: {
|
|
5379
|
-
workspace_ext_id: string;
|
|
5380
|
-
};
|
|
5381
|
-
cookie?: never;
|
|
5382
|
-
};
|
|
5383
|
-
requestBody: {
|
|
5384
|
-
content: {
|
|
5385
|
-
'application/json': components['schemas']['WorkspaceUpdateRequest'];
|
|
5386
|
-
};
|
|
5387
|
-
};
|
|
5388
|
-
responses: {
|
|
5389
|
-
/** @description Successful Response */
|
|
5390
|
-
200: {
|
|
5391
|
-
headers: {
|
|
5392
|
-
[name: string]: unknown;
|
|
5393
|
-
};
|
|
5394
|
-
content: {
|
|
5395
|
-
'application/json': components['schemas']['WorkspaceResponse'];
|
|
5396
|
-
};
|
|
5397
|
-
};
|
|
5398
|
-
/** @description Validation Error */
|
|
5399
|
-
422: {
|
|
5400
|
-
headers: {
|
|
5401
|
-
[name: string]: unknown;
|
|
5402
|
-
};
|
|
5403
|
-
content: {
|
|
5404
|
-
'application/json': components['schemas']['HTTPValidationError'];
|
|
5513
|
+
'application/json': components['schemas']['DocResponse'][];
|
|
5405
5514
|
};
|
|
5406
5515
|
};
|
|
5407
5516
|
};
|
|
@@ -5411,9 +5520,7 @@ interface operations {
|
|
|
5411
5520
|
query: {
|
|
5412
5521
|
external_ids: string[];
|
|
5413
5522
|
};
|
|
5414
|
-
header?:
|
|
5415
|
-
'workspace-key'?: string;
|
|
5416
|
-
};
|
|
5523
|
+
header?: never;
|
|
5417
5524
|
path?: never;
|
|
5418
5525
|
cookie?: never;
|
|
5419
5526
|
};
|
|
@@ -5473,9 +5580,7 @@ interface operations {
|
|
|
5473
5580
|
update_documents: {
|
|
5474
5581
|
parameters: {
|
|
5475
5582
|
query?: never;
|
|
5476
|
-
header?:
|
|
5477
|
-
'workspace-key'?: string;
|
|
5478
|
-
};
|
|
5583
|
+
header?: never;
|
|
5479
5584
|
path?: never;
|
|
5480
5585
|
cookie?: never;
|
|
5481
5586
|
};
|
|
@@ -5508,9 +5613,7 @@ interface operations {
|
|
|
5508
5613
|
create_doctags: {
|
|
5509
5614
|
parameters: {
|
|
5510
5615
|
query?: never;
|
|
5511
|
-
header?:
|
|
5512
|
-
'workspace-key'?: string;
|
|
5513
|
-
};
|
|
5616
|
+
header?: never;
|
|
5514
5617
|
path?: never;
|
|
5515
5618
|
cookie?: never;
|
|
5516
5619
|
};
|
|
@@ -5574,9 +5677,7 @@ interface operations {
|
|
|
5574
5677
|
update_doctag: {
|
|
5575
5678
|
parameters: {
|
|
5576
5679
|
query?: never;
|
|
5577
|
-
header?:
|
|
5578
|
-
'workspace-key'?: string;
|
|
5579
|
-
};
|
|
5680
|
+
header?: never;
|
|
5580
5681
|
path?: never;
|
|
5581
5682
|
cookie?: never;
|
|
5582
5683
|
};
|
|
@@ -5608,8 +5709,7 @@ interface operations {
|
|
|
5608
5709
|
};
|
|
5609
5710
|
upload_documents: {
|
|
5610
5711
|
parameters: {
|
|
5611
|
-
query
|
|
5612
|
-
workspace_ext_id: string;
|
|
5712
|
+
query?: {
|
|
5613
5713
|
/** @description Whether the document should be shared with workspace members */
|
|
5614
5714
|
shared?: boolean;
|
|
5615
5715
|
/** @description Configuration to use for processing */
|
|
@@ -5621,9 +5721,7 @@ interface operations {
|
|
|
5621
5721
|
/** @description Tag to link the document to */
|
|
5622
5722
|
tag_ext_id?: string | null;
|
|
5623
5723
|
};
|
|
5624
|
-
header?:
|
|
5625
|
-
'workspace-key'?: string;
|
|
5626
|
-
};
|
|
5724
|
+
header?: never;
|
|
5627
5725
|
path?: never;
|
|
5628
5726
|
cookie?: never;
|
|
5629
5727
|
};
|
|
@@ -5661,15 +5759,12 @@ interface operations {
|
|
|
5661
5759
|
query: {
|
|
5662
5760
|
/** @description URLs to download documents from */
|
|
5663
5761
|
urls: string[];
|
|
5664
|
-
workspace_ext_id: string;
|
|
5665
5762
|
/** @description Whether the document should be shared with workspace members */
|
|
5666
5763
|
shared?: boolean;
|
|
5667
5764
|
/** @description Configuration to use for processing */
|
|
5668
5765
|
config_ext_id?: string | null;
|
|
5669
5766
|
};
|
|
5670
|
-
header?:
|
|
5671
|
-
'workspace-key'?: string;
|
|
5672
|
-
};
|
|
5767
|
+
header?: never;
|
|
5673
5768
|
path?: never;
|
|
5674
5769
|
cookie?: never;
|
|
5675
5770
|
};
|
|
@@ -5698,9 +5793,7 @@ interface operations {
|
|
|
5698
5793
|
download_document: {
|
|
5699
5794
|
parameters: {
|
|
5700
5795
|
query?: never;
|
|
5701
|
-
header?:
|
|
5702
|
-
'workspace-key'?: string;
|
|
5703
|
-
};
|
|
5796
|
+
header?: never;
|
|
5704
5797
|
path: {
|
|
5705
5798
|
document_ext_id: string;
|
|
5706
5799
|
};
|
|
@@ -5731,9 +5824,7 @@ interface operations {
|
|
|
5731
5824
|
view_document_inline: {
|
|
5732
5825
|
parameters: {
|
|
5733
5826
|
query?: never;
|
|
5734
|
-
header?:
|
|
5735
|
-
'workspace-key'?: string;
|
|
5736
|
-
};
|
|
5827
|
+
header?: never;
|
|
5737
5828
|
path: {
|
|
5738
5829
|
document_ext_id: string;
|
|
5739
5830
|
};
|
|
@@ -5764,9 +5855,7 @@ interface operations {
|
|
|
5764
5855
|
get_parsed_document: {
|
|
5765
5856
|
parameters: {
|
|
5766
5857
|
query?: never;
|
|
5767
|
-
header?:
|
|
5768
|
-
'workspace-key'?: string;
|
|
5769
|
-
};
|
|
5858
|
+
header?: never;
|
|
5770
5859
|
path: {
|
|
5771
5860
|
document_ext_id: string;
|
|
5772
5861
|
stage: components['schemas']['ParsedStage'];
|
|
@@ -5801,9 +5890,7 @@ interface operations {
|
|
|
5801
5890
|
/** @description Configuration to use for LLM */
|
|
5802
5891
|
config_ext_id?: string | null;
|
|
5803
5892
|
};
|
|
5804
|
-
header?:
|
|
5805
|
-
'workspace-key'?: string;
|
|
5806
|
-
};
|
|
5893
|
+
header?: never;
|
|
5807
5894
|
path?: never;
|
|
5808
5895
|
cookie?: never;
|
|
5809
5896
|
};
|
|
@@ -5833,15 +5920,11 @@ interface operations {
|
|
|
5833
5920
|
};
|
|
5834
5921
|
};
|
|
5835
5922
|
};
|
|
5836
|
-
|
|
5923
|
+
list_conversations: {
|
|
5837
5924
|
parameters: {
|
|
5838
5925
|
query?: never;
|
|
5839
|
-
header?:
|
|
5840
|
-
|
|
5841
|
-
};
|
|
5842
|
-
path: {
|
|
5843
|
-
message_ext_id: string;
|
|
5844
|
-
};
|
|
5926
|
+
header?: never;
|
|
5927
|
+
path?: never;
|
|
5845
5928
|
cookie?: never;
|
|
5846
5929
|
};
|
|
5847
5930
|
requestBody?: never;
|
|
@@ -5852,21 +5935,12 @@ interface operations {
|
|
|
5852
5935
|
[name: string]: unknown;
|
|
5853
5936
|
};
|
|
5854
5937
|
content: {
|
|
5855
|
-
'application/json': components['schemas']['
|
|
5856
|
-
};
|
|
5857
|
-
};
|
|
5858
|
-
/** @description Validation Error */
|
|
5859
|
-
422: {
|
|
5860
|
-
headers: {
|
|
5861
|
-
[name: string]: unknown;
|
|
5862
|
-
};
|
|
5863
|
-
content: {
|
|
5864
|
-
'application/json': components['schemas']['HTTPValidationError'];
|
|
5938
|
+
'application/json': components['schemas']['ConversationResponse'][];
|
|
5865
5939
|
};
|
|
5866
5940
|
};
|
|
5867
5941
|
};
|
|
5868
5942
|
};
|
|
5869
|
-
|
|
5943
|
+
get_message_details: {
|
|
5870
5944
|
parameters: {
|
|
5871
5945
|
query?: never;
|
|
5872
5946
|
header?: never;
|
|
@@ -5883,40 +5957,7 @@ interface operations {
|
|
|
5883
5957
|
[name: string]: unknown;
|
|
5884
5958
|
};
|
|
5885
5959
|
content: {
|
|
5886
|
-
'application/json': components['schemas']['
|
|
5887
|
-
};
|
|
5888
|
-
};
|
|
5889
|
-
/** @description Validation Error */
|
|
5890
|
-
422: {
|
|
5891
|
-
headers: {
|
|
5892
|
-
[name: string]: unknown;
|
|
5893
|
-
};
|
|
5894
|
-
content: {
|
|
5895
|
-
'application/json': components['schemas']['HTTPValidationError'];
|
|
5896
|
-
};
|
|
5897
|
-
};
|
|
5898
|
-
};
|
|
5899
|
-
};
|
|
5900
|
-
get_conversation_threads: {
|
|
5901
|
-
parameters: {
|
|
5902
|
-
query?: never;
|
|
5903
|
-
header?: {
|
|
5904
|
-
'workspace-key'?: string;
|
|
5905
|
-
};
|
|
5906
|
-
path: {
|
|
5907
|
-
conversation_ext_id: string;
|
|
5908
|
-
};
|
|
5909
|
-
cookie?: never;
|
|
5910
|
-
};
|
|
5911
|
-
requestBody?: never;
|
|
5912
|
-
responses: {
|
|
5913
|
-
/** @description Successful Response */
|
|
5914
|
-
200: {
|
|
5915
|
-
headers: {
|
|
5916
|
-
[name: string]: unknown;
|
|
5917
|
-
};
|
|
5918
|
-
content: {
|
|
5919
|
-
'application/json': components['schemas']['ThreadsResponse'];
|
|
5960
|
+
'application/json': components['schemas']['MessageResponse'];
|
|
5920
5961
|
};
|
|
5921
5962
|
};
|
|
5922
5963
|
/** @description Validation Error */
|
|
@@ -5930,12 +5971,12 @@ interface operations {
|
|
|
5930
5971
|
};
|
|
5931
5972
|
};
|
|
5932
5973
|
};
|
|
5933
|
-
|
|
5974
|
+
delete_message: {
|
|
5934
5975
|
parameters: {
|
|
5935
5976
|
query?: never;
|
|
5936
5977
|
header?: never;
|
|
5937
5978
|
path: {
|
|
5938
|
-
|
|
5979
|
+
message_ext_id: string;
|
|
5939
5980
|
};
|
|
5940
5981
|
cookie?: never;
|
|
5941
5982
|
};
|
|
@@ -5947,7 +5988,7 @@ interface operations {
|
|
|
5947
5988
|
[name: string]: unknown;
|
|
5948
5989
|
};
|
|
5949
5990
|
content: {
|
|
5950
|
-
'application/json': components['schemas']['
|
|
5991
|
+
'application/json': components['schemas']['MessageDeleteResponse'];
|
|
5951
5992
|
};
|
|
5952
5993
|
};
|
|
5953
5994
|
/** @description Validation Error */
|
|
@@ -5961,7 +6002,7 @@ interface operations {
|
|
|
5961
6002
|
};
|
|
5962
6003
|
};
|
|
5963
6004
|
};
|
|
5964
|
-
|
|
6005
|
+
get_conversation_threads: {
|
|
5965
6006
|
parameters: {
|
|
5966
6007
|
query?: never;
|
|
5967
6008
|
header?: never;
|
|
@@ -5970,11 +6011,7 @@ interface operations {
|
|
|
5970
6011
|
};
|
|
5971
6012
|
cookie?: never;
|
|
5972
6013
|
};
|
|
5973
|
-
requestBody
|
|
5974
|
-
content: {
|
|
5975
|
-
'application/json': components['schemas']['AddUserToConversationRequest'];
|
|
5976
|
-
};
|
|
5977
|
-
};
|
|
6014
|
+
requestBody?: never;
|
|
5978
6015
|
responses: {
|
|
5979
6016
|
/** @description Successful Response */
|
|
5980
6017
|
200: {
|
|
@@ -5982,7 +6019,7 @@ interface operations {
|
|
|
5982
6019
|
[name: string]: unknown;
|
|
5983
6020
|
};
|
|
5984
6021
|
content: {
|
|
5985
|
-
'application/json': components['schemas']['
|
|
6022
|
+
'application/json': components['schemas']['ThreadsResponse'];
|
|
5986
6023
|
};
|
|
5987
6024
|
};
|
|
5988
6025
|
/** @description Validation Error */
|
|
@@ -5996,7 +6033,7 @@ interface operations {
|
|
|
5996
6033
|
};
|
|
5997
6034
|
};
|
|
5998
6035
|
};
|
|
5999
|
-
|
|
6036
|
+
delete_conversation: {
|
|
6000
6037
|
parameters: {
|
|
6001
6038
|
query?: never;
|
|
6002
6039
|
header?: never;
|
|
@@ -6005,11 +6042,7 @@ interface operations {
|
|
|
6005
6042
|
};
|
|
6006
6043
|
cookie?: never;
|
|
6007
6044
|
};
|
|
6008
|
-
requestBody
|
|
6009
|
-
content: {
|
|
6010
|
-
'application/json': components['schemas']['RemoveUserFromConversationRequest'];
|
|
6011
|
-
};
|
|
6012
|
-
};
|
|
6045
|
+
requestBody?: never;
|
|
6013
6046
|
responses: {
|
|
6014
6047
|
/** @description Successful Response */
|
|
6015
6048
|
200: {
|
|
@@ -6017,7 +6050,7 @@ interface operations {
|
|
|
6017
6050
|
[name: string]: unknown;
|
|
6018
6051
|
};
|
|
6019
6052
|
content: {
|
|
6020
|
-
'application/json': components['schemas']['
|
|
6053
|
+
'application/json': components['schemas']['ConversationDeleteResponse'];
|
|
6021
6054
|
};
|
|
6022
6055
|
};
|
|
6023
6056
|
/** @description Validation Error */
|
|
@@ -6065,9 +6098,7 @@ interface operations {
|
|
|
6065
6098
|
update_conversation_title: {
|
|
6066
6099
|
parameters: {
|
|
6067
6100
|
query?: never;
|
|
6068
|
-
header?:
|
|
6069
|
-
'workspace-key'?: string;
|
|
6070
|
-
};
|
|
6101
|
+
header?: never;
|
|
6071
6102
|
path: {
|
|
6072
6103
|
conversation_ext_id: string;
|
|
6073
6104
|
};
|
|
@@ -6122,9 +6153,7 @@ interface operations {
|
|
|
6122
6153
|
generate: {
|
|
6123
6154
|
parameters: {
|
|
6124
6155
|
query?: never;
|
|
6125
|
-
header?:
|
|
6126
|
-
'workspace-key'?: string;
|
|
6127
|
-
};
|
|
6156
|
+
header?: never;
|
|
6128
6157
|
path?: never;
|
|
6129
6158
|
cookie?: never;
|
|
6130
6159
|
};
|
|
@@ -6190,9 +6219,7 @@ interface operations {
|
|
|
6190
6219
|
retrieve: {
|
|
6191
6220
|
parameters: {
|
|
6192
6221
|
query?: never;
|
|
6193
|
-
header?:
|
|
6194
|
-
'workspace-key'?: string;
|
|
6195
|
-
};
|
|
6222
|
+
header?: never;
|
|
6196
6223
|
path?: never;
|
|
6197
6224
|
cookie?: never;
|
|
6198
6225
|
};
|
|
@@ -6302,12 +6329,30 @@ interface operations {
|
|
|
6302
6329
|
};
|
|
6303
6330
|
};
|
|
6304
6331
|
};
|
|
6305
|
-
|
|
6332
|
+
list_tags: {
|
|
6306
6333
|
parameters: {
|
|
6307
6334
|
query?: never;
|
|
6308
|
-
header?:
|
|
6309
|
-
|
|
6335
|
+
header?: never;
|
|
6336
|
+
path?: never;
|
|
6337
|
+
cookie?: never;
|
|
6338
|
+
};
|
|
6339
|
+
requestBody?: never;
|
|
6340
|
+
responses: {
|
|
6341
|
+
/** @description Successful Response */
|
|
6342
|
+
200: {
|
|
6343
|
+
headers: {
|
|
6344
|
+
[name: string]: unknown;
|
|
6345
|
+
};
|
|
6346
|
+
content: {
|
|
6347
|
+
'application/json': components['schemas']['TagResponse'][];
|
|
6348
|
+
};
|
|
6310
6349
|
};
|
|
6350
|
+
};
|
|
6351
|
+
};
|
|
6352
|
+
create_tag: {
|
|
6353
|
+
parameters: {
|
|
6354
|
+
query?: never;
|
|
6355
|
+
header?: never;
|
|
6311
6356
|
path?: never;
|
|
6312
6357
|
cookie?: never;
|
|
6313
6358
|
};
|
|
@@ -6371,9 +6416,7 @@ interface operations {
|
|
|
6371
6416
|
update_tag: {
|
|
6372
6417
|
parameters: {
|
|
6373
6418
|
query?: never;
|
|
6374
|
-
header?:
|
|
6375
|
-
'workspace-key'?: string;
|
|
6376
|
-
};
|
|
6419
|
+
header?: never;
|
|
6377
6420
|
path: {
|
|
6378
6421
|
tag_ext_id: string;
|
|
6379
6422
|
};
|
|
@@ -6678,6 +6721,196 @@ interface operations {
|
|
|
6678
6721
|
};
|
|
6679
6722
|
};
|
|
6680
6723
|
};
|
|
6724
|
+
list_files: {
|
|
6725
|
+
parameters: {
|
|
6726
|
+
query?: never;
|
|
6727
|
+
header?: never;
|
|
6728
|
+
path?: never;
|
|
6729
|
+
cookie?: never;
|
|
6730
|
+
};
|
|
6731
|
+
requestBody?: never;
|
|
6732
|
+
responses: {
|
|
6733
|
+
/** @description Successful Response */
|
|
6734
|
+
200: {
|
|
6735
|
+
headers: {
|
|
6736
|
+
[name: string]: unknown;
|
|
6737
|
+
};
|
|
6738
|
+
content: {
|
|
6739
|
+
'application/json': components['schemas']['FileListResponse'];
|
|
6740
|
+
};
|
|
6741
|
+
};
|
|
6742
|
+
};
|
|
6743
|
+
};
|
|
6744
|
+
upload_file: {
|
|
6745
|
+
parameters: {
|
|
6746
|
+
query?: {
|
|
6747
|
+
/** @description Intended purpose (always 'assistants') */
|
|
6748
|
+
purpose?: string;
|
|
6749
|
+
};
|
|
6750
|
+
header?: never;
|
|
6751
|
+
path?: never;
|
|
6752
|
+
cookie?: never;
|
|
6753
|
+
};
|
|
6754
|
+
requestBody?: {
|
|
6755
|
+
content: {
|
|
6756
|
+
'multipart/form-data': {
|
|
6757
|
+
/**
|
|
6758
|
+
* Format: binary
|
|
6759
|
+
* @description The file to upload
|
|
6760
|
+
*/
|
|
6761
|
+
file: string;
|
|
6762
|
+
};
|
|
6763
|
+
};
|
|
6764
|
+
};
|
|
6765
|
+
responses: {
|
|
6766
|
+
/** @description Successful Response */
|
|
6767
|
+
201: {
|
|
6768
|
+
headers: {
|
|
6769
|
+
[name: string]: unknown;
|
|
6770
|
+
};
|
|
6771
|
+
content: {
|
|
6772
|
+
'application/json': components['schemas']['FileObject'];
|
|
6773
|
+
};
|
|
6774
|
+
};
|
|
6775
|
+
/** @description Validation Error */
|
|
6776
|
+
422: {
|
|
6777
|
+
headers: {
|
|
6778
|
+
[name: string]: unknown;
|
|
6779
|
+
};
|
|
6780
|
+
content: {
|
|
6781
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
6782
|
+
};
|
|
6783
|
+
};
|
|
6784
|
+
};
|
|
6785
|
+
};
|
|
6786
|
+
get_file: {
|
|
6787
|
+
parameters: {
|
|
6788
|
+
query?: never;
|
|
6789
|
+
header?: never;
|
|
6790
|
+
path: {
|
|
6791
|
+
file_id: string;
|
|
6792
|
+
};
|
|
6793
|
+
cookie?: never;
|
|
6794
|
+
};
|
|
6795
|
+
requestBody?: never;
|
|
6796
|
+
responses: {
|
|
6797
|
+
/** @description Successful Response */
|
|
6798
|
+
200: {
|
|
6799
|
+
headers: {
|
|
6800
|
+
[name: string]: unknown;
|
|
6801
|
+
};
|
|
6802
|
+
content: {
|
|
6803
|
+
'application/json': components['schemas']['FileObject'];
|
|
6804
|
+
};
|
|
6805
|
+
};
|
|
6806
|
+
/** @description Validation Error */
|
|
6807
|
+
422: {
|
|
6808
|
+
headers: {
|
|
6809
|
+
[name: string]: unknown;
|
|
6810
|
+
};
|
|
6811
|
+
content: {
|
|
6812
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
6813
|
+
};
|
|
6814
|
+
};
|
|
6815
|
+
};
|
|
6816
|
+
};
|
|
6817
|
+
delete_file: {
|
|
6818
|
+
parameters: {
|
|
6819
|
+
query?: never;
|
|
6820
|
+
header?: never;
|
|
6821
|
+
path: {
|
|
6822
|
+
file_id: string;
|
|
6823
|
+
};
|
|
6824
|
+
cookie?: never;
|
|
6825
|
+
};
|
|
6826
|
+
requestBody?: never;
|
|
6827
|
+
responses: {
|
|
6828
|
+
/** @description Successful Response */
|
|
6829
|
+
200: {
|
|
6830
|
+
headers: {
|
|
6831
|
+
[name: string]: unknown;
|
|
6832
|
+
};
|
|
6833
|
+
content: {
|
|
6834
|
+
'application/json': components['schemas']['FileDeleteResponse'];
|
|
6835
|
+
};
|
|
6836
|
+
};
|
|
6837
|
+
/** @description Validation Error */
|
|
6838
|
+
422: {
|
|
6839
|
+
headers: {
|
|
6840
|
+
[name: string]: unknown;
|
|
6841
|
+
};
|
|
6842
|
+
content: {
|
|
6843
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
6844
|
+
};
|
|
6845
|
+
};
|
|
6846
|
+
};
|
|
6847
|
+
};
|
|
6848
|
+
chat_completions: {
|
|
6849
|
+
parameters: {
|
|
6850
|
+
query?: never;
|
|
6851
|
+
header?: never;
|
|
6852
|
+
path?: never;
|
|
6853
|
+
cookie?: never;
|
|
6854
|
+
};
|
|
6855
|
+
requestBody: {
|
|
6856
|
+
content: {
|
|
6857
|
+
'application/json': components['schemas']['ChatCompletionRequest'];
|
|
6858
|
+
};
|
|
6859
|
+
};
|
|
6860
|
+
responses: {
|
|
6861
|
+
/** @description Successful Response */
|
|
6862
|
+
200: {
|
|
6863
|
+
headers: {
|
|
6864
|
+
[name: string]: unknown;
|
|
6865
|
+
};
|
|
6866
|
+
content: {
|
|
6867
|
+
'application/json': unknown;
|
|
6868
|
+
};
|
|
6869
|
+
};
|
|
6870
|
+
/** @description Validation Error */
|
|
6871
|
+
422: {
|
|
6872
|
+
headers: {
|
|
6873
|
+
[name: string]: unknown;
|
|
6874
|
+
};
|
|
6875
|
+
content: {
|
|
6876
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
6877
|
+
};
|
|
6878
|
+
};
|
|
6879
|
+
};
|
|
6880
|
+
};
|
|
6881
|
+
query_v1_responses_post: {
|
|
6882
|
+
parameters: {
|
|
6883
|
+
query?: never;
|
|
6884
|
+
header?: never;
|
|
6885
|
+
path?: never;
|
|
6886
|
+
cookie?: never;
|
|
6887
|
+
};
|
|
6888
|
+
requestBody: {
|
|
6889
|
+
content: {
|
|
6890
|
+
'application/json': components['schemas']['MessageInput'];
|
|
6891
|
+
};
|
|
6892
|
+
};
|
|
6893
|
+
responses: {
|
|
6894
|
+
/** @description Successful Response */
|
|
6895
|
+
200: {
|
|
6896
|
+
headers: {
|
|
6897
|
+
[name: string]: unknown;
|
|
6898
|
+
};
|
|
6899
|
+
content: {
|
|
6900
|
+
'application/json': unknown;
|
|
6901
|
+
};
|
|
6902
|
+
};
|
|
6903
|
+
/** @description Validation Error */
|
|
6904
|
+
422: {
|
|
6905
|
+
headers: {
|
|
6906
|
+
[name: string]: unknown;
|
|
6907
|
+
};
|
|
6908
|
+
content: {
|
|
6909
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
6910
|
+
};
|
|
6911
|
+
};
|
|
6912
|
+
};
|
|
6913
|
+
};
|
|
6681
6914
|
}
|
|
6682
6915
|
|
|
6683
6916
|
/**
|
|
@@ -6709,8 +6942,6 @@ interface WorkspaceKeyMiddlewareConfig {
|
|
|
6709
6942
|
type ReloginHandler = () => Promise<string | null>;
|
|
6710
6943
|
interface AutoReloginMiddlewareConfig {
|
|
6711
6944
|
reloginHandler: ReloginHandler;
|
|
6712
|
-
workspaceKeyProvider: WorkspaceKeyProvider;
|
|
6713
|
-
urlConfig: WorkspaceKeyUrlConfig;
|
|
6714
6945
|
/** URL substrings that should never trigger re-login (e.g. the login endpoint itself) */
|
|
6715
6946
|
reloginExcludePatterns?: string[];
|
|
6716
6947
|
onRetryCloneFailed?: () => void;
|
|
@@ -6780,6 +7011,13 @@ interface LoginProvider {
|
|
|
6780
7011
|
interface WorkspaceKeyRefreshProvider {
|
|
6781
7012
|
getWrappedKey(accessToken: string, workspaceId: string): Promise<string | null>;
|
|
6782
7013
|
}
|
|
7014
|
+
/**
|
|
7015
|
+
* Opens a workspace by calling the /open endpoint to get a workspace-scoped JWT.
|
|
7016
|
+
* Returns the new workspace-scoped access token, or null on failure.
|
|
7017
|
+
*/
|
|
7018
|
+
interface WorkspaceOpenProvider {
|
|
7019
|
+
openWorkspace(accessToken: string, workspaceId: string, encryptedWorkspaceKey: string): Promise<string | null>;
|
|
7020
|
+
}
|
|
6783
7021
|
type OnReloginSuccess = (data: {
|
|
6784
7022
|
email: string;
|
|
6785
7023
|
accessToken: string;
|
|
@@ -6793,6 +7031,7 @@ interface ReloginDeps {
|
|
|
6793
7031
|
ssoTokenProvider: SsoTokenProvider | null;
|
|
6794
7032
|
loginProvider: LoginProvider;
|
|
6795
7033
|
workspaceKeyRefreshProvider: WorkspaceKeyRefreshProvider;
|
|
7034
|
+
workspaceOpenProvider?: WorkspaceOpenProvider;
|
|
6796
7035
|
onReloginSuccess?: OnReloginSuccess;
|
|
6797
7036
|
}
|
|
6798
7037
|
|
|
@@ -7187,7 +7426,7 @@ declare function hasSession(): Promise<boolean>;
|
|
|
7187
7426
|
/**
|
|
7188
7427
|
* Registration flow
|
|
7189
7428
|
*
|
|
7190
|
-
* Generates Ed25519 keypair → posts to /
|
|
7429
|
+
* Generates Ed25519 keypair → posts to /v1/user/register
|
|
7191
7430
|
*/
|
|
7192
7431
|
|
|
7193
7432
|
interface RegisterParams {
|
|
@@ -7205,7 +7444,7 @@ interface RegisterResult {
|
|
|
7205
7444
|
/**
|
|
7206
7445
|
* Login flow
|
|
7207
7446
|
*
|
|
7208
|
-
* Generates Ed25519 signature → posts to /
|
|
7447
|
+
* Generates Ed25519 signature → posts to /v1/user/login → saves session
|
|
7209
7448
|
*/
|
|
7210
7449
|
|
|
7211
7450
|
interface LoginParams {
|
|
@@ -7228,7 +7467,7 @@ interface LoginResult {
|
|
|
7228
7467
|
/**
|
|
7229
7468
|
* Change password flow
|
|
7230
7469
|
*
|
|
7231
|
-
* Generates old + new credentials → posts to /
|
|
7470
|
+
* Generates old + new credentials → posts to /v1/user/change_password → updates stored key
|
|
7232
7471
|
*/
|
|
7233
7472
|
|
|
7234
7473
|
interface ChangePasswordParams {
|
|
@@ -7255,6 +7494,7 @@ interface ChangePasswordResult {
|
|
|
7255
7494
|
* Returns an ArbiClient object that SDK consumers interact with.
|
|
7256
7495
|
*/
|
|
7257
7496
|
|
|
7497
|
+
declare const API_PREFIX: "/v1";
|
|
7258
7498
|
interface ArbiClientOptions {
|
|
7259
7499
|
/** Base URL for the ARBI API (e.g. "https://api.mydeployment.com") */
|
|
7260
7500
|
baseUrl: string;
|
|
@@ -7374,8 +7614,8 @@ type WebSocketClientMessage = WsAuthMessage;
|
|
|
7374
7614
|
/**
|
|
7375
7615
|
* Build a WebSocket URL from an HTTP(S) base URL.
|
|
7376
7616
|
*
|
|
7377
|
-
* "https://box-105.arbibox.com" → "wss://box-105.arbibox.com/
|
|
7378
|
-
* "http://localhost:8000" → "ws://localhost:8000/
|
|
7617
|
+
* "https://box-105.arbibox.com" → "wss://box-105.arbibox.com/v1/notifications/ws"
|
|
7618
|
+
* "http://localhost:8000" → "ws://localhost:8000/v1/notifications/ws"
|
|
7379
7619
|
*/
|
|
7380
7620
|
declare function buildWebSocketUrl(baseUrl: string): string;
|
|
7381
7621
|
/**
|
|
@@ -7420,4 +7660,4 @@ declare function isMessageType<T extends WebSocketServerMessage>(msg: WebSocketS
|
|
|
7420
7660
|
*/
|
|
7421
7661
|
declare function createReloginHandler(deps: ReloginDeps): () => Promise<string | null>;
|
|
7422
7662
|
|
|
7423
|
-
export { type $defs, type ArbiClient, type ArbiClientOptions, type AuthStateProvider, type AutoReloginMiddlewareConfig, type BearerAuthMiddlewareConfig, type ChangePasswordParams, type ChangePasswordRequest, type ChangePasswordResult, type CryptoProvider, type KeyPair, type LoginCredentials, type LoginParams, type LoginProvider, type LoginRequest, type LoginResult, type LoginWithKeyParams, type OnReloginSuccess, type PasswordChangeCredentials, type RegisterParams, type RegisterRequest, type RegisterResult, type RegistrationCredentials, type ReloginDeps, type ReloginHandler, type SessionData, type SessionKeys, type SessionManager, type SessionState, type SessionStorageProvider, type SsoTokenProvider, type TokenProvider, type UserKeypairs, type WebSocketClientMessage, type WebSocketServerMessage, type WorkspaceKeyMiddlewareConfig, type WorkspaceKeyProvider, type WorkspaceKeyRefreshProvider, type WorkspaceKeyUrlConfig, type WsAuthMessage, type WsAuthResultMessage, type WsBatchCompleteMessage, type WsConnectionClosedMessage, type WsErrorMessage, type WsNotificationResponse, type WsPresenceUpdateMessage, type WsTaskUpdateMessage, base64Decode, base64Encode, base64ToBytes, buildWebSocketUrl, bytesToBase64, clearAllData, clearSession, type components, computeSharedSecret, createArbiClient, createAuthMessage, createAutoReloginMiddleware, createBearerAuthMiddleware, createReloginHandler, createSessionManager, createWorkspaceKeyHeader, createWorkspaceKeyMiddleware, decryptMessage, decryptMessageWithSharedSecret, deriveEncryptionKeypairFromSigning, derivePublicKey, encryptMessage, encryptMessageWithSharedSecret, generateKeyPairs, generateLoginCredentials, generateLoginCredentialsFromKey, generatePasswordChangeCredentials, generateRecoveryPasswordChangeCredentials, generateRegistrationCredentials, generateUserKeypairs, getSession, hasSession, initSodium, initializeDatabase, isMessageType, needsWorkspaceKey, type operations, parseServerMessage, type paths, saveSession, sealedBoxDecrypt, sealedBoxEncrypt, signMessage, updateSigningPrivateKey, type webhooks };
|
|
7663
|
+
export { type $defs, API_PREFIX, type ArbiClient, type ArbiClientOptions, type AuthStateProvider, type AutoReloginMiddlewareConfig, type BearerAuthMiddlewareConfig, type ChangePasswordParams, type ChangePasswordRequest, type ChangePasswordResult, type CryptoProvider, type KeyPair, type LoginCredentials, type LoginParams, type LoginProvider, type LoginRequest, type LoginResult, type LoginWithKeyParams, type OnReloginSuccess, type PasswordChangeCredentials, type RegisterParams, type RegisterRequest, type RegisterResult, type RegistrationCredentials, type ReloginDeps, type ReloginHandler, type SessionData, type SessionKeys, type SessionManager, type SessionState, type SessionStorageProvider, type SsoTokenProvider, type TokenProvider, type UserKeypairs, type WebSocketClientMessage, type WebSocketServerMessage, type WorkspaceKeyMiddlewareConfig, type WorkspaceKeyProvider, type WorkspaceKeyRefreshProvider, type WorkspaceKeyUrlConfig, type WorkspaceOpenProvider, type WsAuthMessage, type WsAuthResultMessage, type WsBatchCompleteMessage, type WsConnectionClosedMessage, type WsErrorMessage, type WsNotificationResponse, type WsPresenceUpdateMessage, type WsTaskUpdateMessage, base64Decode, base64Encode, base64ToBytes, buildWebSocketUrl, bytesToBase64, clearAllData, clearSession, type components, computeSharedSecret, createArbiClient, createAuthMessage, createAutoReloginMiddleware, createBearerAuthMiddleware, createReloginHandler, createSessionManager, createWorkspaceKeyHeader, createWorkspaceKeyMiddleware, decryptMessage, decryptMessageWithSharedSecret, deriveEncryptionKeypairFromSigning, derivePublicKey, encryptMessage, encryptMessageWithSharedSecret, generateKeyPairs, generateLoginCredentials, generateLoginCredentialsFromKey, generatePasswordChangeCredentials, generateRecoveryPasswordChangeCredentials, generateRegistrationCredentials, generateUserKeypairs, getSession, hasSession, initSodium, initializeDatabase, isMessageType, needsWorkspaceKey, type operations, parseServerMessage, type paths, saveSession, sealedBoxDecrypt, sealedBoxEncrypt, signMessage, updateSigningPrivateKey, type webhooks };
|