-
Notifications
You must be signed in to change notification settings - Fork 178
/
swagger (1) (1) (1).yml
2467 lines (2426 loc) · 93.2 KB
/
swagger (1) (1) (1).yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
tags:
- name: apikey
- name: assistants
- name: chatmessage
- name: chatflows
- name: credentials
- name: document-store
- name: feedback
- name: leads
- name: ping
- name: prediction
- name: tools
- name: upsert-history
- name: variables
- name: vector
paths:
/apikey:
post:
tags:
- apikey
security:
- bearerAuth: []
operationId: createApiKey
summary: Add new api key
description: Add new api key
requestBody:
content:
application/json:
schema:
type: object
properties:
keyName:
type: string
example: 'someKeyName'
required: true
responses:
'200':
description: Api key created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKey'
application/xml:
schema:
$ref: '#/components/schemas/ApiKey'
'400':
description: Invalid keyName provided
'404':
description: Api Key not found
'422':
description: Validation exception
get:
tags:
- apikey
security:
- bearerAuth: []
summary: List all API keys
description: List all API keys
operationId: listApiKey
responses:
'200':
description: A list of API keys
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiKey'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/ApiKey'
'500':
description: Internal error
/apikey/{id}:
put:
tags:
- apikey
security:
- bearerAuth: []
summary: Update API key name
description: Update API key name
operationId: updateApiKey
parameters:
- in: path
name: id
required: true
schema:
type: string
description: Api Key ID
requestBody:
content:
application/json:
schema:
type: object
properties:
keyName:
type: string
example: 'someKeyName'
responses:
'200':
description: Api key updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKey'
application/xml:
schema:
$ref: '#/components/schemas/ApiKey'
'400':
description: The specified ID is invalid
'404':
description: Api Key with the specified ID was not found
'500':
description: Internal error
delete:
tags:
- apikey
security:
- bearerAuth: []
summary: Delete API key
description: Delete API key
operationId: deleteApiKey
parameters:
- in: path
name: id
required: true
schema:
type: string
description: Api Key ID
responses:
'200':
description: Api key deleted successfully
'400':
description: The specified ID is invalid
'404':
description: Api Key with the specified ID was not found
'500':
description: Internal error
/chatmessage/{id}:
get:
tags:
- chatmessage
security:
- bearerAuth: []
operationId: getAllChatMessages
summary: List all chat messages
description: Retrieve all chat messages for a specific chatflow.
parameters:
- in: path
name: id
required: true
schema:
type: string
description: Chatflow ID
- in: query
name: chatType
schema:
type: string
enum: [INTERNAL, EXTERNAL]
description: Filter by chat type
- in: query
name: order
schema:
type: string
enum: [ASC, DESC]
description: Sort order
- in: query
name: chatId
schema:
type: string
description: Filter by chat ID
- in: query
name: memoryType
schema:
type: string
example: Buffer Memory
description: Filter by memory type
- in: query
name: sessionId
schema:
type: string
description: Filter by session ID
- in: query
name: startDate
schema:
type: string
format: date-time
description: Filter by start date
- in: query
name: endDate
schema:
type: string
format: date-time
description: Filter by end date
- in: query
name: feedback
schema:
type: boolean
description: Filter by feedback
- in: query
name: feedbackType
schema:
type: string
enum: [THUMBS_UP, THUMBS_DOWN]
description: Filter by feedback type
responses:
'200':
description: A list of chat messages
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ChatMessage'
'500':
description: Internal error
delete:
tags:
- chatmessage
security:
- bearerAuth: []
operationId: removeAllChatMessages
summary: Delete all chat messages
description: Delete all chat messages for a specific chatflow.
parameters:
- in: path
name: id
required: true
schema:
type: string
description: Chatflow ID
- in: query
name: chatId
schema:
type: string
description: Filter by chat ID
- in: query
name: memoryType
schema:
type: string
example: Buffer Memory
description: Filter by memory type
- in: query
name: sessionId
schema:
type: string
description: Filter by session ID
- in: query
name: chatType
schema:
type: string
enum: [INTERNAL, EXTERNAL]
description: Filter by chat type
responses:
'200':
description: Chat messages deleted successfully
'400':
description: Invalid parameters
'404':
description: Chat messages not found
'500':
description: Internal error
/assistants:
post:
tags:
- assistants
security:
- bearerAuth: []
operationId: createAssistant
summary: Create a new assistant
description: Create a new assistant with the provided details
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Assistant'
required: true
responses:
'200':
description: Assistant created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Assistant'
'400':
description: Invalid input provided
'422':
description: Validation exception
get:
tags:
- assistants
security:
- bearerAuth: []
summary: List all assistants
description: Retrieve a list of all assistants
operationId: listAssistants
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Assistant'
'500':
description: Internal error
/assistants/{id}:
get:
tags:
- assistants
security:
- bearerAuth: []
summary: Get assistant by ID
description: Retrieve a specific assistant by ID
operationId: getAssistantById
parameters:
- in: path
name: id
required: true
schema:
type: string
description: Assistant ID
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Assistant'
'400':
description: The specified ID is invalid
'404':
description: Assistant not found
'500':
description: Internal error
put:
tags:
- assistants
security:
- bearerAuth: []
summary: Update assistant details
description: Update the details of an existing assistant
operationId: updateAssistant
parameters:
- in: path
name: id
required: true
schema:
type: string
description: Assistant ID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Assistant'
responses:
'200':
description: Assistant updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/assistant'
'400':
description: The specified ID is invalid or body is missing
'404':
description: Assistant not found
'500':
description: Internal error
delete:
tags:
- assistants
security:
- bearerAuth: []
summary: Delete an assistant
description: Delete an assistant by ID
operationId: deleteAssistant
parameters:
- in: path
name: id
required: true
schema:
type: string
description: Assistant ID
responses:
'200':
description: Assistant deleted successfully
'400':
description: The specified ID is invalid
'404':
description: Assistant not found
'500':
description: Internal error
/chatflows:
post:
tags:
- chatflows
security:
- bearerAuth: []
operationId: createChatflow
summary: Create a new chatflow
description: Create a new chatflow with the provided details
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Chatflow'
required: true
responses:
'200':
description: Chatflow created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Chatflow'
'400':
description: Invalid input provided
'422':
description: Validation exception
get:
tags:
- chatflows
security:
- bearerAuth: []
summary: List all chatflows
description: Retrieve a list of all chatflows
operationId: listChatflows
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Chatflow'
'500':
description: Internal error
/chatflows/{id}:
get:
tags:
- chatflows
security:
- bearerAuth: []
summary: Get chatflow by ID
description: Retrieve a specific chatflow by ID
operationId: getChatflowById
parameters:
- in: path
name: id
required: true
schema:
type: string
description: Chatflow ID
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Chatflow'
'400':
description: The specified ID is invalid
'404':
description: Chatflow not found
'500':
description: Internal error
put:
tags:
- chatflows
security:
- bearerAuth: []
summary: Update chatflow details
description: Update the details of an existing chatflow
operationId: updateChatflow
parameters:
- in: path
name: id
required: true
schema:
type: string
description: Chatflow ID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Chatflow'
responses:
'200':
description: Chatflow updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Chatflow'
'400':
description: The specified ID is invalid or body is missing
'404':
description: Chatflow not found
'500':
description: Internal error
delete:
tags:
- chatflows
security:
- bearerAuth: []
summary: Delete a chatflow
description: Delete a chatflow by ID
operationId: deleteChatflow
parameters:
- in: path
name: id
required: true
schema:
type: string
description: Chatflow ID
responses:
'200':
description: Chatflow deleted successfully
'400':
description: The specified ID is invalid
'404':
description: Chatflow not found
'500':
description: Internal error
/chatflows/apikey/{apikey}:
get:
tags:
- chatflows
security:
- bearerAuth: []
summary: Get chatflow by API key
description: Retrieve a chatflow using an API key
operationId: getChatflowByApiKey
parameters:
- in: path
name: apikey
required: true
schema:
type: string
description: API key associated with the chatflow
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Chatflow'
'400':
description: The specified API key is invalid
'404':
description: Chatflow not found
'500':
description: Internal error
/credentials:
post:
tags:
- credentials
security:
- bearerAuth: []
operationId: createCredential
summary: Add new credential
description: Add new credential
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Credential'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Credential'
'400':
description: Invalid request body
'422':
description: Validation exception
get:
tags:
- credentials
security:
- bearerAuth: []
summary: List all credentials
description: List all credentials
operationId: listCredentials
parameters:
- in: query
name: credentialName
required: false
schema:
type: string
description: Filter credentials by name
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Credential'
'500':
description: Internal error
/credentials/{id}:
get:
tags:
- credentials
security:
- bearerAuth: []
summary: Get a credential by ID
description: Retrieve a specific credential by ID
operationId: getCredentialById
parameters:
- in: path
name: id
required: true
schema:
type: string
description: Credential ID
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Credential'
'400':
description: The specified ID is invalid
'404':
description: Credential with the specified ID was not found
'500':
description: Internal error
put:
tags:
- credentials
security:
- bearerAuth: []
summary: Update a credential by ID
description: Update a specific credential by ID
operationId: updateCredential
parameters:
- in: path
name: id
required: true
schema:
type: string
description: Credential ID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Credential'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Credential'
'400':
description: The specified ID is invalid or request body is invalid
'404':
description: Credential with the specified ID was not found
'500':
description: Internal error
delete:
tags:
- credentials
security:
- bearerAuth: []
summary: Delete a credential by ID
description: Delete a specific credential by ID
operationId: deleteCredential
parameters:
- in: path
name: id
required: true
schema:
type: string
description: Credential ID
responses:
'200':
description: Successful operation
'400':
description: The specified ID is invalid
'404':
description: Credential with the specified ID was not found
'500':
description: Internal error
/document-store/store:
post:
tags:
- document-store
security:
- bearerAuth: []
summary: Create a new document store
description: Creates a new document store with the provided details
operationId: createDocumentStore
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentStore'
required: true
responses:
'200':
description: Successfully created document store
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentStore'
'400':
description: Invalid request body
'500':
description: Internal server error
get:
tags:
- document-store
security:
- bearerAuth: []
summary: List all document stores
description: Retrieves a list of all document stores
operationId: getAllDocumentStores
responses:
'200':
description: A list of document stores
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DocumentStore'
'500':
description: Internal server error
/document-store/store/{id}:
get:
tags:
- document-store
security:
- bearerAuth: []
summary: Get a specific document store
description: Retrieves details of a specific document store by its ID
operationId: getDocumentStoreById
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Document store ID
responses:
'200':
description: Successfully retrieved document store
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentStore'
'404':
description: Document store not found
'500':
description: Internal server error
put:
tags:
- document-store
security:
- bearerAuth: []
summary: Update a specific document store
description: Updates the details of a specific document store by its ID
operationId: updateDocumentStore
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Document store ID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentStore'
required: true
responses:
'200':
description: Successfully updated document store
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentStore'
'404':
description: Document store not found
'500':
description: Internal server error
delete:
tags:
- document-store
security:
- bearerAuth: []
summary: Delete a specific document store
description: Deletes a document store by its ID
operationId: deleteDocumentStore
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Document store ID
responses:
'200':
description: Successfully deleted document store
'404':
description: Document store not found
'500':
description: Internal server error
/document-store/loader/preview:
post:
tags:
- document-store
security:
- bearerAuth: []
summary: Preview document chunks
description: Preview document chunks from loader
operationId: previewChunking
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentStoreLoaderForPreview'
required: true
responses:
'200':
description: Successfully preview chunks
content:
application/json:
schema:
type: object
properties:
chunks:
type: array
items:
$ref: '#/components/schemas/Document'
totalChunks:
type: integer
example: 10
previewChunkCount:
type: integer
example: 5
'400':
description: Invalid request body
'500':
description: Internal server error
/document-store/loader/process:
post:
tags:
- document-store
security:
- bearerAuth: []
summary: Process loading & chunking operation
description: Process loading & chunking operation of document from loader
operationId: processChunking
requestBody:
content:
application/json:
schema:
type: object
required:
- storeId
- id
properties:
storeId:
type: string
description: Document store ID
example: '603a7b51-ae7c-4b0a-8865-e454ed2f6766'
id:
type: string
description: Document loader ID. If your URL is /document-stores/{storeId}/{id}, then id is the last part of the URL
example: 'c427e569-b81a-469a-b14c-fa73dd5bae49'
required: true
responses:
'200':
description: Successfully process chunking operation
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentStoreFileChunkPagedResponse'
'400':
description: Invalid request body
'500':
description: Internal server error
/document-store/vectorstore/save:
post:
tags:
- document-store
security:
- bearerAuth: []
summary: Save upsert configuration of document store
description: Save upsert configuration of document store
operationId: saveVectorStoreConfig
requestBody:
content:
application/json:
schema:
type: object
required:
- storeId
properties:
storeId:
type: string
description: Document store ID
example: '603a7b51-ae7c-4b0a-8865-e454ed2f6766'
embeddingName:
type: string
description: Name of the embedding
example: 'openAIEmbeddings'
embeddingConfig:
type: object
description: Configuration of the embedding
example: { 'model': 'text-embedding-ada-002', 'credential': '1eba5808-c55b-4817-a285-b0c92846a7ad' }
vectorStoreName:
type: string
description: Name of the vector store
example: 'faiss'
vectorStoreConfig:
type: object
description: Configuration of the embedding
example: { 'basePath': './faiss' }
recordManagerName:
type: string
description: Name of the record manager
example: 'SQLiteRecordManager'
recordManagerConfig:
type: object
description: Configuration of the embedding
example: { 'databaseFilePath': './recordManager.db' }
required: true
responses:
'200':
description: Successfully save upsert configuration of document store
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentStore'
'400':
description: Invalid request body
'500':
description: Internal server error
/document-store/vectorstore/insert:
post:
tags:
- document-store
security:
- bearerAuth: []
summary: Upsert chunks from document store
description: Upsert chunks from document store using the saved configuration
operationId: insertIntoVectorStore
requestBody:
content:
application/json:
schema:
type: object
required:
- storeId
properties:
storeId:
type: string
description: Document store ID
example: '603a7b51-ae7c-4b0a-8865-e454ed2f6766'
required: true
responses:
'200':
description: Successfully save upsert configuration of document store
content:
application/json:
schema:
$ref: '#/components/schemas/VectorUpsertResponse'
'400':
description: Invalid request body