forked from lightspeed-core/lightspeed-stack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.json
More file actions
4537 lines (4537 loc) · 194 KB
/
openapi.json
File metadata and controls
4537 lines (4537 loc) · 194 KB
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.1.0",
"info": {
"title": "Lightspeed Core Service (LCS) service - OpenAPI",
"summary": "Lightspeed Core Service (LCS) service API specification.",
"description": "Lightspeed Core Service (LCS) service API specification.",
"contact": {
"name": "Pavel Tisnovsky",
"url": "https://github.com/tisnik/",
"email": "ptisnovs@redhat.com"
},
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "0.3.0"
},
"servers": [
{
"url": "http://localhost:8080/",
"description": "Locally running service"
}
],
"paths": {
"/": {
"get": {
"tags": [
"root"
],
"summary": "Root Endpoint Handler",
"description": "Handle GET requests to the root (\"/\") endpoint and returns the static HTML index page.\n\nReturns:\n HTMLResponse: The HTML content of the index page, including a heading,\n embedded image with the service icon, and links to the API documentation\n via Swagger UI and ReDoc.",
"operationId": "root_endpoint_handler__get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"text/html": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/v1/info": {
"get": {
"tags": [
"info"
],
"summary": "Info Endpoint Handler",
"description": "Handle request to the /info endpoint.\n\nProcess GET requests to the /info endpoint, returning the\nservice name, version and Llama-stack version.\n\nReturns:\n InfoResponse: An object containing the service's name and version.",
"operationId": "info_endpoint_handler_v1_info_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InfoResponse"
}
}
},
"name": "Service name",
"service_version": "Service version",
"llama_stack_version": "Llama Stack version"
},
"500": {
"description": "Internal Server Error",
"detail": {
"response": "Unable to connect to Llama Stack",
"cause": "Connection error."
}
}
}
}
},
"/v1/models": {
"get": {
"tags": [
"models"
],
"summary": "Models Endpoint Handler",
"description": "Handle requests to the /models endpoint.\n\nProcess GET requests to the /models endpoint, returning a list of available\nmodels from the Llama Stack service.\n\nRaises:\n HTTPException: If unable to connect to the Llama Stack server or if\n model retrieval fails for any reason.\n\nReturns:\n ModelsResponse: An object containing the list of available models.",
"operationId": "models_endpoint_handler_v1_models_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelsResponse"
}
}
},
"models": [
{
"identifier": "all-MiniLM-L6-v2",
"metadata": {
"embedding_dimension": 384
},
"api_model_type": "embedding",
"provider_id": "ollama",
"provider_resource_id": "all-minilm:latest",
"type": "model",
"model_type": "embedding"
},
{
"identifier": "llama3.2:3b-instruct-fp16",
"metadata": {},
"api_model_type": "llm",
"provider_id": "ollama",
"provider_resource_id": "llama3.2:3b-instruct-fp16",
"type": "model",
"model_type": "llm"
}
]
},
"500": {
"description": "Connection to Llama Stack is broken"
}
}
}
},
"/v1/tools": {
"get": {
"tags": [
"tools"
],
"summary": "Tools Endpoint Handler",
"description": "Handle requests to the /tools endpoint.\n\nProcess GET requests to the /tools endpoint, returning a consolidated list of\navailable tools from all configured MCP servers.\n\nRaises:\n HTTPException: If unable to connect to the Llama Stack server or if\n tool retrieval fails for any reason.\n\nReturns:\n ToolsResponse: An object containing the consolidated list of available tools\n with metadata including tool name, description, parameters, and server source.",
"operationId": "tools_endpoint_handler_v1_tools_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ToolsResponse"
},
"example": {
"tools": [
{
"identifier": "",
"description": "",
"parameters": [
{
"name": "",
"description": "",
"parameter_type": "",
"required": "True/False",
"default": "null"
}
],
"provider_id": "",
"toolgroup_id": "",
"server_source": "",
"type": "tool"
}
]
}
}
}
},
"500": {
"description": "Connection to Llama Stack is broken or MCP server error"
}
}
}
},
"/v1/shields": {
"get": {
"tags": [
"shields"
],
"summary": "Shields Endpoint Handler",
"description": "Handle requests to the /shields endpoint.\n\nProcess GET requests to the /shields endpoint, returning a list of available\nshields from the Llama Stack service.\n\nRaises:\n HTTPException: If unable to connect to the Llama Stack server or if\n shield retrieval fails for any reason.\n\nReturns:\n ShieldsResponse: An object containing the list of available shields.",
"operationId": "shields_endpoint_handler_v1_shields_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShieldsResponse"
}
}
},
"shields": [
{
"identifier": "lightspeed_question_validity-shield",
"provider_resource_id": "lightspeed_question_validity-shield",
"provider_id": "lightspeed_question_validity",
"type": "shield",
"params": {}
}
]
},
"500": {
"description": "Connection to Llama Stack is broken"
}
}
}
},
"/v1/providers": {
"get": {
"tags": [
"providers"
],
"summary": "Providers Endpoint Handler",
"description": "Handle GET requests to list all available providers.\n\nRetrieves providers from the Llama Stack service, groups them by API type.\n\nRaises:\n HTTPException:\n - 500 if configuration is not loaded,\n - 500 if unable to connect to Llama Stack,\n - 500 for any unexpected retrieval errors.\n\nReturns:\n ProvidersListResponse: Object mapping API types to lists of providers.",
"operationId": "providers_endpoint_handler_v1_providers_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProvidersListResponse"
}
}
},
"providers": {
"agents": [
{
"provider_id": "meta-reference",
"provider_type": "inline::meta-reference"
}
],
"datasetio": [
{
"provider_id": "huggingface",
"provider_type": "remote::huggingface"
},
{
"provider_id": "localfs",
"provider_type": "inline::localfs"
}
],
"inference": [
{
"provider_id": "sentence-transformers",
"provider_type": "inline::sentence-transformers"
},
{
"provider_id": "openai",
"provider_type": "remote::openai"
}
]
}
},
"500": {
"description": "Connection to Llama Stack is broken"
}
}
}
},
"/v1/providers/{provider_id}": {
"get": {
"tags": [
"providers"
],
"summary": "Get Provider Endpoint Handler",
"description": "Retrieve a single provider by its unique ID.\n\nRaises:\n HTTPException:\n - 404 if provider with the given ID is not found,\n - 500 if unable to connect to Llama Stack,\n - 500 for any unexpected retrieval errors.\n\nReturns:\n ProviderResponse: A single provider's details including API, config, health,\n provider_id, and provider_type.",
"operationId": "get_provider_endpoint_handler_v1_providers__provider_id__get",
"parameters": [
{
"name": "provider_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Provider Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderResponse"
}
}
},
"api": "inference",
"config": {
"api_key": "********"
},
"health": {
"status": "Not Implemented",
"message": "Provider does not implement health check"
},
"provider_id": "openai",
"provider_type": "remote::openai"
},
"404": {
"response": "Provider with given id not found",
"description": "Not Found"
},
"500": {
"response": "Unable to retrieve list of providers",
"cause": "Connection to Llama Stack is broken",
"description": "Internal Server Error"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/rags": {
"get": {
"tags": [
"rags"
],
"summary": "Rags Endpoint Handler",
"description": "Handle GET requests to list all available RAGs.\n\nRetrieves RAGs from the Llama Stack service.\n\nRaises:\n HTTPException:\n - 500 if configuration is not loaded,\n - 500 if unable to connect to Llama Stack,\n - 500 for any unexpected retrieval errors.\n\nReturns:\n RAGListResponse: List of RAGs.",
"operationId": "rags_endpoint_handler_v1_rags_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RAGListResponse"
}
}
},
"rags": [
"vs_00000000-cafe-babe-0000-000000000000",
"vs_7b52a8cf-0fa3-489c-beab-27e061d102f3",
"vs_7b52a8cf-0fa3-489c-cafe-27e061d102f3"
]
},
"500": {
"description": "Connection to Llama Stack is broken"
}
}
}
},
"/v1/rags/{rag_id}": {
"get": {
"tags": [
"rags"
],
"summary": "Get Rag Endpoint Handler",
"description": "Retrieve a single RAG by its unique ID.\n\nRaises:\n HTTPException:\n - 404 if RAG with the given ID is not found,\n - 500 if unable to connect to Llama Stack,\n - 500 for any unexpected retrieval errors.\n\nReturns:\n RAGResponse: A single RAG's details",
"operationId": "get_rag_endpoint_handler_v1_rags__rag_id__get",
"parameters": [
{
"name": "rag_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Rag Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RAGInfoResponse"
}
}
}
},
"404": {
"response": "RAG with given id not found",
"description": "Not Found"
},
"500": {
"response": "Unable to retrieve list of RAGs",
"cause": "Connection to Llama Stack is broken",
"description": "Internal Server Error"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/query": {
"post": {
"tags": [
"query"
],
"summary": "Query Endpoint Handler",
"description": "Handle request to the /query endpoint using Agent API.\n\nThis is a wrapper around query_endpoint_handler_base that provides\nthe Agent API specific retrieve_response and get_topic_summary functions.\n\nReturns:\n QueryResponse: Contains the conversation ID and the LLM-generated response.",
"operationId": "query_endpoint_handler_v1_query_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryResponse"
}
}
},
"conversation_id": "123e4567-e89b-12d3-a456-426614174000",
"response": "LLM answer",
"referenced_documents": [
{
"doc_url": "https://docs.openshift.com/container-platform/4.15/operators/olm/index.html",
"doc_title": "Operator Lifecycle Manager (OLM)"
}
]
},
"400": {
"description": "Missing or invalid credentials provided by client",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"403": {
"description": "Client does not have permission to access conversation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenResponse"
}
}
}
},
"429": {
"description": "The quota has been exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuotaExceededResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"detail": {
"response": "Unable to connect to Llama Stack",
"cause": "Connection error."
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/streaming_query": {
"post": {
"tags": [
"streaming_query"
],
"summary": "Streaming Query Endpoint Handler",
"description": "Handle request to the /streaming_query endpoint using Agent API.\n\nThis is a wrapper around streaming_query_endpoint_handler_base that provides\nthe Agent API specific retrieve_response and response generator functions.\n\nReturns:\n StreamingResponse: An HTTP streaming response yielding\n SSE-formatted events for the query lifecycle.\n\nRaises:\n HTTPException: Returns HTTP 500 if unable to connect to the\n Llama Stack server.",
"operationId": "streaming_query_endpoint_handler_v1_streaming_query_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Streaming response with Server-Sent Events",
"content": {
"application/json": {
"schema": {
"type": "string",
"example": "data: {\"event\": \"start\", \"data\": {\"conversation_id\": \"123e4567-e89b-12d3-a456-426614174000\"}}\n\ndata: {\"event\": \"token\", \"data\": {\"id\": 0, \"token\": \"Hello\"}}\n\ndata: {\"event\": \"end\", \"data\": {\"referenced_documents\": [], \"truncated\": null, \"input_tokens\": 0, \"output_tokens\": 0}, \"available_quotas\": {}}\n\n"
}
},
"text/plain": {
"schema": {
"type": "string",
"example": "Hello world!\n\n---\n\nReference: https://example.com/doc"
}
}
}
},
"400": {
"description": "Missing or invalid credentials provided by client",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"401": {
"description": "Unauthorized: Invalid or missing Bearer token for k8s auth",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"403": {
"description": "Client does not have permission to access conversation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenResponse"
}
}
}
},
"429": {
"description": "The quota has been exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuotaExceededResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"detail": {
"response": "Unable to connect to Llama Stack",
"cause": "Connection error."
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/config": {
"get": {
"tags": [
"config"
],
"summary": "Config Endpoint Handler",
"description": "Handle requests to the /config endpoint.\n\nProcess GET requests to the /config endpoint and returns the\ncurrent service configuration.\n\nReturns:\n Configuration: The loaded service configuration object.",
"operationId": "config_endpoint_handler_v1_config_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Configuration"
}
}
},
"name": "foo bar baz",
"service": {
"host": "localhost",
"port": 8080,
"auth_enabled": false,
"workers": 1,
"color_log": true,
"access_log": true,
"tls_config": {
"tls_certificate_path": "config/certificate.crt",
"tls_key_path": "config/private.key"
}
},
"llama_stack": {
"url": "http://localhost:8321",
"api_key": "*****",
"use_as_library_client": false
},
"user_data_collection": {
"feedback_enabled": true,
"feedback_storage": "/tmp/data/feedback",
"transcripts_enabled": false
},
"mcp_servers": [
{
"name": "server1",
"provider_id": "provider1",
"url": "http://url.com:1"
},
{
"name": "server2",
"provider_id": "provider2",
"url": "http://url.com:2"
},
{
"name": "server3",
"provider_id": "provider3",
"url": "http://url.com:3"
}
]
},
"503": {
"description": "Service Unavailable",
"detail": {
"response": "Configuration is not loaded"
}
}
}
}
},
"/v1/feedback": {
"post": {
"tags": [
"feedback"
],
"summary": "Feedback Endpoint Handler",
"description": "Handle feedback requests.\n\nProcesses a user feedback submission, storing the feedback and\nreturning a confirmation response.\n\nArgs:\n feedback_request: The request containing feedback information.\n ensure_feedback_enabled: The feedback handler (FastAPI Depends) that\n will handle feedback status checks.\n auth: The Authentication handler (FastAPI Depends) that will\n handle authentication Logic.\n\nReturns:\n Response indicating the status of the feedback storage request.\n\nRaises:\n HTTPException: Returns HTTP 500 if feedback storage fails.",
"operationId": "feedback_endpoint_handler_v1_feedback_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeedbackRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Feedback received and stored",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeedbackResponse"
}
}
}
},
"401": {
"description": "Missing or invalid credentials provided by client",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"403": {
"description": "Client does not have permission to access resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenResponse"
}
}
}
},
"500": {
"description": "User feedback can not be stored",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/feedback/status": {
"get": {
"tags": [
"feedback"
],
"summary": "Feedback Status",
"description": "Handle feedback status requests.\n\nReturn the current enabled status of the feedback\nfunctionality.\n\nReturns:\n StatusResponse: Indicates whether feedback collection is enabled.",
"operationId": "feedback_status_v1_feedback_status_get",
"responses": {
"200": {
"description": "Feedback status successfully retrieved",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusResponse"
}
}
}
}
}
},
"put": {
"tags": [
"feedback"
],
"summary": "Update Feedback Status",
"description": "Handle feedback status update requests.\n\nTakes a request with the desired state of the feedback status.\nReturns the updated state of the feedback status based on the request's value.\nThese changes are for the life of the service and are on a per-worker basis.\n\nReturns:\n FeedbackStatusUpdateResponse: Indicates whether feedback is enabled.",
"operationId": "update_feedback_status_v1_feedback_status_put",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeedbackStatusUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Feedback status successfully updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeedbackStatusUpdateResponse"
}
}
}
},
"401": {
"description": "Missing or invalid credentials provided by client",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"403": {
"description": "Client does not have permission to access resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v1/conversations": {
"get": {
"tags": [
"conversations"
],
"summary": "Get Conversations List Endpoint Handler",
"description": "Handle request to retrieve all conversations for the authenticated user.",
"operationId": "get_conversations_list_endpoint_handler_v1_conversations_get",
"responses": {
"200": {
"description": "List of conversations retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConversationsListResponse"
}
}
}
},
"401": {
"description": "Unauthorized: Invalid or missing Bearer token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"503": {
"description": "Service unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailableResponse"
}
}
}
}
}
}
},
"/v1/conversations/{conversation_id}": {
"get": {
"tags": [
"conversations"
],
"summary": "Get Conversation Endpoint Handler",
"description": "Handle request to retrieve a conversation by ID.\n\nRetrieve a conversation's chat history by its ID. Then fetches\nthe conversation session from the Llama Stack backend,\nsimplifies the session data to essential chat history, and\nreturns it in a structured response. Raises HTTP 400 for\ninvalid IDs, 404 if not found, 503 if the backend is\nunavailable, and 500 for unexpected errors.\n\nParameters:\n conversation_id (str): Unique identifier of the conversation to retrieve.\n\nReturns:\n ConversationResponse: Structured response containing the conversation\n ID and simplified chat history.",
"operationId": "get_conversation_endpoint_handler_v1_conversations__conversation_id__get",
"parameters": [
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Conversation Id"
}
}
],
"responses": {
"200": {
"description": "Conversation retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConversationResponse"
}
}
}
},
"400": {
"description": "Invalid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "Unauthorized: Invalid or missing Bearer token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"403": {
"description": "Client does not have permission to access conversation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessDeniedResponse"
}
}
}
},
"404": {
"description": "Conversation not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundResponse"
}
}
}
},
"503": {
"description": "Service unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailableResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"conversations"
],
"summary": "Delete Conversation Endpoint Handler",
"description": "Handle request to delete a conversation by ID.\n\nValidates the conversation ID format and attempts to delete the\ncorresponding session from the Llama Stack backend. Raises HTTP\nerrors for invalid IDs, not found conversations, connection\nissues, or unexpected failures.\n\nReturns:\n ConversationDeleteResponse: Response indicating the result of the deletion operation.",
"operationId": "delete_conversation_endpoint_handler_v1_conversations__conversation_id__delete",
"parameters": [
{
"name": "conversation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Conversation Id"
}
}
],
"responses": {
"200": {
"description": "Conversation deleted successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConversationDeleteResponse"
}
}
}
},
"400": {
"description": "Invalid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestResponse"
}
}
}
},
"401": {
"description": "Unauthorized: Invalid or missing Bearer token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedResponse"
}
}
}
},
"403": {
"description": "Client does not have permission to access conversation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessDeniedResponse"
}
}
}
},