diff --git a/docs/openapi.md b/docs/openapi.md index ecc0cb093..e1df8b8c6 100644 --- a/docs/openapi.md +++ b/docs/openapi.md @@ -12,6 +12,46 @@ Lightspeed Core Service (LCS) service API specification. # 🛠️ APIs +## List of REST API endpoints + +| Method | Path | Description | +|--------|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| GET | `/` | Returns the static HTML index page | +| GET | `/v1/info` | Returns the service name, version and Llama-stack version | +| GET | `/v1/models` | List of available models | +| GET | `/v1/tools` | Consolidated list of available tools from all configured MCP servers | +| GET | `/v1/mcp-auth/client-options` | List of MCP servers configured to accept client-provided authorization tokens, along with the header names where clients should provide these tokens | +| GET | `/v1/shields` | List of available shields from the Llama Stack service | +| GET | `/v1/providers` | List all available providers grouped by API type | +| GET | `/v1/providers/{provider_id}` | Retrieve a single provider identified by its unique ID | +| GET | `/v1/rags` | List all available RAGs | +| GET | `/v1/rags/{rag_id}` | Retrieve a single RAG identified by its unique ID | +| POST | `/v1/query` | Processes a POST request to a query endpoint, forwarding the user's query to a selected Llama Stack LLM and returning the generated response | +| POST | `/v1/streaming_query` | Streaming response using Server-Sent Events (SSE) format with content type text/event-stream | +| GET | `/v1/config` | Returns the current service configuration | +| POST | `/v1/feedback` | Processes a user feedback submission, storing the feedback and returning a confirmation response | +| GET | `/v1/feedback/status` | Return the current enabled status of the feedback functionality | +| PUT | `/v1/feedback/status` | Change the feedback status: enables or disables it | +| GET | `/v1/conversations` | Retrieve all conversations for the authenticated user | +| GET | `/v1/conversations/{conversation_id}` | Retrieve a conversation by ID using Conversations API | +| DELETE | `/v1/conversations/{conversation_id}` | Delete a conversation by ID using Conversations API | +| PUT | `/v1/conversations/{conversation_id}` | Update a conversation metadata using Conversations API | +| GET | `/v2/conversations` | Retrieve all conversations for the authenticated user | +| GET | `/v2/conversations/{conversation_id}` | Retrieve a conversation identified by its ID | +| DELETE | `/v2/conversations/{conversation_id}` | Delete a conversation identified by its ID | +| PUT | `/v2/conversations/{conversation_id}` | Update a conversation topic summary by ID | +| POST | `/v1/infer` | Serves requests from the RHEL Lightspeed Command Line Assistant (CLA) | +| GET | `/readiness` | Returns service readiness state | +| GET | `/liveness` | Returns liveness status of the service | +| POST | `/authorized` | Returns the authenticated user's ID and username | +| GET | `/metrics` | Returns the latest Prometheus metrics in a form of plain text | +| GET | `/.well-known/agent-card.json` | Serve the A2A Agent Card at the well-known location | +| GET | `/.well-known/agent.json` | Handle A2A JSON-RPC requests following the A2A protocol specification | +| GET | `/a2a` | Handle A2A JSON-RPC requests following the A2A protocol specification | +| POST | `/a2a` | Handle A2A JSON-RPC requests following the A2A protocol specification | +| GET | `/a2a/health` | Handle A2A JSON-RPC requests following the A2A protocol specification | + + ## GET `/` > **Root Endpoint Handler** @@ -29,15 +69,13 @@ Returns: ### ✅ Responses -| Status Code | Description | Component | -|-------------|-------------|-----------| -| 200 | Successful Response | string | -| 401 | Unauthorized | ... -Examples - - - +| Status Code | Description | Component | +|-------------|---------------------|-----------------------------------------------| +| 200 | Successful Response | string | +| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) | +| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) | +Examples ```json { @@ -48,9 +86,6 @@ Examples } ``` - - - ```json { "detail": { @@ -60,14 +95,6 @@ Examples } ``` -[UnauthorizedResponse](#unauthorizedresponse) | -| 403 | Permission denied | ... -Examples - - - - - ```json { "detail": { @@ -77,15 +104,14 @@ Examples } ``` -[ForbiddenResponse](#forbiddenresponse) | ## GET `/v1/info` > **Info Endpoint Handler** Handle request to the /info endpoint. -Process GET requests to the /info endpoint, returning the -service name, version and Llama-stack version. +Process GET requests to the /info endpoint, returning the service name, version +and Llama-stack version. Raises: HTTPException: with status 500 and a detail object @@ -102,17 +128,15 @@ Returns: ### ✅ Responses -| Status Code | Description | Component | -|-------------|-------------|-----------| -| 200 | Successful response | [InfoResponse](#inforesponse) | -| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) +| Status Code | Description | Component | +|-------------|---------------------|-----------------------------------------------------------| +| 200 | Successful response | [InfoResponse](#inforesponse) | +| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) | +| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) | +| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) | Examples - - - - ```json { "detail": { @@ -122,9 +146,6 @@ Examples } ``` - - - ```json { "detail": { @@ -134,9 +155,6 @@ Examples } ``` - - - ```json { "detail": { @@ -146,9 +164,6 @@ Examples } ``` - - - ```json { "detail": { @@ -158,9 +173,6 @@ Examples } ``` - - - ```json { "detail": { @@ -170,9 +182,6 @@ Examples } ``` - - - ```json { "detail": { @@ -182,9 +191,6 @@ Examples } ``` - - - ```json { "detail": { @@ -194,9 +200,6 @@ Examples } ``` - - - ```json { "detail": { @@ -205,14 +208,6 @@ Examples } } ``` - | -| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) - -Examples - - - - ```json { @@ -222,14 +217,6 @@ Examples } } ``` - | -| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) - -Examples - - - - ```json { @@ -239,7 +226,7 @@ Examples } } ``` - | + ## GET `/v1/models` > **Models Endpoint Handler** @@ -272,24 +259,24 @@ will be returned. ### 🔗 Parameters -| Name | Type | Required | Description | -|------|------|----------|-------------| -| model_type | | False | Optional filter to return only models matching this type | +| Name | Type | Required | Description | +|------------|------|----------|----------------------------------------------------------| +| model_type | | False | Optional filter to return only models matching this type | ### ✅ Responses -| Status Code | Description | Component | -|-------------|-------------|-----------| -| 200 | Successful response | [ModelsResponse](#modelsresponse) | -| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) +| Status Code | Description | Component | +|-------------|-----------------------|-------------------------------------------------------------| +| 200 | Successful response | [ModelsResponse](#modelsresponse) | +| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) | +| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) | +| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) | +| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) | +| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) | Examples - - - - ```json { "detail": { @@ -299,9 +286,6 @@ Examples } ``` - - - ```json { "detail": { @@ -310,14 +294,6 @@ Examples } } ``` - | -| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) - -Examples - - - - ```json { @@ -327,14 +303,6 @@ Examples } } ``` - | -| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) - -Examples - - - - ```json { @@ -344,14 +312,6 @@ Examples } } ``` - | -| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) - -Examples - - - - ```json { @@ -361,8 +321,7 @@ Examples } } ``` - | -| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) | + ## GET `/v1/tools` > **Tools Endpoint Handler** @@ -386,17 +345,16 @@ Returns: ### ✅ Responses -| Status Code | Description | Component | -|-------------|-------------|-----------| -| 200 | Successful response | [ToolsResponse](#toolsresponse) | -| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) +| Status Code | Description | Component | +|-------------|-----------------------|-------------------------------------------------------------| +| 200 | Successful response | [ToolsResponse](#toolsresponse) | +| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) | +| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) | +| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) | +| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) | Examples - - - - ```json { "detail": { @@ -406,9 +364,6 @@ Examples } ``` - - - ```json { "detail": { @@ -417,14 +372,6 @@ Examples } } ``` - | -| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) - -Examples - - - - ```json { @@ -434,13 +381,6 @@ Examples } } ``` - | -| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) - -Examples - - - ```json @@ -451,14 +391,6 @@ Examples } } ``` - | -| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) - -Examples - - - - ```json { @@ -468,7 +400,7 @@ Examples } } ``` - | + ## GET `/v1/mcp-auth/client-options` > **Get Mcp Client Auth Options** @@ -1963,17 +1895,16 @@ Handle request to retrieve all conversations for the authenticated user. ### ✅ Responses -| Status Code | Description | Component | -|-------------|-------------|-----------| -| 200 | Successful response | [ConversationsListResponse](#conversationslistresponse) | -| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) +| Status Code | Description | Component | +|-------------|-----------------------|-------------------------------------------------------------| +| 200 | Successful response | [ConversationsListResponse](#conversationslistresponse) | +| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) | +| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) | +| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) | Examples - - - ```json { "detail": { @@ -1994,11 +1925,6 @@ Examples } } ``` - | -| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) - -Examples - @@ -2011,13 +1937,6 @@ Examples } } ``` - | -| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) - -Examples - - - ```json @@ -2040,7 +1959,7 @@ Examples } } ``` - | + ## GET `/v1/conversations/{conversation_id}` > **Conversation Get Endpoint Handler V1** @@ -2067,17 +1986,23 @@ Returns: ### 🔗 Parameters -| Name | Type | Required | Description | -|------|------|----------|-------------| -| conversation_id | string | True | | +| Name | Type | Required | Description | +|-----------------|--------|----------|-------------| +| conversation_id | string | True | | ### ✅ Responses -| Status Code | Description | Component | -|-------------|-------------|-----------| -| 200 | Successful response | [ConversationResponse](#conversationresponse) | -| 400 | Invalid request format | [BadRequestResponse](#badrequestresponse) +| Status Code | Description | Component | +|-------------|------------------------|-------------------------------------------------------------| +| 200 | Successful response | [ConversationResponse](#conversationresponse) | +| 400 | Invalid request format | [BadRequestResponse](#badrequestresponse) | +| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) | +| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) | +| 404 | Resource not found | [NotFoundResponse](#notfoundresponse) | +| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) | +| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) | +| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) | Examples @@ -2093,12 +2018,6 @@ Examples } } ``` - | -| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) - -Examples - - @@ -2122,14 +2041,6 @@ Examples } } ``` - | -| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) - -Examples - - - - ```json { @@ -2151,13 +2062,6 @@ Examples } } ``` - | -| 404 | Resource not found | [NotFoundResponse](#notfoundresponse) - -Examples - - - ```json @@ -2168,12 +2072,6 @@ Examples } } ``` - | -| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) - -Examples - - @@ -2197,12 +2095,6 @@ Examples } } ``` - | -| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) - -Examples - - @@ -2214,8 +2106,6 @@ Examples } } ``` - | -| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) | ## DELETE `/v1/conversations/{conversation_id}` > **Conversation Delete Endpoint Handler V1** @@ -2239,16 +2129,22 @@ Returns: ### 🔗 Parameters -| Name | Type | Required | Description | -|------|------|----------|-------------| -| conversation_id | string | True | | +| Name | Type | Required | Description | +|-----------------|--------|----------|-------------| +| conversation_id | string | True | | ### ✅ Responses -| Status Code | Description | Component | -|-------------|-------------|-----------| -| 200 | Successful response | [ConversationDeleteResponse](#conversationdeleteresponse) +| Status Code | Description | Component | +|-------------|------------------------|-------------------------------------------------------------| +| 200 | Successful response | [ConversationDeleteResponse](#conversationdeleteresponse) | +| 400 | Invalid request format | [BadRequestResponse](#badrequestresponse) | +| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) | +| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) | +| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) | +| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) | +| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) | Examples @@ -2274,13 +2170,6 @@ Examples "success": true } ``` - | -| 400 | Invalid request format | [BadRequestResponse](#badrequestresponse) - -Examples - - - ```json @@ -2291,13 +2180,6 @@ Examples } } ``` - | -| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) - -Examples - - - ```json @@ -2320,13 +2202,6 @@ Examples } } ``` - | -| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) - -Examples - - - ```json @@ -2349,13 +2224,6 @@ Examples } } ``` - | -| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) - -Examples - - - ```json @@ -2378,14 +2246,6 @@ Examples } } ``` - | -| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) - -Examples - - - - ```json { @@ -2395,8 +2255,7 @@ Examples } } ``` - | -| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) | + ## PUT `/v1/conversations/{conversation_id}` > **Conversation Update Endpoint Handler V1** @@ -2419,9 +2278,9 @@ Returns: ### 🔗 Parameters -| Name | Type | Required | Description | -|------|------|----------|-------------| -| conversation_id | string | True | | +| Name | Type | Required | Description | +|-----------------|--------|----------|-------------| +| conversation_id | string | True | | ### 📦 Request Body @@ -2430,17 +2289,21 @@ Returns: ### ✅ Responses -| Status Code | Description | Component | -|-------------|-------------|-----------| -| 200 | Successful response | [ConversationUpdateResponse](#conversationupdateresponse) | -| 400 | Invalid request format | [BadRequestResponse](#badrequestresponse) +| Status Code | Description | Component | +|-------------|------------------------|-------------------------------------------------------------| +| 200 | Successful response | [ConversationUpdateResponse](#conversationupdateresponse) | +| 400 | Invalid request format | [BadRequestResponse](#badrequestresponse) | +| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) | +| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) | +| 404 | Resource not found | [NotFoundResponse](#notfoundresponse) | +| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) | +| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) | +| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) | Examples - - ```json { "detail": { @@ -2449,13 +2312,6 @@ Examples } } ``` - | -| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) - -Examples - - - ```json @@ -2478,13 +2334,6 @@ Examples } } ``` - | -| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) - -Examples - - - ```json @@ -2495,14 +2344,6 @@ Examples } } ``` - | -| 404 | Resource not found | [NotFoundResponse](#notfoundresponse) - -Examples - - - - ```json { @@ -2512,14 +2353,6 @@ Examples } } ``` - | -| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) - -Examples - - - - ```json { @@ -2541,13 +2374,6 @@ Examples } } ``` - | -| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) - -Examples - - - ```json @@ -2558,8 +2384,7 @@ Examples } } ``` - | -| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) | + ## GET `/v2/conversations` > **Get Conversations List Endpoint Handler** @@ -2572,10 +2397,12 @@ Handle request to retrieve all conversations for the authenticated user. ### ✅ Responses -| Status Code | Description | Component | -|-------------|-------------|-----------| -| 200 | Successful response | [ConversationsListResponseV2](#conversationslistresponsev2) | -| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) +| Status Code | Description | Component | +|-------------|-----------------------|-------------------------------------------------------------| +| 200 | Successful response | [ConversationsListResponseV2](#conversationslistresponsev2) | +| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) | +| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) | +| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) | Examples @@ -2603,11 +2430,6 @@ Examples } } ``` - | -| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) - -Examples - @@ -2620,12 +2442,6 @@ Examples } } ``` - | -| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) - -Examples - - @@ -2649,7 +2465,7 @@ Examples } } ``` - | + ## GET `/v2/conversations/{conversation_id}` > **Get Conversation Endpoint Handler** @@ -2667,10 +2483,15 @@ Handle request to retrieve a conversation identified by its ID. ### ✅ Responses -| Status Code | Description | Component | -|-------------|-------------|-----------| -| 200 | Successful response | [ConversationResponse](#conversationresponse) | -| 400 | Invalid request format | [BadRequestResponse](#badrequestresponse) +| Status Code | Description | Component | +|-------------|------------------------|-------------------------------------------------------------| +| 200 | Successful response | [ConversationResponse](#conversationresponse) | +| 400 | Invalid request format | [BadRequestResponse](#badrequestresponse) | +| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) | +| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) | +| 404 | Resource not found | [NotFoundResponse](#notfoundresponse) | +| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) | +| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) | Examples @@ -2686,11 +2507,6 @@ Examples } } ``` - | -| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) - -Examples - @@ -2715,12 +2531,6 @@ Examples } } ``` - | -| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) - -Examples - - @@ -2732,12 +2542,6 @@ Examples } } ``` - | -| 404 | Resource not found | [NotFoundResponse](#notfoundresponse) - -Examples - - @@ -2749,12 +2553,6 @@ Examples } } ``` - | -| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) - -Examples - - @@ -2778,8 +2576,7 @@ Examples } } ``` - | -| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) | + ## DELETE `/v2/conversations/{conversation_id}` > **Delete Conversation Endpoint Handler** @@ -2790,16 +2587,21 @@ Handle request to delete a conversation by ID. ### 🔗 Parameters -| Name | Type | Required | Description | -|------|------|----------|-------------| -| conversation_id | string | True | | +| Name | Type | Required | Description | +|-----------------|--------|----------|-------------| +| conversation_id | string | True | | ### ✅ Responses -| Status Code | Description | Component | -|-------------|-------------|-----------| -| 200 | Successful response | [ConversationDeleteResponse](#conversationdeleteresponse) +| Status Code | Description | Component | +|-------------|------------------------|-------------------------------------------------------------| +| 200 | Successful response | [ConversationDeleteResponse](#conversationdeleteresponse) | +| 400 | Invalid request format | [BadRequestResponse](#badrequestresponse) | +| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) | +| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) | +| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) | +| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) | Examples @@ -2825,12 +2627,6 @@ Examples "success": true } ``` - | -| 400 | Invalid request format | [BadRequestResponse](#badrequestresponse) - -Examples - - @@ -2842,12 +2638,6 @@ Examples } } ``` - | -| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) - -Examples - - @@ -2871,11 +2661,6 @@ Examples } } ``` - | -| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) - -Examples - @@ -2888,11 +2673,6 @@ Examples } } ``` - | -| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) - -Examples - @@ -2917,8 +2697,7 @@ Examples } } ``` - | -| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) | + ## PUT `/v2/conversations/{conversation_id}` > **Update Conversation Endpoint Handler** @@ -2929,9 +2708,9 @@ Handle request to update a conversation topic summary by ID. ### 🔗 Parameters -| Name | Type | Required | Description | -|------|------|----------|-------------| -| conversation_id | string | True | | +| Name | Type | Required | Description | +|-----------------|--------|----------|-------------| +| conversation_id | string | True | | ### 📦 Request Body @@ -2940,10 +2719,15 @@ Handle request to update a conversation topic summary by ID. ### ✅ Responses -| Status Code | Description | Component | -|-------------|-------------|-----------| -| 200 | Successful response | [ConversationUpdateResponse](#conversationupdateresponse) | -| 400 | Invalid request format | [BadRequestResponse](#badrequestresponse) +| Status Code | Description | Component | +|-------------|------------------------|-------------------------------------------------------------| +| 200 | Successful response | [ConversationUpdateResponse](#conversationupdateresponse) | +| 400 | Invalid request format | [BadRequestResponse](#badrequestresponse) | +| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) | +| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) | +| 404 | Resource not found | [NotFoundResponse](#notfoundresponse) | +| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) | +| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) | Examples @@ -2959,12 +2743,6 @@ Examples } } ``` - | -| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) - -Examples - - @@ -2988,12 +2766,6 @@ Examples } } ``` - | -| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) - -Examples - - @@ -3005,12 +2777,6 @@ Examples } } ``` - | -| 404 | Resource not found | [NotFoundResponse](#notfoundresponse) - -Examples - - @@ -3022,12 +2788,6 @@ Examples } } ``` - | -| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) - -Examples - - @@ -3051,8 +2811,7 @@ Examples } } ``` - | -| 422 | Validation Error | [HTTPValidationError](#httpvalidationerror) | + ## POST `/v1/infer` > **Infer Endpoint** @@ -3086,10 +2845,16 @@ Raises: ### ✅ Responses -| Status Code | Description | Component | -|-------------|-------------|-----------| -| 200 | Successful response | [RlsapiV1InferResponse](#rlsapiv1inferresponse) | -| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) +| Status Code | Description | Component | +|-------------|---------------------------|-------------------------------------------------------------| +| 200 | Successful response | [RlsapiV1InferResponse](#rlsapiv1inferresponse) | +| 401 | Unauthorized | [UnauthorizedResponse](#unauthorizedresponse) | +| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) | +| 413 | Prompt is too long | [PromptTooLongResponse](#prompttoolongresponse) | +| 422 | Request validation failed | [UnprocessableEntityResponse](#unprocessableentityresponse) | +| 429 | Quota limit exceeded | [QuotaExceededResponse](#quotaexceededresponse) | +| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) | +| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) | Examples @@ -3117,12 +2882,6 @@ Examples } } ``` - | -| 403 | Permission denied | [ForbiddenResponse](#forbiddenresponse) - -Examples - - @@ -3134,12 +2893,6 @@ Examples } } ``` - | -| 413 | Prompt is too long | [PromptTooLongResponse](#prompttoolongresponse) - -Examples - - @@ -3151,13 +2904,6 @@ Examples } } ``` - | -| 422 | Request validation failed | [UnprocessableEntityResponse](#unprocessableentityresponse) - -Examples - - - ```json @@ -3192,12 +2938,6 @@ Examples } } ``` - | -| 429 | Quota limit exceeded | [QuotaExceededResponse](#quotaexceededresponse) - -Examples - - @@ -3281,13 +3021,6 @@ Examples } } ``` - | -| 500 | Internal server error | [InternalServerErrorResponse](#internalservererrorresponse) | -| 503 | Service unavailable | [ServiceUnavailableResponse](#serviceunavailableresponse) - -Examples - - @@ -3299,7 +3032,7 @@ Examples } } ``` - | + ## GET `/readiness` > **Readiness Probe Get Method**