-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
3324 lines (3292 loc) · 83.8 KB
/
openapi.yaml
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
openapi: 3.0.3
info:
title: FastAPI
description: Open-source RAG Framework
version: 0.1.0
x-konfig-ignore:
object-with-no-properties: true
servers:
- url: https://api.quivr.app
tags:
- name: Brain
- name: Chat
- name: Health
- name: Prompt
- name: User
- name: API Key
- name: Knowledge
- name: Assistant
- name: Onboarding
- name: BrainSubscription
- name: Subscription
- name: Crawl
- name: Analytics
- name: Upload
- name: Notification
- name: Root
- name: Contact
paths:
/brains/public:
get:
tags:
- Brain
summary: Retrieve Public Brains
operationId: Brain_getAllPublic
security:
- AuthBearer: []
description: Retrieve all Quivr public brains.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BrainGetAllPublicResponse'
/brains/{brain_id}/secrets-values:
put:
tags:
- Brain
summary: Update Existing Brain Secrets
operationId: Brain_updateSecretsValues
security:
- AuthBearer: []
- AuthBearer: []
description: Update an existing brain's secrets.
parameters:
- name: brain_id
in: path
required: true
schema:
title: Brain Id
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BrainUpdateSecretsValuesRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BrainUpdateSecretsValuesResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/brains/{brain_id}/documents:
post:
tags:
- Brain
summary: Get Question Context For Brain
operationId: Brain_getQuestionContext
security:
- AuthBearer: []
- AuthBearer: []
description: Retrieve the question context from a specific brain.
parameters:
- name: brain_id
in: path
required: true
schema:
title: Brain Id
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BrainQuestionRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BrainGetQuestionContextResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/chat/healthz:
get:
tags:
- Health
summary: Healthz
operationId: Health_checkStatus
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HealthCheckStatusResponse'
/chat:
get:
tags:
- Chat
summary: Get Chats
operationId: Chat_getAllChats
security:
- AuthBearer: []
- AuthBearer: []
description: >-
Retrieve all chats for the current user.
- `current_user`: The current authenticated user.
- Returns a list of all chats for the user.
This endpoint retrieves all the chats associated with the current
authenticated user. It returns a list of chat objects
containing the chat ID and chat name for each chat.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ChatGetAllChatsResponse'
post:
tags:
- Chat
summary: Create Chat Handler
operationId: Chat_createHandler
security:
- AuthBearer: []
- AuthBearer: []
description: Create a new chat with initial chat messages.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateChatProperties'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ChatCreateHandlerResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/chat/{chat_id}:
delete:
tags:
- Chat
summary: Delete Chat
operationId: Chat_deleteChatById
security:
- AuthBearer: []
description: Delete a specific chat by chat ID.
parameters:
- name: chat_id
in: path
required: true
schema:
title: Chat Id
type: string
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ChatDeleteChatByIdResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/chat/{chat_id}/metadata:
put:
tags:
- Chat
summary: Update Chat Metadata Handler
operationId: Chat_updateMetadataHandler
security:
- AuthBearer: []
- AuthBearer: []
description: Update chat attributes
parameters:
- name: chat_id
in: path
required: true
schema:
title: Chat Id
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChatUpdatableProperties'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ChatUpdateMetadataHandlerResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/chat/{chat_id}/{message_id}:
put:
tags:
- Chat
summary: Update Chat Message
operationId: Chat_updateMessage
security:
- AuthBearer: []
- AuthBearer: []
parameters:
- name: chat_id
in: path
required: true
schema:
title: Chat Id
type: string
format: uuid
- name: message_id
in: path
required: true
schema:
title: Message Id
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChatMessageProperties'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ChatUpdateMessageResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/chat/{chat_id}/question:
post:
tags:
- Chat
summary: Create Question Handler
operationId: Chat_handleQuestion
security:
- AuthBearer: []
- AuthBearer: []
parameters:
- name: chat_id
in: path
required: true
schema:
title: Chat Id
type: string
format: uuid
- name: brain_id
in: query
required: false
schema:
title: Brain Id
type: string
format: uuid
nullable: true
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChatQuestion'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ChatHandleQuestionResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/chat/{chat_id}/question/stream:
post:
tags:
- Chat
summary: Create Stream Question Handler
operationId: Chat_createStreamQuestionHandler
security:
- AuthBearer: []
- AuthBearer: []
parameters:
- name: chat_id
in: path
required: true
schema:
title: Chat Id
type: string
format: uuid
- name: brain_id
in: query
required: false
schema:
title: Brain Id
type: string
format: uuid
nullable: true
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChatQuestion'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ChatCreateStreamQuestionHandlerResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/chat/{chat_id}/history:
get:
tags:
- Chat
summary: Get Chat History Handler
operationId: Chat_getHistory
security:
- AuthBearer: []
parameters:
- name: chat_id
in: path
required: true
schema:
title: Chat Id
type: string
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ChatGetHistoryResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/chat/{chat_id}/question/answer:
post:
tags:
- Chat
summary: Add Question And Answer Handler
operationId: Chat_addQuestionAndAnswer
security:
- AuthBearer: []
description: Add a new question and anwser to the chat.
parameters:
- name: chat_id
in: path
required: true
schema:
title: Chat Id
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QuestionAndAnswer'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ChatNullable'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/crawl/healthz:
get:
tags:
- Health
summary: Healthz
operationId: Health_checkStatus
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HealthCheckStatus200Response'
/crawl:
post:
tags:
- Crawl
summary: Crawl Endpoint
operationId: Crawl_websiteDataProcessor
security:
- AuthBearer: []
- AuthBearer: []
description: Crawl a website and process the crawled data.
parameters:
- description: The ID of the brain
name: brain_id
in: query
required: true
schema:
title: Brain Id
description: The ID of the brain
type: string
format: uuid
- description: The ID of the chat
name: chat_id
in: query
required: false
schema:
title: Chat Id
description: The ID of the chat
type: string
format: uuid
nullable: true
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CrawlWebsite'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CrawlWebsiteDataProcessorResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/assistants:
get:
tags:
- Assistant
summary: List Assistants
operationId: Assistant_getAllKnowledge
security:
- AuthBearer: []
- AuthBearer: []
description: Retrieve and list all the knowledge in a brain.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AssistantGetAllKnowledgeResponse'
/assistant/process:
post:
tags:
- Assistant
summary: Process Assistant
operationId: Assistant_processData
security:
- AuthBearer: []
- AuthBearer: []
requestBody:
content:
multipart/form-data:
schema:
$ref: >-
#/components/schemas/Body_process_assistant_assistant_process_post
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AssistantProcessDataResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/onboarding:
get:
tags:
- Onboarding
summary: Get User Onboarding Handler
operationId: Onboarding_getUserInfo
security:
- AuthBearer: []
- AuthBearer: []
description: Get user onboarding information for the current user
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/OnboardingStatesNullable'
put:
tags:
- Onboarding
summary: Update User Onboarding Handler
operationId: Onboarding_updateUserOnboarding
security:
- AuthBearer: []
- AuthBearer: []
description: Update user onboarding information for the current user
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OnboardingUpdatableProperties'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/OnboardingStates'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/:
get:
tags:
- Root
summary: Root
operationId: Root_statusCheck
description: Root endpoint to check the status of the API.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RootStatusCheckResponse'
/healthz:
get:
tags:
- Health
summary: Healthz
operationId: Health_checkStatus
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HealthCheckStatus200Response'
/analytics/brains-usages:
get:
tags:
- Analytics
summary: Get Brains Usages
operationId: Analytics_getUserBrainUsages
security:
- AuthBearer: []
- AuthBearer: []
description: Get all user brains usages
parameters:
- name: brain_id
in: query
required: false
schema:
title: Brain Id
type: string
format: uuid
- name: graph_range
in: query
required: false
schema:
$ref: '#/components/schemas/Range'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsGetUserBrainUsagesResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/upload/healthz:
get:
tags:
- Health
summary: Healthz
operationId: Health_checkStatus
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HealthCheckStatus200Response'
/upload:
post:
tags:
- Upload
summary: Upload File
operationId: Upload_filePost
security:
- AuthBearer: []
- AuthBearer: []
parameters:
- description: The ID of the brain
name: brain_id
in: query
required: true
schema:
title: Brain Id
description: The ID of the brain
type: string
format: uuid
- description: The ID of the chat
name: chat_id
in: query
required: false
schema:
title: Chat Id
description: The ID of the chat
type: string
format: uuid
nullable: true
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_upload_file_upload_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UploadFilePostResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/user:
get:
tags:
- User
summary: Get User Endpoint
operationId: User_getUserInformation
security:
- AuthBearer: []
- AuthBearer: []
description: >-
Get user information and statistics.
- `current_user`: The current authenticated user.
- Returns the user's email, maximum brain size, current brain size,
maximum requests number, requests statistics, and the current date.
This endpoint retrieves information and statistics about the
authenticated user. It includes the user's email, maximum brain size,
current brain size, maximum requests number, requests statistics, and
the current date. The brain size is calculated based on the
user's uploaded vectors, and the maximum brain size is obtained from the
environment variables. The requests statistics provide
information about the user's API usage.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UserGetUserInformationResponse'
/user/identity:
get:
tags:
- User
summary: Get User Identity Route
operationId: User_getIdentityRoute
security:
- AuthBearer: []
- AuthBearer: []
description: Get user identity.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UserIdentity'
put:
tags:
- User
summary: Update User Identity Route
operationId: User_updateIdentityRoute
security:
- AuthBearer: []
- AuthBearer: []
description: Update user identity.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserUpdatableProperties'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UserIdentity'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api-key:
post:
tags:
- API Key
summary: Create Api Key
operationId: ApiKey_createNewKey
security:
- AuthBearer: []
- AuthBearer: []
description: >-
Create new API key for the current user.
- `current_user`: The current authenticated user.
- Returns the newly created API key.
This endpoint generates a new API key for the current user. The API key
is stored in the database and associated with
the user. It returns the newly created API key.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKey'
/api-key/{key_id}:
delete:
tags:
- API Key
summary: Delete Api Key
operationId: ApiKey_deleteKey
security:
- AuthBearer: []
- AuthBearer: []
description: >-
Delete (deactivate) an API key for the current user.
- `key_id`: The ID of the API key to delete.
This endpoint deactivates and deletes the specified API key associated
with the current user. The API key is marked
as inactive in the database.
parameters:
- name: key_id
in: path
required: true
schema:
title: Key Id
type: string
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeyDeleteKeyResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api-keys:
get:
tags:
- API Key
summary: Get Api Keys
operationId: ApiKey_getList
security:
- AuthBearer: []
- AuthBearer: []
description: >-
Get all active API keys for the current user.
- `current_user`: The current authenticated user.
- Returns a list of active API keys with their IDs and creation times.
This endpoint retrieves all the active API keys associated with the
current user. It returns a list of API key objects
containing the key ID and creation time for each API key.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeyGetListResponse'
/brains/{brain_id}/subscription:
post:
tags:
- BrainSubscription
summary: Invite Users To Brain
operationId: BrainSubscription_inviteUsersToBrain
security:
- AuthBearer: []
- AuthBearer: []
description: |-
Invite multiple users to a brain by their emails. This function creates
or updates a brain subscription invitation for each user and sends an
invitation email to each user.
parameters:
- name: brain_id
in: path
required: true
schema:
title: Brain Id
type: string
format: uuid
- name: origin
in: header
required: false
schema:
title: Origin
type: string
nullable: true
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BrainSubscriptionInviteUsersToBrainRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: >-
#/components/schemas/BrainSubscriptionInviteUsersToBrainResponse
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Brain
summary: Remove User Subscription
operationId: Brain_removeUserSubscription
security:
- AuthBearer: []
description: Remove a user's subscription to a brain
parameters:
- name: brain_id
in: path
required: true
schema:
title: Brain Id
type: string
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BrainRemoveUserSubscriptionResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- BrainSubscription
summary: Get User Invitation
operationId: BrainSubscription_getUserInvitation
security:
- AuthBearer: []
- AuthBearer: []
description: >-
Get an invitation to a brain for a user. This function checks if the
user
has been invited to the brain and returns the invitation status.
parameters:
- name: brain_id
in: path