openapi: 3.1.0 info: title: Llama Stack Specification description: |- This is the specification of the Llama Stack that provides a set of endpoints and their corresponding interfaces that are tailored to best leverage Llama Models. **✅ STABLE**: Production-ready APIs with backward compatibility guarantees. version: v1 servers: - url: http://any-hosted-llama-stack.com paths: /v1/batches: get: responses: '200': description: A list of batch objects. content: application/json: schema: $ref: '#/components/schemas/ListBatchesResponse' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Batches summary: List all batches for the current user. description: List all batches for the current user. operationId: list_batches_v1_batches_get parameters: - name: after in: query required: false schema: anyOf: - type: string - type: 'null' description: Optional cursor for pagination. Returns batches after this ID. title: After description: Optional cursor for pagination. Returns batches after this ID. - name: limit in: query required: false schema: type: integer description: Maximum number of batches to return. Defaults to 20. default: 20 title: Limit description: Maximum number of batches to return. Defaults to 20. post: responses: '200': description: The created batch object. content: application/json: schema: $ref: '#/components/schemas/Batch' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response '409': description: 'Conflict: The idempotency key was previously used with different parameters.' tags: - Batches summary: Create a new batch for processing multiple API requests. description: Create a new batch for processing multiple API requests. operationId: create_batch_v1_batches_post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateBatchRequest' /v1/batches/{batch_id}: get: responses: '200': description: The batch object. content: application/json: schema: $ref: '#/components/schemas/Batch' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Batches summary: Retrieve information about a specific batch. description: Retrieve information about a specific batch. operationId: retrieve_batch_v1_batches__batch_id__get parameters: - name: batch_id in: path required: true schema: type: string description: The ID of the batch to retrieve. title: Batch Id description: The ID of the batch to retrieve. /v1/batches/{batch_id}/cancel: post: responses: '200': description: The updated batch object. content: application/json: schema: $ref: '#/components/schemas/Batch' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Batches summary: Cancel a batch that is in progress. description: Cancel a batch that is in progress. operationId: cancel_batch_v1_batches__batch_id__cancel_post parameters: - name: batch_id in: path required: true schema: type: string description: The ID of the batch to cancel. title: Batch Id description: The ID of the batch to cancel. /v1/chat/completions: get: responses: '200': description: A ListOpenAIChatCompletionResponse. content: application/json: schema: $ref: '#/components/schemas/ListOpenAIChatCompletionResponse' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Inference summary: List chat completions. description: List chat completions. operationId: list_chat_completions_v1_chat_completions_get parameters: - name: after in: query required: false schema: anyOf: - type: string - type: 'null' description: The ID of the last chat completion to return. title: After description: The ID of the last chat completion to return. - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: The maximum number of chat completions to return. default: 20 title: Limit description: The maximum number of chat completions to return. - name: model in: query required: false schema: anyOf: - type: string - type: 'null' description: The model to filter by. title: Model description: The model to filter by. - name: order in: query required: false schema: anyOf: - $ref: '#/components/schemas/Order' - type: 'null' description: 'The order to sort the chat completions by: "asc" or "desc". Defaults to "desc".' default: desc title: Order description: 'The order to sort the chat completions by: "asc" or "desc". Defaults to "desc".' post: responses: '200': description: An OpenAIChatCompletion. When streaming, returns Server-Sent Events (SSE) with OpenAIChatCompletionChunk objects. content: application/json: schema: $ref: '#/components/schemas/OpenAIChatCompletion' text/event-stream: schema: $ref: '#/components/schemas/OpenAIChatCompletionChunk' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Inference summary: Create chat completions. description: Generate an OpenAI-compatible chat completion for the given messages using the specified model. operationId: openai_chat_completion_v1_chat_completions_post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OpenAIChatCompletionRequestWithExtraBody' /v1/chat/completions/{completion_id}: get: responses: '200': description: A OpenAICompletionWithInputMessages. content: application/json: schema: $ref: '#/components/schemas/OpenAICompletionWithInputMessages' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Inference summary: Get chat completion. description: Describe a chat completion by its ID. operationId: get_chat_completion_v1_chat_completions__completion_id__get parameters: - name: completion_id in: path required: true schema: type: string description: ID of the chat completion. title: Completion Id description: ID of the chat completion. /v1/completions: post: responses: '200': description: An OpenAICompletion. When streaming, returns Server-Sent Events (SSE) with OpenAICompletion chunks. content: application/json: schema: $ref: '#/components/schemas/OpenAICompletion' text/event-stream: schema: $ref: '#/components/schemas/OpenAICompletion' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - Inference summary: Create completion. description: Generate an OpenAI-compatible completion for the given prompt using the specified model. operationId: openai_completion_v1_completions_post requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenAICompletionRequestWithExtraBody' required: true /v1/conversations: post: responses: '200': description: The created conversation object. content: application/json: schema: $ref: '#/components/schemas/Conversation' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - Conversations summary: Create a conversation. description: Create a conversation. operationId: create_conversation_v1_conversations_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateConversationRequest' required: true /v1/conversations/{conversation_id}: get: responses: '200': description: The conversation object. content: application/json: schema: $ref: '#/components/schemas/Conversation' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Conversations summary: Retrieve a conversation. description: Get a conversation with the given ID. operationId: get_conversation_v1_conversations__conversation_id__get parameters: - name: conversation_id in: path required: true schema: type: string description: The conversation identifier. title: Conversation Id description: The conversation identifier. post: responses: '200': description: The updated conversation object. content: application/json: schema: $ref: '#/components/schemas/Conversation' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Conversations summary: Update a conversation. description: Update a conversation's metadata with the given ID. operationId: update_conversation_v1_conversations__conversation_id__post parameters: - name: conversation_id in: path required: true schema: type: string description: The conversation identifier. title: Conversation Id description: The conversation identifier. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateConversationRequest' delete: responses: '200': description: The deleted conversation resource. content: application/json: schema: $ref: '#/components/schemas/ConversationDeletedResource' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Conversations summary: Delete a conversation. description: Delete a conversation with the given ID. operationId: delete_conversation_v1_conversations__conversation_id__delete parameters: - name: conversation_id in: path required: true schema: type: string description: The conversation identifier. title: Conversation Id description: The conversation identifier. /v1/conversations/{conversation_id}/items: get: responses: '200': description: List of conversation items. content: application/json: schema: $ref: '#/components/schemas/ConversationItemList' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Conversations summary: List items. description: List items in the conversation. operationId: list_items_v1_conversations__conversation_id__items_get parameters: - name: conversation_id in: path required: true schema: type: string description: The conversation identifier. title: Conversation Id description: The conversation identifier. - name: after in: query required: false schema: anyOf: - type: string - type: 'null' title: After - name: include in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/ConversationItemInclude' - type: 'null' title: Include - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' title: Limit - name: order in: query required: false schema: anyOf: - enum: - asc - desc type: string - type: 'null' title: Order post: responses: '200': description: List of created items. content: application/json: schema: $ref: '#/components/schemas/ConversationItemList' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Conversations summary: Create items. description: Create items in the conversation. operationId: add_items_v1_conversations__conversation_id__items_post parameters: - name: conversation_id in: path required: true schema: type: string description: The conversation identifier. title: Conversation Id description: The conversation identifier. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddItemsRequest' /v1/conversations/{conversation_id}/items/{item_id}: get: responses: '200': description: The conversation item. content: application/json: schema: oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage-Output' - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' discriminator: propertyName: type mapping: message: '#/components/schemas/OpenAIResponseMessage-Output' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: Response Retrieve Item V1 Conversations Conversation Id Items Item Id Get '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Conversations summary: Retrieve an item. description: Retrieve a conversation item. operationId: retrieve_item_v1_conversations__conversation_id__items__item_id__get parameters: - name: conversation_id in: path required: true schema: type: string description: The conversation identifier. title: Conversation Id description: The conversation identifier. - name: item_id in: path required: true schema: type: string description: The item identifier. title: Item Id description: The item identifier. delete: responses: '200': description: The deleted item resource. content: application/json: schema: $ref: '#/components/schemas/ConversationItemDeletedResource' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Conversations summary: Delete an item. description: Delete a conversation item. operationId: delete_item_v1_conversations__conversation_id__items__item_id__delete parameters: - name: conversation_id in: path required: true schema: type: string description: The conversation identifier. title: Conversation Id description: The conversation identifier. - name: item_id in: path required: true schema: type: string description: The item identifier. title: Item Id description: The item identifier. /v1/embeddings: post: responses: '200': description: An OpenAIEmbeddingsResponse containing the embeddings. content: application/json: schema: $ref: '#/components/schemas/OpenAIEmbeddingsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - Inference summary: Create embeddings. description: Generate OpenAI-compatible embeddings for the given input using the specified model. operationId: openai_embeddings_v1_embeddings_post requestBody: content: application/json: schema: $ref: '#/components/schemas/OpenAIEmbeddingsRequestWithExtraBody' required: true /v1/files: get: responses: '200': description: The list of files. content: application/json: schema: $ref: '#/components/schemas/ListOpenAIFileResponse' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Files summary: List files description: List files operationId: list_files_v1_files_get parameters: - name: after in: query required: false schema: anyOf: - type: string - type: 'null' description: A cursor for pagination. Returns files after this ID. title: After description: A cursor for pagination. Returns files after this ID. - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Maximum number of files to return (1-10,000). default: 10000 title: Limit description: Maximum number of files to return (1-10,000). - name: order in: query required: false schema: anyOf: - $ref: '#/components/schemas/Order' - type: 'null' description: Sort order by created_at timestamp ('asc' or 'desc'). default: desc title: Order description: Sort order by created_at timestamp ('asc' or 'desc'). - name: purpose in: query required: false schema: anyOf: - $ref: '#/components/schemas/OpenAIFilePurpose' - type: 'null' description: Filter files by purpose. title: Purpose description: Filter files by purpose. post: responses: '200': description: The uploaded file. content: application/json: schema: $ref: '#/components/schemas/OpenAIFileObject' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Files summary: Upload file description: Upload a file. operationId: upload_file_v1_files_post requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/Body_upload_file_v1_files_post' /v1/files/{file_id}: get: responses: '200': description: The file. content: application/json: schema: $ref: '#/components/schemas/OpenAIFileObject' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Files summary: Get file description: Get file operationId: get_file_v1_files__file_id__get parameters: - name: file_id in: path required: true schema: type: string description: The ID of the file to retrieve. title: File Id description: The ID of the file to retrieve. delete: responses: '200': description: The file was deleted. content: application/json: schema: $ref: '#/components/schemas/OpenAIFileDeleteResponse' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Files summary: Delete file description: Delete file operationId: delete_file_v1_files__file_id__delete parameters: - name: file_id in: path required: true schema: type: string description: The ID of the file to delete. title: File Id description: The ID of the file to delete. /v1/files/{file_id}/content: get: responses: '200': description: The raw file content as a binary response. content: application/json: schema: $ref: '#/components/schemas/Response' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Files summary: Retrieve file content description: Retrieve file content operationId: retrieve_file_content_v1_files__file_id__content_get parameters: - name: file_id in: path required: true schema: type: string description: The ID of the file to retrieve content from. title: File Id description: The ID of the file to retrieve content from. /v1/health: get: responses: '200': description: Health information indicating if the service is operational. content: application/json: schema: $ref: '#/components/schemas/HealthInfo' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - Inspect summary: Get health status. description: Get the current health status of the service. operationId: health_v1_health_get x-public: true /v1/inspect/routes: get: responses: '200': description: Response containing information about all available routes. content: application/json: schema: $ref: '#/components/schemas/ListRoutesResponse' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Inspect summary: List routes. description: List all available API routes with their methods and implementing providers. operationId: list_routes_v1_inspect_routes_get parameters: - name: api_filter in: query required: false schema: anyOf: - enum: - v1 - v1alpha - v1beta - deprecated type: string - type: 'null' description: Optional filter to control which routes are returned. Can be an API level ('v1', 'v1alpha', 'v1beta') to show non-deprecated routes at that level, or 'deprecated' to show deprecated routes across all levels. If not specified, returns all non-deprecated routes. title: Api Filter description: Optional filter to control which routes are returned. Can be an API level ('v1', 'v1alpha', 'v1beta') to show non-deprecated routes at that level, or 'deprecated' to show deprecated routes across all levels. If not specified, returns all non-deprecated routes. /v1/models: get: responses: '200': description: A list of OpenAI model objects. content: application/json: schema: $ref: '#/components/schemas/OpenAIListModelsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - Models summary: List models using the OpenAI API. description: List models using the OpenAI API. operationId: openai_list_models_v1_models_get /v1/models/{model_id}: get: responses: '200': description: The model object. content: application/json: schema: $ref: '#/components/schemas/Model' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Models summary: Get a model by its identifier. description: Get a model by its identifier. operationId: get_model_v1_models__model_id__get parameters: - name: model_id in: path required: true schema: type: string description: The ID of the model to get. title: Model Id description: The ID of the model to get. /v1/moderations: post: responses: '200': description: The moderation results for the input. content: application/json: schema: $ref: '#/components/schemas/ModerationObject' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - Safety summary: Create Moderation description: Classifies if text inputs are potentially harmful. OpenAI-compatible endpoint. operationId: run_moderation_v1_moderations_post requestBody: content: application/json: schema: $ref: '#/components/schemas/RunModerationRequest' required: true /v1/prompts: get: responses: '200': description: A ListPromptsResponse containing all prompts. content: application/json: schema: $ref: '#/components/schemas/ListPromptsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - Prompts summary: List all prompts. description: List all prompts. operationId: list_prompts_v1_prompts_get post: responses: '200': description: The created Prompt resource. content: application/json: schema: $ref: '#/components/schemas/Prompt' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - Prompts summary: Create a prompt. description: Create a new prompt. operationId: create_prompt_v1_prompts_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePromptRequest' required: true /v1/prompts/{prompt_id}: get: responses: '200': description: A Prompt resource. content: application/json: schema: $ref: '#/components/schemas/Prompt' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Prompts summary: Get a prompt. description: Get a prompt by its identifier and optional version. operationId: get_prompt_v1_prompts__prompt_id__get parameters: - name: prompt_id in: path required: true schema: type: string description: The identifier of the prompt to get. title: Prompt Id description: The identifier of the prompt to get. - name: version in: query required: false schema: anyOf: - type: integer - type: 'null' description: The version of the prompt to get (defaults to latest). title: Version description: The version of the prompt to get (defaults to latest). put: responses: '200': description: The updated Prompt resource with incremented version. content: application/json: schema: $ref: '#/components/schemas/Prompt' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Prompts summary: Update a prompt. description: Update an existing prompt (increments version). operationId: update_prompt_v1_prompts__prompt_id__put parameters: - name: prompt_id in: path required: true schema: type: string description: The identifier of the prompt to update. title: Prompt Id description: The identifier of the prompt to update. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePromptBodyRequest' delete: responses: '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response '204': description: The prompt was successfully deleted. tags: - Prompts summary: Delete a prompt. description: Delete a prompt. operationId: delete_prompt_v1_prompts__prompt_id__delete parameters: - name: prompt_id in: path required: true schema: type: string description: The identifier of the prompt to delete. title: Prompt Id description: The identifier of the prompt to delete. /v1/prompts/{prompt_id}/set-default-version: put: responses: '200': description: The prompt with the specified version now set as default. content: application/json: schema: $ref: '#/components/schemas/Prompt' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Prompts summary: Set prompt version. description: Set which version of a prompt should be the default in get_prompt (latest). operationId: set_default_version_v1_prompts__prompt_id__set_default_version_put parameters: - name: prompt_id in: path required: true schema: type: string description: The identifier of the prompt. title: Prompt Id description: The identifier of the prompt. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetDefaultVersionBodyRequest' /v1/prompts/{prompt_id}/versions: get: responses: '200': description: A ListPromptsResponse containing all versions of the prompt. content: application/json: schema: $ref: '#/components/schemas/ListPromptsResponse' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Prompts summary: List prompt versions. description: List all versions of a specific prompt. operationId: list_prompt_versions_v1_prompts__prompt_id__versions_get parameters: - name: prompt_id in: path required: true schema: type: string description: The identifier of the prompt to list versions for. title: Prompt Id description: The identifier of the prompt to list versions for. /v1/providers: get: responses: '200': description: A ListProvidersResponse containing information about all providers. content: application/json: schema: $ref: '#/components/schemas/ListProvidersResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - Providers summary: List providers. description: List all available providers. operationId: list_providers_v1_providers_get /v1/providers/{provider_id}: get: responses: '200': description: A ProviderInfo object containing the provider's details. content: application/json: schema: $ref: '#/components/schemas/ProviderInfo' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Providers summary: Get provider. description: Get detailed information about a specific provider. operationId: inspect_provider_v1_providers__provider_id__get parameters: - name: provider_id in: path required: true schema: type: string description: The ID of the provider to inspect. title: Provider Id description: The ID of the provider to inspect. /v1/responses: get: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListOpenAIResponseObject' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Agents summary: List all responses. description: List all responses. operationId: list_openai_responses_v1_responses_get parameters: - name: after in: query required: false schema: anyOf: - type: string - type: 'null' description: The ID of the last response to return. title: After description: The ID of the last response to return. - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: The number of responses to return. default: 50 title: Limit description: The number of responses to return. - name: model in: query required: false schema: anyOf: - type: string - type: 'null' description: The model to filter responses by. title: Model description: The model to filter responses by. - name: order in: query required: false schema: anyOf: - $ref: '#/components/schemas/Order' - type: 'null' description: The order to sort responses by when sorted by created_at ('asc' or 'desc'). default: desc title: Order description: The order to sort responses by when sorted by created_at ('asc' or 'desc'). post: responses: '200': description: An OpenAIResponseObject or a stream of OpenAIResponseObjectStream. content: application/json: schema: $ref: '#/components/schemas/OpenAIResponseObject' text/event-stream: schema: $ref: '#/components/schemas/OpenAIResponseObjectStream' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Agents summary: Create a model response. description: Create a model response. operationId: create_openai_response_v1_responses_post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateResponseRequest' /v1/responses/{response_id}: get: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OpenAIResponseObject' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Agents summary: Get a model response. description: Get a model response. operationId: get_openai_response_v1_responses__response_id__get parameters: - name: response_id in: path required: true schema: type: string description: The ID of the OpenAI response to retrieve. title: Response Id description: The ID of the OpenAI response to retrieve. delete: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OpenAIDeleteResponseObject' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Agents summary: Delete a response. description: Delete a response. operationId: delete_openai_response_v1_responses__response_id__delete parameters: - name: response_id in: path required: true schema: type: string description: The ID of the OpenAI response to delete. title: Response Id description: The ID of the OpenAI response to delete. /v1/responses/{response_id}/input_items: get: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListOpenAIResponseInputItem' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Agents summary: List input items. description: List input items. operationId: list_openai_response_input_items_v1_responses__response_id__input_items_get parameters: - name: response_id in: path required: true schema: type: string description: The ID of the response to retrieve input items for. title: Response Id description: The ID of the response to retrieve input items for. - name: after in: query required: false schema: anyOf: - type: string - type: 'null' description: An item ID to list items after, used for pagination. title: After description: An item ID to list items after, used for pagination. - name: before in: query required: false schema: anyOf: - type: string - type: 'null' description: An item ID to list items before, used for pagination. title: Before description: An item ID to list items before, used for pagination. - name: include in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/ResponseItemInclude' - type: 'null' description: Additional fields to include in the response. title: Include description: Additional fields to include in the response. - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20 title: Limit description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. - name: order in: query required: false schema: anyOf: - $ref: '#/components/schemas/Order' - type: 'null' description: The order to return the input items in. default: desc title: Order description: The order to return the input items in. /v1/safety/run-shield: post: responses: '200': description: The shield response indicating any violations detected. content: application/json: schema: $ref: '#/components/schemas/RunShieldResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - Safety summary: Run Shield description: Run a safety shield on messages to check for policy violations. operationId: run_shield_v1_safety_run_shield_post requestBody: content: application/json: schema: $ref: '#/components/schemas/RunShieldRequest' required: true /v1/scoring-functions: get: responses: '200': description: A ListScoringFunctionsResponse. content: application/json: schema: $ref: '#/components/schemas/ListScoringFunctionsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - Scoring Functions summary: List all scoring functions. description: List all scoring functions. operationId: list_scoring_functions_v1_scoring_functions_get /v1/scoring-functions/{scoring_fn_id}: get: responses: '200': description: A ScoringFn. content: application/json: schema: $ref: '#/components/schemas/ScoringFn' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Scoring Functions summary: Get a scoring function by its ID. description: Get a scoring function by its ID. operationId: get_scoring_function_v1_scoring_functions__scoring_fn_id__get parameters: - name: scoring_fn_id in: path required: true schema: type: string description: The ID of the scoring function to get. title: Scoring Fn Id description: The ID of the scoring function to get. /v1/scoring/score: post: responses: '200': description: A ScoreResponse object containing rows and aggregated results. content: application/json: schema: $ref: '#/components/schemas/ScoreResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - Scoring summary: Score a list of rows. description: Score a list of rows. operationId: score_v1_scoring_score_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ScoreRequest' required: true /v1/scoring/score-batch: post: responses: '200': description: A ScoreBatchResponse. content: application/json: schema: $ref: '#/components/schemas/ScoreBatchResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - Scoring summary: Score a batch of rows. description: Score a batch of rows. operationId: score_batch_v1_scoring_score_batch_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ScoreBatchRequest' required: true /v1/shields: get: responses: '200': description: A ListShieldsResponse. content: application/json: schema: $ref: '#/components/schemas/ListShieldsResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - Shields summary: List all shields. description: List all shields. operationId: list_shields_v1_shields_get /v1/shields/{identifier}: get: responses: '200': description: A Shield. content: application/json: schema: $ref: '#/components/schemas/Shield' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - Shields summary: Get a shield by its identifier. description: Get a shield by its identifier. operationId: get_shield_v1_shields__identifier__get parameters: - name: identifier in: path required: true schema: type: string description: The identifier of the shield to get. title: Identifier description: The identifier of the shield to get. /v1/vector-io/insert: post: responses: '204': description: Chunks were inserted. '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: Insert embedded chunks into a vector database. description: Insert embedded chunks into a vector database. operationId: insert_chunks_v1_vector_io_insert_post requestBody: content: application/json: schema: $ref: '#/components/schemas/InsertChunksRequest' required: true /v1/vector-io/query: post: responses: '200': description: A QueryChunksResponse. content: application/json: schema: $ref: '#/components/schemas/QueryChunksResponse' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - VectorIO summary: Query chunks from a vector database. description: Query chunks from a vector database. operationId: query_chunks_v1_vector_io_query_post requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryChunksRequest' required: true /v1/vector_stores: get: responses: '200': description: A list of vector stores. content: application/json: schema: $ref: '#/components/schemas/VectorStoreListResponse' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - VectorIO summary: List vector stores (OpenAI-compatible). description: List vector stores (OpenAI-compatible). operationId: openai_list_vector_stores_v1_vector_stores_get parameters: - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Maximum number of vector stores to return. default: 20 title: Limit description: Maximum number of vector stores to return. - name: order in: query required: false schema: anyOf: - type: string - type: 'null' description: 'Sort order by created_at: asc or desc.' default: desc title: Order description: 'Sort order by created_at: asc or desc.' - name: after in: query required: false schema: anyOf: - type: string - type: 'null' description: Pagination cursor (after). title: After description: Pagination cursor (after). - name: before in: query required: false schema: anyOf: - type: string - type: 'null' description: Pagination cursor (before). title: Before description: Pagination cursor (before). post: responses: '200': description: The created vector store. content: application/json: schema: $ref: '#/components/schemas/VectorStoreObject' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - VectorIO summary: Create a vector store (OpenAI-compatible). description: Create a vector store (OpenAI-compatible). operationId: openai_create_vector_store_v1_vector_stores_post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OpenAICreateVectorStoreRequestWithExtraBody' /v1/vector_stores/{vector_store_id}: get: responses: '200': description: The vector store. content: application/json: schema: $ref: '#/components/schemas/VectorStoreObject' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - VectorIO summary: Retrieve a vector store (OpenAI-compatible). description: Retrieve a vector store (OpenAI-compatible). operationId: openai_retrieve_vector_store_v1_vector_stores__vector_store_id__get parameters: - name: vector_store_id in: path required: true schema: type: string description: The vector store identifier. title: Vector Store Id description: The vector store identifier. post: responses: '200': description: The updated vector store. content: application/json: schema: $ref: '#/components/schemas/VectorStoreObject' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - VectorIO summary: Update a vector store (OpenAI-compatible). description: Update a vector store (OpenAI-compatible). operationId: openai_update_vector_store_v1_vector_stores__vector_store_id__post parameters: - name: vector_store_id in: path required: true schema: type: string description: The vector store identifier. title: Vector Store Id description: The vector store identifier. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OpenAIUpdateVectorStoreRequest' delete: responses: '200': description: Vector store deleted. content: application/json: schema: $ref: '#/components/schemas/VectorStoreDeleteResponse' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - VectorIO summary: Delete a vector store (OpenAI-compatible). description: Delete a vector store (OpenAI-compatible). operationId: openai_delete_vector_store_v1_vector_stores__vector_store_id__delete parameters: - name: vector_store_id in: path required: true schema: type: string description: The vector store identifier. title: Vector Store Id description: The vector store identifier. /v1/vector_stores/{vector_store_id}/file_batches: post: responses: '200': description: The created file batch. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFileBatchObject' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - VectorIO summary: Create a vector store file batch (OpenAI-compatible). description: Create a vector store file batch (OpenAI-compatible). operationId: openai_create_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches_post parameters: - name: vector_store_id in: path required: true schema: type: string description: The vector store identifier. title: Vector Store Id description: The vector store identifier. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OpenAICreateVectorStoreFileBatchRequestWithExtraBody' /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}: get: responses: '200': description: The file batch. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFileBatchObject' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - VectorIO summary: Retrieve a vector store file batch (OpenAI-compatible). description: Retrieve a vector store file batch (OpenAI-compatible). operationId: openai_retrieve_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__get parameters: - name: vector_store_id in: path required: true schema: type: string description: The vector store identifier. title: Vector Store Id description: The vector store identifier. - name: batch_id in: path required: true schema: type: string description: The file batch identifier. title: Batch Id description: The file batch identifier. /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel: post: responses: '200': description: The cancelled file batch. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFileBatchObject' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - VectorIO summary: Cancel a vector store file batch (OpenAI-compatible). description: Cancel a vector store file batch (OpenAI-compatible). operationId: openai_cancel_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__cancel_post parameters: - name: vector_store_id in: path required: true schema: type: string description: The vector store identifier. title: Vector Store Id description: The vector store identifier. - name: batch_id in: path required: true schema: type: string description: The file batch identifier. title: Batch Id description: The file batch identifier. /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files: get: responses: '200': description: A list of files in the file batch. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFilesListInBatchResponse' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - VectorIO summary: List files in a vector store file batch (OpenAI-compatible). description: List files in a vector store file batch (OpenAI-compatible). operationId: openai_list_files_in_vector_store_file_batch_v1_vector_stores__vector_store_id__file_batches__batch_id__files_get parameters: - name: vector_store_id in: path required: true schema: type: string description: The vector store identifier. title: Vector Store Id description: The vector store identifier. - name: batch_id in: path required: true schema: type: string description: The file batch identifier. title: Batch Id description: The file batch identifier. - name: after in: query required: false schema: anyOf: - type: string - type: 'null' description: Pagination cursor (after). title: After description: Pagination cursor (after). - name: before in: query required: false schema: anyOf: - type: string - type: 'null' description: Pagination cursor (before). title: Before description: Pagination cursor (before). - name: filter in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by file status. title: Filter description: Filter by file status. - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Maximum number of files to return. default: 20 title: Limit description: Maximum number of files to return. - name: order in: query required: false schema: anyOf: - type: string - type: 'null' description: 'Sort order by created_at: asc or desc.' default: desc title: Order description: 'Sort order by created_at: asc or desc.' /v1/vector_stores/{vector_store_id}/files: get: responses: '200': description: A list of files in the vector store. content: application/json: schema: $ref: '#/components/schemas/VectorStoreListFilesResponse' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - VectorIO summary: List files in a vector store (OpenAI-compatible). description: List files in a vector store (OpenAI-compatible). operationId: openai_list_files_in_vector_store_v1_vector_stores__vector_store_id__files_get parameters: - name: vector_store_id in: path required: true schema: type: string description: The vector store identifier. title: Vector Store Id description: The vector store identifier. - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Maximum number of files to return. default: 20 title: Limit description: Maximum number of files to return. - name: order in: query required: false schema: anyOf: - type: string - type: 'null' description: 'Sort order by created_at: asc or desc.' default: desc title: Order description: 'Sort order by created_at: asc or desc.' - name: after in: query required: false schema: anyOf: - type: string - type: 'null' description: Pagination cursor (after). title: After description: Pagination cursor (after). - name: before in: query required: false schema: anyOf: - type: string - type: 'null' description: Pagination cursor (before). title: Before description: Pagination cursor (before). - name: filter in: query required: false schema: description: Filter by file status. title: Filter type: string enum: - completed - in_progress - cancelled - failed default: completed nullable: true description: Filter by file status. post: responses: '200': description: The attached file. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFileObject' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - VectorIO summary: Attach a file to a vector store (OpenAI-compatible). description: Attach a file to a vector store (OpenAI-compatible). operationId: openai_attach_file_to_vector_store_v1_vector_stores__vector_store_id__files_post parameters: - name: vector_store_id in: path required: true schema: type: string description: The vector store identifier. title: Vector Store Id description: The vector store identifier. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OpenAIAttachFileRequest' /v1/vector_stores/{vector_store_id}/files/{file_id}: get: responses: '200': description: The vector store file. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFileObject' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - VectorIO summary: Retrieve a vector store file (OpenAI-compatible). description: Retrieve a vector store file (OpenAI-compatible). operationId: openai_retrieve_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__get parameters: - name: vector_store_id in: path required: true schema: type: string description: The vector store identifier. title: Vector Store Id description: The vector store identifier. - name: file_id in: path required: true schema: type: string description: The file identifier. title: File Id description: The file identifier. post: responses: '200': description: The updated vector store file. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFileObject' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - VectorIO summary: Update a vector store file (OpenAI-compatible). description: Update a vector store file (OpenAI-compatible). operationId: openai_update_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__post parameters: - name: vector_store_id in: path required: true schema: type: string description: The vector store identifier. title: Vector Store Id description: The vector store identifier. - name: file_id in: path required: true schema: type: string description: The file identifier. title: File Id description: The file identifier. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OpenAIUpdateVectorStoreFileRequest' delete: responses: '200': description: The vector store file was deleted. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFileDeleteResponse' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - VectorIO summary: Delete a vector store file (OpenAI-compatible). description: Delete a vector store file (OpenAI-compatible). operationId: openai_delete_vector_store_file_v1_vector_stores__vector_store_id__files__file_id__delete parameters: - name: vector_store_id in: path required: true schema: type: string description: The vector store identifier. title: Vector Store Id description: The vector store identifier. - name: file_id in: path required: true schema: type: string description: The file identifier. title: File Id description: The file identifier. /v1/vector_stores/{vector_store_id}/files/{file_id}/content: get: responses: '200': description: The vector store file contents. content: application/json: schema: $ref: '#/components/schemas/VectorStoreFileContentResponse' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - VectorIO summary: Retrieve vector store file contents (OpenAI-compatible). description: Retrieve vector store file contents (OpenAI-compatible). operationId: openai_retrieve_vector_store_file_contents_v1_vector_stores__vector_store_id__files__file_id__content_get parameters: - name: vector_store_id in: path required: true schema: type: string description: The vector store identifier. title: Vector Store Id description: The vector store identifier. - name: file_id in: path required: true schema: type: string description: The file identifier. title: File Id description: The file identifier. - name: include_embeddings in: query required: false schema: anyOf: - type: boolean - type: 'null' description: Include embedding vectors. default: false title: Include Embeddings description: Include embedding vectors. - name: include_metadata in: query required: false schema: anyOf: - type: boolean - type: 'null' description: Include chunk metadata. default: false title: Include Metadata description: Include chunk metadata. /v1/vector_stores/{vector_store_id}/search: post: responses: '200': description: Search results. content: application/json: schema: $ref: '#/components/schemas/VectorStoreSearchResponsePage' '400': $ref: '#/components/responses/BadRequest400' description: Bad Request '429': $ref: '#/components/responses/TooManyRequests429' description: Too Many Requests '500': $ref: '#/components/responses/InternalServerError500' description: Internal Server Error default: $ref: '#/components/responses/DefaultError' description: Default Response tags: - VectorIO summary: Search a vector store (OpenAI-compatible). description: Search a vector store (OpenAI-compatible). operationId: openai_search_vector_store_v1_vector_stores__vector_store_id__search_post parameters: - name: vector_store_id in: path required: true schema: type: string description: The vector store identifier. title: Vector Store Id description: The vector store identifier. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OpenAISearchVectorStoreRequest' /v1/version: get: responses: '200': description: Version information containing the service version number. content: application/json: schema: $ref: '#/components/schemas/VersionInfo' '400': description: Bad Request $ref: '#/components/responses/BadRequest400' '429': description: Too Many Requests $ref: '#/components/responses/TooManyRequests429' '500': description: Internal Server Error $ref: '#/components/responses/InternalServerError500' default: description: Default Response $ref: '#/components/responses/DefaultError' tags: - Inspect summary: Get version. description: Get the version of the service. operationId: version_v1_version_get x-public: true components: schemas: Error: description: Error response from the API. Roughly follows RFC 7807. properties: status: title: Status type: integer title: title: Title type: string detail: title: Detail type: string instance: anyOf: - type: string - type: 'null' nullable: true required: - status - title - detail title: Error type: object ListBatchesResponse: properties: object: type: string const: list title: Object default: list data: items: $ref: '#/components/schemas/Batch' type: array title: Data description: List of batch objects first_id: anyOf: - type: string - type: 'null' description: ID of the first batch in the list last_id: anyOf: - type: string - type: 'null' description: ID of the last batch in the list has_more: type: boolean title: Has More description: Whether there are more batches available default: false type: object required: - data title: ListBatchesResponse description: Response containing a list of batch objects. CreateBatchRequest: properties: input_file_id: type: string title: Input File Id description: The ID of an uploaded file containing requests for the batch. endpoint: type: string title: Endpoint description: The endpoint to be used for all requests in the batch. completion_window: type: string const: 24h title: Completion Window description: The time window within which the batch should be processed. metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' description: Optional metadata for the batch. idempotency_key: anyOf: - type: string - type: 'null' description: Optional idempotency key. When provided, enables idempotent behavior. type: object required: - input_file_id - endpoint - completion_window title: CreateBatchRequest description: Request model for creating a batch. Batch: properties: id: type: string title: Id completion_window: type: string title: Completion Window created_at: type: integer title: Created At endpoint: type: string title: Endpoint input_file_id: type: string title: Input File Id object: type: string const: batch title: Object status: type: string enum: - validating - failed - in_progress - finalizing - completed - expired - cancelling - cancelled title: Status cancelled_at: anyOf: - type: integer - type: 'null' cancelling_at: anyOf: - type: integer - type: 'null' completed_at: anyOf: - type: integer - type: 'null' error_file_id: anyOf: - type: string - type: 'null' errors: anyOf: - $ref: '#/components/schemas/Errors' title: Errors - type: 'null' title: Errors expired_at: anyOf: - type: integer - type: 'null' expires_at: anyOf: - type: integer - type: 'null' failed_at: anyOf: - type: integer - type: 'null' finalizing_at: anyOf: - type: integer - type: 'null' in_progress_at: anyOf: - type: integer - type: 'null' metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' model: anyOf: - type: string - type: 'null' output_file_id: anyOf: - type: string - type: 'null' request_counts: anyOf: - $ref: '#/components/schemas/BatchRequestCounts' title: BatchRequestCounts - type: 'null' title: BatchRequestCounts usage: anyOf: - $ref: '#/components/schemas/BatchUsage' title: BatchUsage - type: 'null' title: BatchUsage additionalProperties: true type: object required: - id - completion_window - created_at - endpoint - input_file_id - object - status title: Batch Order: type: string enum: - asc - desc title: Order description: Sort order for paginated responses. ListOpenAIChatCompletionResponse: properties: data: items: $ref: '#/components/schemas/OpenAICompletionWithInputMessages' type: array title: Data description: List of chat completion objects with their input messages. has_more: type: boolean title: Has More description: Whether there are more completions available beyond this list. first_id: type: string title: First Id description: ID of the first completion in this list. last_id: type: string title: Last Id description: ID of the last completion in this list. object: type: string const: list title: Object description: Must be 'list' to identify this as a list response. default: list type: object required: - data - has_more - first_id - last_id title: ListOpenAIChatCompletionResponse description: Response from listing OpenAI-compatible chat completions. OpenAIAssistantMessageParam: description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. properties: role: const: assistant default: assistant description: Must be 'assistant' to identify this as the model's response. title: Role type: string content: anyOf: - type: string - items: $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' type: array title: list[OpenAIChatCompletionContentPartTextParam] - type: 'null' description: The content of the model's response. title: string | list[OpenAIChatCompletionContentPartTextParam] nullable: true name: anyOf: - type: string - type: 'null' description: The name of the assistant message participant. nullable: true tool_calls: anyOf: - items: $ref: '#/components/schemas/OpenAIChatCompletionToolCall' type: array - type: 'null' description: List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object. nullable: true title: OpenAIAssistantMessageParam type: object OpenAIChatCompletionContentPartImageParam: properties: type: type: string const: image_url title: Type description: Must be 'image_url' to identify this as image content. default: image_url image_url: $ref: '#/components/schemas/OpenAIImageURL' description: Image URL specification and processing details. type: object required: - image_url title: OpenAIChatCompletionContentPartImageParam description: Image content part for OpenAI-compatible chat completion messages. OpenAIChatCompletionContentPartParam: discriminator: mapping: file: '#/components/schemas/OpenAIFile' image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' title: OpenAIChatCompletionContentPartTextParam - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' title: OpenAIChatCompletionContentPartImageParam - $ref: '#/components/schemas/OpenAIFile' title: OpenAIFile title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile OpenAIChatCompletionContentPartTextParam: properties: type: type: string const: text title: Type description: Must be 'text' to identify this as text content. default: text text: type: string title: Text description: The text content of the message. type: object required: - text title: OpenAIChatCompletionContentPartTextParam description: Text content part for OpenAI-compatible chat completion messages. OpenAIChatCompletionToolCall: properties: index: anyOf: - type: integer minimum: 0.0 - type: 'null' description: Index of the tool call in the list. id: anyOf: - type: string - type: 'null' description: Unique identifier for the tool call. type: type: string const: function title: Type description: Must be 'function' to identify this as a function call. default: function function: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionToolCallFunction' title: OpenAIChatCompletionToolCallFunction - type: 'null' description: Function call details. title: OpenAIChatCompletionToolCallFunction type: object title: OpenAIChatCompletionToolCall description: Tool call specification for OpenAI-compatible chat completion responses. OpenAIChatCompletionToolCallFunction: properties: name: anyOf: - type: string - type: 'null' description: Name of the function to call. arguments: anyOf: - type: string - type: 'null' description: Arguments to pass to the function as a JSON string. type: object title: OpenAIChatCompletionToolCallFunction description: Function call details for OpenAI-compatible tool calls. OpenAIChatCompletionUsage: properties: prompt_tokens: type: integer minimum: 0.0 title: Prompt Tokens description: Number of tokens in the prompt. completion_tokens: type: integer minimum: 0.0 title: Completion Tokens description: Number of tokens in the completion. total_tokens: type: integer minimum: 0.0 title: Total Tokens description: Total tokens used (prompt + completion). prompt_tokens_details: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionUsagePromptTokensDetails' title: OpenAIChatCompletionUsagePromptTokensDetails - type: 'null' description: Detailed breakdown of input token usage. title: OpenAIChatCompletionUsagePromptTokensDetails completion_tokens_details: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails' title: OpenAIChatCompletionUsageCompletionTokensDetails - type: 'null' description: Detailed breakdown of output token usage. title: OpenAIChatCompletionUsageCompletionTokensDetails type: object required: - prompt_tokens - completion_tokens - total_tokens title: OpenAIChatCompletionUsage description: Usage information for OpenAI chat completion. OpenAIChoice: properties: message: oneOf: - $ref: '#/components/schemas/OpenAIUserMessageParam-Output' title: OpenAIUserMessageParam-Output - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' title: OpenAIAssistantMessageParam-Output - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam title: OpenAIUserMessageParam-Output | ... (5 variants) description: The message from the model. discriminator: propertyName: role mapping: assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' developer: '#/components/schemas/OpenAIDeveloperMessageParam' system: '#/components/schemas/OpenAISystemMessageParam' tool: '#/components/schemas/OpenAIToolMessageParam' user: '#/components/schemas/OpenAIUserMessageParam-Output' finish_reason: type: string enum: - stop - length - tool_calls - content_filter - function_call title: Finish Reason description: The reason the model stopped generating. index: type: integer minimum: 0.0 title: Index description: The index of the choice. logprobs: anyOf: - $ref: '#/components/schemas/OpenAIChoiceLogprobs' title: OpenAIChoiceLogprobs - type: 'null' description: The log probabilities for the tokens in the message. title: OpenAIChoiceLogprobs type: object required: - message - finish_reason - index title: OpenAIChoice description: A choice from an OpenAI-compatible chat completion response. OpenAIChoiceLogprobs: properties: content: anyOf: - items: $ref: '#/components/schemas/OpenAITokenLogProb' type: array - type: 'null' description: The log probabilities for the tokens in the message. refusal: anyOf: - items: $ref: '#/components/schemas/OpenAITokenLogProb' type: array - type: 'null' description: The log probabilities for the refusal tokens. type: object title: OpenAIChoiceLogprobs description: The log probabilities for the tokens in the message from an OpenAI-compatible chat completion response. OpenAIDeveloperMessageParam: properties: role: type: string const: developer title: Role description: Must be 'developer' to identify this as a developer message. default: developer content: anyOf: - type: string - items: $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' type: array title: list[OpenAIChatCompletionContentPartTextParam] title: string | list[OpenAIChatCompletionContentPartTextParam] description: The content of the developer message. name: anyOf: - type: string - type: 'null' description: The name of the developer message participant. type: object required: - content title: OpenAIDeveloperMessageParam description: A message from the developer in an OpenAI-compatible chat completion request. OpenAIFile: properties: type: type: string const: file title: Type description: Must be 'file' to identify this as file content. default: file file: $ref: '#/components/schemas/OpenAIFileFile' description: File specification. type: object required: - file title: OpenAIFile OpenAIFileFile: properties: file_data: anyOf: - type: string - type: 'null' description: Base64-encoded file data. file_id: anyOf: - type: string - type: 'null' description: ID of an uploaded file. filename: anyOf: - type: string - type: 'null' description: Name of the file. type: object title: OpenAIFileFile description: File reference for OpenAI-compatible file content. OpenAIImageURL: properties: url: type: string title: Url description: URL of the image to include in the message. detail: anyOf: - type: string enum: - low - high - auto - type: 'null' description: Level of detail for image processing. Can be 'low', 'high', or 'auto'. type: object required: - url title: OpenAIImageURL description: Image URL specification for OpenAI-compatible chat completion messages. OpenAIMessageParam: discriminator: mapping: assistant: '#/components/schemas/OpenAIAssistantMessageParam' developer: '#/components/schemas/OpenAIDeveloperMessageParam' system: '#/components/schemas/OpenAISystemMessageParam' tool: '#/components/schemas/OpenAIToolMessageParam' user: '#/components/schemas/OpenAIUserMessageParam' propertyName: role oneOf: - $ref: '#/components/schemas/OpenAIUserMessageParam' title: OpenAIUserMessageParam - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - $ref: '#/components/schemas/OpenAIAssistantMessageParam' title: OpenAIAssistantMessageParam - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam title: OpenAIUserMessageParam | ... (5 variants) OpenAISystemMessageParam: properties: role: type: string const: system title: Role description: Must be 'system' to identify this as a system message. default: system content: anyOf: - type: string - items: $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' type: array title: list[OpenAIChatCompletionContentPartTextParam] title: string | list[OpenAIChatCompletionContentPartTextParam] description: The content of the 'system prompt'. If multiple system messages are provided, they are concatenated. name: anyOf: - type: string - type: 'null' description: The name of the system message participant. type: object required: - content title: OpenAISystemMessageParam description: A system message providing instructions or context to the model. OpenAITokenLogProb: properties: token: type: string title: Token description: The token. bytes: anyOf: - items: type: integer type: array - type: 'null' description: The bytes for the token. logprob: type: number title: Logprob description: The log probability of the token. top_logprobs: anyOf: - items: $ref: '#/components/schemas/OpenAITopLogProb' type: array - type: 'null' description: The top log probabilities for the token. type: object required: - token - logprob title: OpenAITokenLogProb description: The log probability for a token from an OpenAI-compatible chat completion response. OpenAIToolMessageParam: properties: role: type: string const: tool title: Role description: Must be 'tool' to identify this as a tool response. default: tool tool_call_id: type: string title: Tool Call Id description: Unique identifier for the tool call this response is for. content: anyOf: - type: string - items: $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' type: array title: list[OpenAIChatCompletionContentPartTextParam] title: string | list[OpenAIChatCompletionContentPartTextParam] description: The response content from the tool. type: object required: - tool_call_id - content title: OpenAIToolMessageParam description: A message representing the result of a tool invocation in an OpenAI-compatible chat completion request. OpenAITopLogProb: properties: token: type: string title: Token description: The token. bytes: anyOf: - items: type: integer type: array - type: 'null' description: The bytes for the token. logprob: type: number title: Logprob description: The log probability of the token. type: object required: - token - logprob title: OpenAITopLogProb description: The top log probability for a token from an OpenAI-compatible chat completion response. OpenAIUserMessageParam: description: A message from the user in an OpenAI-compatible chat completion request. properties: role: const: user default: user description: Must be 'user' to identify this as a user message. title: Role type: string content: anyOf: - type: string - items: discriminator: mapping: file: '#/components/schemas/OpenAIFile' image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' title: OpenAIChatCompletionContentPartTextParam - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' title: OpenAIChatCompletionContentPartImageParam - $ref: '#/components/schemas/OpenAIFile' title: OpenAIFile title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile type: array title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] description: The content of the message, which can include text and other media. title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] name: anyOf: - type: string - type: 'null' description: The name of the user message participant. nullable: true required: - content title: OpenAIUserMessageParam type: object OpenAIJSONSchema: properties: name: type: string title: Name description: anyOf: - type: string - type: 'null' strict: anyOf: - type: boolean - type: 'null' schema: anyOf: - additionalProperties: true type: object - type: 'null' type: object title: OpenAIJSONSchema description: JSON schema specification for OpenAI-compatible structured response format. OpenAIResponseFormatJSONObject: properties: type: type: string const: json_object title: Type description: Must be 'json_object' to indicate generic JSON object response format. default: json_object type: object title: OpenAIResponseFormatJSONObject description: JSON object response format for OpenAI-compatible chat completion requests. OpenAIResponseFormatJSONSchema: properties: type: type: string const: json_schema title: Type description: Must be 'json_schema' to indicate structured JSON response format. default: json_schema json_schema: $ref: '#/components/schemas/OpenAIJSONSchema' description: The JSON schema specification for the response. type: object required: - json_schema title: OpenAIResponseFormatJSONSchema description: JSON schema response format for OpenAI-compatible chat completion requests. OpenAIResponseFormatParam: discriminator: mapping: json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' text: '#/components/schemas/OpenAIResponseFormatText' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseFormatText' title: OpenAIResponseFormatText - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' title: OpenAIResponseFormatJSONSchema - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' title: OpenAIResponseFormatJSONObject title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject OpenAIResponseFormatText: properties: type: type: string const: text title: Type description: Must be 'text' to indicate plain text response format. default: text type: object title: OpenAIResponseFormatText description: Text response format for OpenAI-compatible chat completion requests. OpenAIChatCompletionRequestWithExtraBody: properties: model: type: string title: Model description: The identifier of the model to use. messages: items: oneOf: - $ref: '#/components/schemas/OpenAIUserMessageParam-Input' title: OpenAIUserMessageParam-Input - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' title: OpenAIAssistantMessageParam-Input - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam discriminator: propertyName: role mapping: assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' developer: '#/components/schemas/OpenAIDeveloperMessageParam' system: '#/components/schemas/OpenAISystemMessageParam' tool: '#/components/schemas/OpenAIToolMessageParam' user: '#/components/schemas/OpenAIUserMessageParam-Input' title: OpenAIUserMessageParam-Input | ... (5 variants) type: array minItems: 1 title: Messages description: List of messages in the conversation. frequency_penalty: anyOf: - type: number maximum: 2.0 minimum: -2.0 - type: 'null' description: The penalty for repeated tokens. function_call: anyOf: - type: string - additionalProperties: true type: object - type: 'null' title: string | object description: The function call to use. functions: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' description: List of functions to use. logit_bias: anyOf: - additionalProperties: type: number type: object - type: 'null' description: The logit bias to use. logprobs: anyOf: - type: boolean - type: 'null' description: The log probabilities to use. max_completion_tokens: anyOf: - type: integer minimum: 1.0 - type: 'null' description: The maximum number of tokens to generate. max_tokens: anyOf: - type: integer minimum: 1.0 - type: 'null' description: The maximum number of tokens to generate. n: anyOf: - type: integer minimum: 1.0 - type: 'null' description: The number of completions to generate. parallel_tool_calls: anyOf: - type: boolean - type: 'null' description: Whether to parallelize tool calls. presence_penalty: anyOf: - type: number maximum: 2.0 minimum: -2.0 - type: 'null' description: The penalty for repeated tokens. response_format: anyOf: - oneOf: - $ref: '#/components/schemas/OpenAIResponseFormatText' title: OpenAIResponseFormatText - $ref: '#/components/schemas/OpenAIResponseFormatJSONSchema' title: OpenAIResponseFormatJSONSchema - $ref: '#/components/schemas/OpenAIResponseFormatJSONObject' title: OpenAIResponseFormatJSONObject discriminator: propertyName: type mapping: json_object: '#/components/schemas/OpenAIResponseFormatJSONObject' json_schema: '#/components/schemas/OpenAIResponseFormatJSONSchema' text: '#/components/schemas/OpenAIResponseFormatText' title: OpenAIResponseFormatText | OpenAIResponseFormatJSONSchema | OpenAIResponseFormatJSONObject - type: 'null' title: Response Format description: The response format to use. seed: anyOf: - type: integer - type: 'null' description: The seed to use. stop: anyOf: - type: string - items: type: string type: array title: list[string] - type: 'null' title: string | list[string] description: The stop tokens to use. stream: anyOf: - type: boolean - type: 'null' description: Whether to stream the response. stream_options: anyOf: - additionalProperties: true type: object - type: 'null' description: The stream options to use. temperature: anyOf: - type: number maximum: 2.0 minimum: 0.0 - type: 'null' description: The temperature to use. tool_choice: anyOf: - type: string - additionalProperties: true type: object - type: 'null' title: string | object description: The tool choice to use. tools: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' description: The tools to use. top_logprobs: anyOf: - type: integer minimum: 0.0 - type: 'null' description: The top log probabilities to use. top_p: anyOf: - type: number maximum: 1.0 minimum: 0.0 - type: 'null' description: The top p to use. user: anyOf: - type: string - type: 'null' description: The user to use. safety_identifier: anyOf: - type: string maxLength: 64 - type: 'null' description: A stable identifier used for safety monitoring and abuse detection. reasoning_effort: anyOf: - type: string enum: - none - minimal - low - medium - high - xhigh - type: 'null' description: The effort level for reasoning models. additionalProperties: true type: object required: - model - messages title: OpenAIChatCompletionRequestWithExtraBody description: Request parameters for OpenAI-compatible chat completion endpoint. OpenAIChatCompletion: description: Response from an OpenAI-compatible chat completion request. properties: id: description: The ID of the chat completion. title: Id type: string choices: description: List of choices. items: $ref: '#/components/schemas/OpenAIChoice' minItems: 1 title: Choices type: array object: const: chat.completion default: chat.completion description: The object type. title: Object type: string created: description: The Unix timestamp in seconds when the chat completion was created. minimum: 0 title: Created type: integer model: description: The model that was used to generate the chat completion. title: Model type: string usage: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionUsage' title: OpenAIChatCompletionUsage - type: 'null' description: Token usage information for the completion. nullable: true title: OpenAIChatCompletionUsage required: - id - choices - created - model title: OpenAIChatCompletion type: object OpenAIChatCompletionChunk: description: Chunk from a streaming response to an OpenAI-compatible chat completion request. properties: id: description: The ID of the chat completion. title: Id type: string choices: description: List of choices. items: $ref: '#/components/schemas/OpenAIChunkChoice' title: Choices type: array object: const: chat.completion.chunk default: chat.completion.chunk description: The object type. title: Object type: string created: description: The Unix timestamp in seconds when the chat completion was created. minimum: 0 title: Created type: integer model: description: The model that was used to generate the chat completion. title: Model type: string usage: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionUsage' title: OpenAIChatCompletionUsage - type: 'null' description: Token usage information (typically included in final chunk with stream_options). nullable: true title: OpenAIChatCompletionUsage required: - id - choices - created - model title: OpenAIChatCompletionChunk type: object OpenAIChoiceDelta: description: A delta from an OpenAI-compatible chat completion streaming response. properties: content: anyOf: - type: string - type: 'null' description: The content of the delta. nullable: true refusal: anyOf: - type: string - type: 'null' description: The refusal of the delta. nullable: true role: anyOf: - type: string - type: 'null' description: The role of the delta. nullable: true tool_calls: anyOf: - items: $ref: '#/components/schemas/OpenAIChatCompletionToolCall' type: array - type: 'null' description: The tool calls of the delta. nullable: true reasoning_content: anyOf: - type: string - type: 'null' description: The reasoning content from the model (for o1/o3 models). nullable: true title: OpenAIChoiceDelta type: object OpenAIChunkChoice: description: A chunk choice from an OpenAI-compatible chat completion streaming response. properties: delta: $ref: '#/components/schemas/OpenAIChoiceDelta' description: The delta from the chunk. finish_reason: description: The reason the model stopped generating. enum: - stop - length - tool_calls - content_filter - function_call nullable: true title: Finish Reason type: string index: description: The index of the choice. minimum: 0 title: Index type: integer logprobs: anyOf: - $ref: '#/components/schemas/OpenAIChoiceLogprobs' title: OpenAIChoiceLogprobs - type: 'null' description: The log probabilities for the tokens in the message. nullable: true title: OpenAIChoiceLogprobs required: - delta - index title: OpenAIChunkChoice type: object OpenAICompletionWithInputMessages: properties: id: type: string title: Id description: The ID of the chat completion. choices: items: $ref: '#/components/schemas/OpenAIChoice' type: array minItems: 1 title: Choices description: List of choices. object: type: string const: chat.completion title: Object description: The object type. default: chat.completion created: type: integer minimum: 0.0 title: Created description: The Unix timestamp in seconds when the chat completion was created. model: type: string title: Model description: The model that was used to generate the chat completion. usage: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionUsage' title: OpenAIChatCompletionUsage - type: 'null' description: Token usage information for the completion. title: OpenAIChatCompletionUsage input_messages: items: oneOf: - $ref: '#/components/schemas/OpenAIUserMessageParam-Output' title: OpenAIUserMessageParam-Output - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Output' title: OpenAIAssistantMessageParam-Output - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam discriminator: propertyName: role mapping: assistant: '#/components/schemas/OpenAIAssistantMessageParam-Output' developer: '#/components/schemas/OpenAIDeveloperMessageParam' system: '#/components/schemas/OpenAISystemMessageParam' tool: '#/components/schemas/OpenAIToolMessageParam' user: '#/components/schemas/OpenAIUserMessageParam-Output' title: OpenAIUserMessageParam-Output | ... (5 variants) type: array title: Input Messages description: The input messages used to generate this completion. type: object required: - id - choices - created - model - input_messages title: OpenAICompletionWithInputMessages OpenAICompletionRequestWithExtraBody: properties: model: type: string title: Model description: The identifier of the model to use. prompt: anyOf: - type: string - items: type: string type: array title: list[string] - items: type: integer type: array title: list[integer] - items: items: type: integer type: array type: array title: list[array] title: string | ... (4 variants) description: The prompt to generate a completion for. best_of: anyOf: - type: integer minimum: 1.0 - type: 'null' description: The number of completions to generate. echo: anyOf: - type: boolean - type: 'null' description: Whether to echo the prompt. frequency_penalty: anyOf: - type: number maximum: 2.0 minimum: -2.0 - type: 'null' description: The penalty for repeated tokens. logit_bias: anyOf: - additionalProperties: type: number type: object - type: 'null' description: The logit bias to use. logprobs: anyOf: - type: boolean - type: 'null' description: The log probabilities to use. max_tokens: anyOf: - type: integer minimum: 1.0 - type: 'null' description: The maximum number of tokens to generate. n: anyOf: - type: integer minimum: 1.0 - type: 'null' description: The number of completions to generate. presence_penalty: anyOf: - type: number maximum: 2.0 minimum: -2.0 - type: 'null' description: The penalty for repeated tokens. seed: anyOf: - type: integer - type: 'null' description: The seed to use. stop: anyOf: - type: string - items: type: string type: array title: list[string] - type: 'null' title: string | list[string] description: The stop tokens to use. stream: anyOf: - type: boolean - type: 'null' description: Whether to stream the response. stream_options: anyOf: - additionalProperties: true type: object - type: 'null' description: The stream options to use. temperature: anyOf: - type: number maximum: 2.0 minimum: 0.0 - type: 'null' description: The temperature to use. top_p: anyOf: - type: number maximum: 1.0 minimum: 0.0 - type: 'null' description: The top p to use. user: anyOf: - type: string - type: 'null' description: The user to use. suffix: anyOf: - type: string - type: 'null' description: The suffix that should be appended to the completion. additionalProperties: true type: object required: - model - prompt title: OpenAICompletionRequestWithExtraBody description: Request parameters for OpenAI-compatible completion endpoint. OpenAICompletion: description: Response from an OpenAI-compatible completion request. properties: id: description: The ID of the completion. title: Id type: string choices: description: List of choices. items: $ref: '#/components/schemas/OpenAICompletionChoice' minItems: 1 title: Choices type: array created: description: The Unix timestamp in seconds when the completion was created. minimum: 0 title: Created type: integer model: description: The model that was used to generate the completion. title: Model type: string object: const: text_completion default: text_completion description: The object type. title: Object type: string required: - id - choices - created - model title: OpenAICompletion type: object OpenAICompletionChoice: description: A choice from an OpenAI-compatible completion response. properties: finish_reason: description: The reason the model stopped generating. enum: - stop - length - tool_calls - content_filter - function_call title: Finish Reason type: string text: description: The text of the choice. title: Text type: string index: description: The index of the choice. minimum: 0 title: Index type: integer logprobs: anyOf: - $ref: '#/components/schemas/OpenAIChoiceLogprobs' title: OpenAIChoiceLogprobs - type: 'null' description: The log probabilities for the tokens in the choice. nullable: true title: OpenAIChoiceLogprobs required: - finish_reason - text - index title: OpenAICompletionChoice type: object ConversationItem: discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools title: OpenAIResponseMessage | ... (9 variants) OpenAIResponseAnnotationCitation: properties: type: type: string const: url_citation title: Type default: url_citation end_index: type: integer title: End Index start_index: type: integer title: Start Index title: type: string title: Title url: type: string title: Url type: object required: - end_index - start_index - title - url title: OpenAIResponseAnnotationCitation description: URL citation annotation for referencing external web resources. OpenAIResponseAnnotationContainerFileCitation: properties: type: type: string const: container_file_citation title: Type default: container_file_citation container_id: type: string title: Container Id end_index: type: integer title: End Index file_id: type: string title: File Id filename: type: string title: Filename start_index: type: integer title: Start Index type: object required: - container_id - end_index - file_id - filename - start_index title: OpenAIResponseAnnotationContainerFileCitation OpenAIResponseAnnotationFileCitation: properties: type: type: string const: file_citation title: Type default: file_citation file_id: type: string title: File Id filename: type: string title: Filename index: type: integer title: Index type: object required: - file_id - filename - index title: OpenAIResponseAnnotationFileCitation description: File citation annotation for referencing specific files in response content. OpenAIResponseAnnotationFilePath: properties: type: type: string const: file_path title: Type default: file_path file_id: type: string title: File Id index: type: integer title: Index type: object required: - file_id - index title: OpenAIResponseAnnotationFilePath OpenAIResponseAnnotations: discriminator: mapping: container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' title: OpenAIResponseAnnotationFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' title: OpenAIResponseAnnotationContainerFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) OpenAIResponseContentPartRefusal: properties: type: type: string const: refusal title: Type default: refusal refusal: type: string title: Refusal type: object required: - refusal title: OpenAIResponseContentPartRefusal description: Refusal content within a streamed response part. OpenAIResponseInputFunctionToolCallOutput: properties: call_id: type: string title: Call Id output: type: string title: Output type: type: string const: function_call_output title: Type default: function_call_output id: anyOf: - type: string - type: 'null' status: anyOf: - type: string - type: 'null' type: object required: - call_id - output title: OpenAIResponseInputFunctionToolCallOutput description: This represents the output of a function call that gets passed back to the model. OpenAIResponseInputMessageContent: discriminator: mapping: input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' title: OpenAIResponseInputMessageContentText - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' title: OpenAIResponseInputMessageContentImage - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile OpenAIResponseInputMessageContentFile: properties: type: type: string const: input_file title: Type default: input_file file_data: anyOf: - type: string - type: 'null' file_id: anyOf: - type: string - type: 'null' file_url: anyOf: - type: string - type: 'null' filename: anyOf: - type: string - type: 'null' type: object title: OpenAIResponseInputMessageContentFile description: File content for input messages in OpenAI response format. OpenAIResponseInputMessageContentImage: properties: detail: title: Detail default: auto type: string enum: - low - high - auto type: type: string const: input_image title: Type default: input_image file_id: anyOf: - type: string - type: 'null' image_url: anyOf: - type: string - type: 'null' type: object title: OpenAIResponseInputMessageContentImage description: Image content for input messages in OpenAI response format. OpenAIResponseInputMessageContentText: properties: text: type: string title: Text type: type: string const: input_text title: Type default: input_text type: object required: - text title: OpenAIResponseInputMessageContentText description: Text content for input messages in OpenAI response format. OpenAIResponseMCPApprovalRequest: properties: arguments: type: string title: Arguments id: type: string title: Id name: type: string title: Name server_label: type: string title: Server Label type: type: string const: mcp_approval_request title: Type default: mcp_approval_request type: object required: - arguments - id - name - server_label title: OpenAIResponseMCPApprovalRequest description: A request for human approval of a tool invocation. OpenAIResponseMCPApprovalResponse: properties: approval_request_id: type: string title: Approval Request Id approve: type: boolean title: Approve type: type: string const: mcp_approval_response title: Type default: mcp_approval_response id: anyOf: - type: string - type: 'null' reason: anyOf: - type: string - type: 'null' type: object required: - approval_request_id - approve title: OpenAIResponseMCPApprovalResponse description: A response to an MCP approval request. OpenAIResponseMessage: description: |- Corresponds to the various Message types in the Responses API. They are all under one type because the Responses API gives them all the same "type" value, and there is no way to tell them apart in certain scenarios. properties: content: anyOf: - type: string - items: discriminator: mapping: input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' title: OpenAIResponseInputMessageContentText - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' title: OpenAIResponseInputMessageContentImage - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile type: array title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] - items: discriminator: mapping: output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' title: OpenAIResponseOutputMessageContentOutputText - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal type: array title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] role: title: Role type: string enum: - system - developer - user - assistant default: system type: const: message default: message title: Type type: string id: anyOf: - type: string - type: 'null' nullable: true status: anyOf: - type: string - type: 'null' nullable: true required: - content - role title: OpenAIResponseMessage type: object OpenAIResponseOutputMessageContent: discriminator: mapping: output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' title: OpenAIResponseOutputMessageContentOutputText - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal OpenAIResponseOutputMessageContentOutputText: properties: text: title: Text type: string type: const: output_text default: output_text title: Type type: string annotations: items: discriminator: mapping: container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' title: OpenAIResponseAnnotationFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' title: OpenAIResponseAnnotationContainerFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) title: Annotations type: array logprobs: anyOf: - items: $ref: '#/components/schemas/OpenAITokenLogProb' type: array - type: 'null' nullable: true required: - text title: OpenAIResponseOutputMessageContentOutputText type: object OpenAIResponseOutputMessageFileSearchToolCall: properties: id: type: string title: Id queries: items: type: string type: array title: Queries status: type: string title: Status type: type: string const: file_search_call title: Type default: file_search_call results: anyOf: - items: $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCallResults' type: array - type: 'null' type: object required: - id - queries - status title: OpenAIResponseOutputMessageFileSearchToolCall description: File search tool call output message for OpenAI responses. OpenAIResponseOutputMessageFunctionToolCall: properties: call_id: type: string title: Call Id name: type: string title: Name arguments: type: string title: Arguments type: type: string const: function_call title: Type default: function_call id: anyOf: - type: string - type: 'null' status: anyOf: - type: string - type: 'null' type: object required: - call_id - name - arguments title: OpenAIResponseOutputMessageFunctionToolCall description: Function tool call output message for OpenAI responses. OpenAIResponseOutputMessageMCPCall: properties: id: type: string title: Id type: type: string const: mcp_call title: Type default: mcp_call arguments: type: string title: Arguments name: type: string title: Name server_label: type: string title: Server Label error: anyOf: - type: string - type: 'null' output: anyOf: - type: string - type: 'null' type: object required: - id - arguments - name - server_label title: OpenAIResponseOutputMessageMCPCall description: Model Context Protocol (MCP) call output message for OpenAI responses. OpenAIResponseOutputMessageMCPListTools: properties: id: type: string title: Id type: type: string const: mcp_list_tools title: Type default: mcp_list_tools server_label: type: string title: Server Label tools: items: $ref: '#/components/schemas/MCPListToolsTool' type: array title: Tools type: object required: - id - server_label - tools title: OpenAIResponseOutputMessageMCPListTools description: MCP list tools output message containing available tools from an MCP server. OpenAIResponseOutputMessageWebSearchToolCall: properties: id: type: string title: Id status: type: string title: Status type: type: string const: web_search_call title: Type default: web_search_call type: object required: - id - status title: OpenAIResponseOutputMessageWebSearchToolCall description: Web search tool call output message for OpenAI responses. CreateConversationRequest: properties: items: anyOf: - items: oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage-Input' title: OpenAIResponseMessage-Input - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools discriminator: propertyName: type mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage-Input' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseMessage-Input | ... (9 variants) type: array - type: 'null' description: Initial items to include in the conversation context. metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' description: Set of key-value pairs that can be attached to an object. type: object title: CreateConversationRequest description: Request model for creating a conversation. Conversation: properties: id: type: string title: Id description: The unique ID of the conversation. object: type: string const: conversation title: Object description: The object type, which is always conversation. default: conversation created_at: type: integer title: Created At description: The time at which the conversation was created, measured in seconds since the Unix epoch. metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' description: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. items: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' description: Initial items to include in the conversation context. You may add up to 20 items at a time. type: object required: - id - created_at title: Conversation description: OpenAI-compatible conversation object. UpdateConversationRequest: properties: metadata: additionalProperties: type: string type: object title: Metadata description: Set of key-value pairs that can be attached to an object. type: object required: - metadata title: UpdateConversationRequest description: Request model for updating a conversation's metadata. ConversationDeletedResource: properties: id: type: string title: Id description: The deleted conversation identifier object: type: string title: Object description: Object type default: conversation.deleted deleted: type: boolean title: Deleted description: Whether the object was deleted default: true type: object required: - id title: ConversationDeletedResource description: Response for deleted conversation. ConversationItemList: properties: object: type: string title: Object description: Object type default: list data: items: oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage-Output' title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools discriminator: propertyName: type mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage-Output' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseMessage-Output | ... (9 variants) type: array title: Data description: List of conversation items first_id: anyOf: - type: string - type: 'null' description: The ID of the first item in the list last_id: anyOf: - type: string - type: 'null' description: The ID of the last item in the list has_more: type: boolean title: Has More description: Whether there are more items available default: false type: object required: - data title: ConversationItemList description: List of conversation items with pagination. AddItemsRequest: properties: items: items: oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage-Input' title: OpenAIResponseMessage-Input - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools discriminator: propertyName: type mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage-Input' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseMessage-Input | ... (9 variants) type: array maxItems: 20 title: Items description: Items to include in the conversation context. You may add up to 20 items at a time. type: object required: - items title: AddItemsRequest description: Request model for adding items to a conversation. ConversationItemDeletedResource: properties: id: type: string title: Id description: The deleted item identifier object: type: string title: Object description: Object type default: conversation.item.deleted deleted: type: boolean title: Deleted description: Whether the object was deleted default: true type: object required: - id title: ConversationItemDeletedResource description: Response for deleted conversation item. OpenAIEmbeddingsRequestWithExtraBody: properties: model: type: string title: Model description: The identifier of the model to use. input: anyOf: - type: string title: string - items: type: string type: array maxItems: 2048 minItems: 1 title: Array of strings - items: type: integer type: array maxItems: 2048 minItems: 1 title: Array of tokens - items: items: type: integer type: array minItems: 1 type: array maxItems: 2048 minItems: 1 title: Array of token arrays title: string | ... (4 variants) description: Input text to embed, encoded as a string or array of tokens. encoding_format: type: string enum: - float - base64 title: Encoding Format description: The format to return the embeddings in. default: float dimensions: type: integer minimum: 1.0 title: Dimensions description: The number of dimensions for output embeddings. user: type: string title: User description: A unique identifier representing your end-user. additionalProperties: true type: object required: - model - input title: OpenAIEmbeddingsRequestWithExtraBody description: Request parameters for OpenAI-compatible embeddings endpoint. OpenAIEmbeddingData: properties: object: type: string const: embedding title: Object description: The object type. default: embedding embedding: anyOf: - items: type: number type: array title: list[number] - type: string title: list[number] | string description: The embedding vector as a list of floats (when encoding_format='float') or as a base64-encoded string. index: type: integer minimum: 0.0 title: Index description: The index of the embedding in the input list. type: object required: - embedding - index title: OpenAIEmbeddingData description: A single embedding data object from an OpenAI-compatible embeddings response. OpenAIEmbeddingUsage: properties: prompt_tokens: type: integer title: Prompt Tokens description: The number of tokens in the input. total_tokens: type: integer title: Total Tokens description: The total number of tokens used. type: object required: - prompt_tokens - total_tokens title: OpenAIEmbeddingUsage description: Usage information for an OpenAI-compatible embeddings response. OpenAIEmbeddingsResponse: properties: object: type: string const: list title: Object description: The object type. default: list data: items: $ref: '#/components/schemas/OpenAIEmbeddingData' type: array minItems: 1 title: Data description: List of embedding data objects. model: type: string title: Model description: The model that was used to generate the embeddings. usage: $ref: '#/components/schemas/OpenAIEmbeddingUsage' description: Usage information. type: object required: - data - model - usage title: OpenAIEmbeddingsResponse description: Response from an OpenAI-compatible embeddings request. OpenAIFilePurpose: type: string enum: - assistants - batch title: OpenAIFilePurpose description: Valid purpose values for OpenAI Files API. ListOpenAIFileResponse: properties: data: items: $ref: '#/components/schemas/OpenAIFileObject' type: array title: Data description: The list of files. has_more: type: boolean title: Has More description: Whether there are more files available beyond this page. first_id: type: string title: First Id description: The ID of the first file in the list for pagination. last_id: type: string title: Last Id description: The ID of the last file in the list for pagination. object: type: string const: list title: Object description: The object type, which is always 'list'. default: list type: object required: - data - has_more - first_id - last_id title: ListOpenAIFileResponse description: Response for listing files in OpenAI Files API. OpenAIFileObject: properties: object: type: string const: file title: Object description: The object type, which is always 'file'. default: file id: type: string title: Id description: The file identifier, which can be referenced in the API endpoints. bytes: type: integer title: Bytes description: The size of the file, in bytes. created_at: type: integer title: Created At description: The Unix timestamp (in seconds) for when the file was created. expires_at: type: integer title: Expires At description: The Unix timestamp (in seconds) for when the file expires. filename: type: string title: Filename description: The name of the file. purpose: $ref: '#/components/schemas/OpenAIFilePurpose' description: The intended purpose of the file. type: object required: - id - bytes - created_at - expires_at - filename - purpose title: OpenAIFileObject description: OpenAI File object as defined in the OpenAI Files API. ExpiresAfter: properties: anchor: type: string const: created_at title: Anchor description: The anchor point for expiration, must be 'created_at'. seconds: type: integer maximum: 2592000.0 minimum: 3600.0 title: Seconds description: Seconds until expiration, between 3600 (1 hour) and 2592000 (30 days). type: object required: - anchor - seconds title: ExpiresAfter description: Control expiration of uploaded files. OpenAIFileDeleteResponse: properties: id: type: string title: Id description: The file identifier that was deleted. object: type: string const: file title: Object description: The object type, which is always 'file'. default: file deleted: type: boolean title: Deleted description: Whether the file was successfully deleted. type: object required: - id - deleted title: OpenAIFileDeleteResponse description: Response for deleting a file in OpenAI Files API. Response: title: Response type: object HealthInfo: properties: status: $ref: '#/components/schemas/HealthStatus' description: The health status of the service type: object required: - status title: HealthInfo description: Health status information for the service. RouteInfo: properties: route: type: string title: Route description: The API route path method: type: string title: Method description: The HTTP method for the route provider_types: items: type: string type: array title: Provider Types description: List of provider types implementing this route type: object required: - route - method - provider_types title: RouteInfo description: Information about an API route including its path, method, and implementing providers. ListRoutesResponse: properties: data: items: $ref: '#/components/schemas/RouteInfo' type: array title: Data description: List of available API routes type: object required: - data title: ListRoutesResponse description: Response containing a list of all available API routes. OpenAIModel: properties: id: type: string title: Id object: type: string const: model title: Object default: model created: type: integer title: Created owned_by: type: string title: Owned By custom_metadata: anyOf: - additionalProperties: true type: object - type: 'null' type: object required: - id - created - owned_by title: OpenAIModel description: |- A model from OpenAI. :id: The ID of the model :object: The object type, which will be "model" :created: The Unix timestamp in seconds when the model was created :owned_by: The owner of the model :custom_metadata: Llama Stack-specific metadata including model_type, provider info, and additional metadata OpenAIListModelsResponse: properties: data: items: $ref: '#/components/schemas/OpenAIModel' type: array title: Data description: List of OpenAI model objects. type: object required: - data title: OpenAIListModelsResponse description: Response containing a list of OpenAI model objects. Model: properties: identifier: type: string title: Identifier description: Unique identifier for this resource in llama stack provider_resource_id: anyOf: - type: string - type: 'null' description: Unique identifier for this resource in the provider provider_id: type: string title: Provider Id description: ID of the provider that owns this resource type: type: string const: model title: Type default: model metadata: additionalProperties: true type: object title: Metadata description: Any additional metadata for this model model_type: $ref: '#/components/schemas/ModelType' default: llm type: object required: - identifier - provider_id title: Model description: A model resource representing an AI model registered in Llama Stack. ModelType: type: string enum: - llm - embedding - rerank title: ModelType description: Enumeration of supported model types in Llama Stack. RunModerationRequest: properties: input: anyOf: - type: string - items: type: string type: array title: list[string] title: string | list[string] description: Input (or inputs) to classify. Can be a single string or an array of strings. model: anyOf: - type: string - type: 'null' description: The content moderation model to use. If not specified, the default shield will be used. type: object required: - input title: RunModerationRequest description: Request model for running content moderation. ModerationObject: properties: id: type: string title: Id description: The unique identifier for the moderation request model: type: string title: Model description: The model used to generate the moderation results results: items: $ref: '#/components/schemas/ModerationObjectResults' type: array title: Results description: A list of moderation result objects type: object required: - id - model - results title: ModerationObject description: A moderation object containing the results of content classification. ModerationObjectResults: properties: flagged: type: boolean title: Flagged description: Whether any of the below categories are flagged categories: anyOf: - additionalProperties: type: boolean type: object - type: 'null' description: A dictionary of the categories, and whether they are flagged or not category_applied_input_types: anyOf: - additionalProperties: items: type: string type: array type: object - type: 'null' description: A dictionary of the categories along with the input type(s) that the score applies to category_scores: anyOf: - additionalProperties: type: number type: object - type: 'null' description: A dictionary of the categories along with their scores as predicted by model user_message: anyOf: - type: string - type: 'null' description: A message to convey to the user about the moderation result metadata: additionalProperties: true type: object title: Metadata description: Additional metadata about the moderation type: object required: - flagged title: ModerationObjectResults description: A moderation result object containing flagged status and category information. Prompt: properties: prompt: anyOf: - type: string - type: 'null' description: The system prompt with variable placeholders version: type: integer minimum: 1.0 title: Version description: Version (integer starting at 1, incremented on save) prompt_id: type: string title: Prompt Id description: Unique identifier in format 'pmpt_<48-digit-hash>' variables: items: type: string type: array title: Variables description: List of variable names that can be used in the prompt template is_default: type: boolean title: Is Default description: Boolean indicating whether this version is the default version default: false type: object required: - version - prompt_id title: Prompt description: A prompt resource representing a stored OpenAI Compatible prompt template in Llama Stack. ListPromptsResponse: properties: data: items: $ref: '#/components/schemas/Prompt' type: array title: Data type: object required: - data title: ListPromptsResponse description: Response model to list prompts. CreatePromptRequest: properties: prompt: type: string title: Prompt description: The prompt text content with variable placeholders. variables: anyOf: - items: type: string type: array - type: 'null' description: List of variable names that can be used in the prompt template. type: object required: - prompt title: CreatePromptRequest description: Request model for creating a new prompt. UpdatePromptRequest: description: Request model for updating a prompt (combines path and body parameters). properties: prompt_id: description: The identifier of the prompt to update. title: Prompt Id type: string prompt: description: The updated prompt text content. title: Prompt type: string version: description: The current version of the prompt being updated. title: Version type: integer variables: anyOf: - items: type: string type: array - type: 'null' description: Updated list of variable names that can be used in the prompt template. nullable: true set_as_default: default: true description: Set the new version as the default (default=True). title: Set As Default type: boolean required: - prompt_id - prompt - version title: UpdatePromptRequest type: object SetDefaultVersionRequest: description: Request model for setting the default version of a prompt (combines path and body parameters). properties: prompt_id: description: The identifier of the prompt. title: Prompt Id type: string version: description: The version to set as default. title: Version type: integer required: - prompt_id - version title: SetDefaultVersionRequest type: object ProviderInfo: properties: api: type: string title: Api description: The API name this provider implements provider_id: type: string title: Provider Id description: Unique identifier for the provider provider_type: type: string title: Provider Type description: The type of provider implementation config: additionalProperties: true type: object title: Config description: Configuration parameters for the provider health: additionalProperties: true type: object title: Health description: Current health status of the provider type: object required: - api - provider_id - provider_type - config - health title: ProviderInfo description: Information about a registered provider including its configuration and health status. ListProvidersResponse: properties: data: items: $ref: '#/components/schemas/ProviderInfo' type: array title: Data description: List of provider information objects type: object required: - data title: ListProvidersResponse description: Response containing a list of all available providers. ListOpenAIResponseObject: properties: data: items: $ref: '#/components/schemas/OpenAIResponseObjectWithInput' type: array title: Data has_more: type: boolean title: Has More first_id: type: string title: First Id last_id: type: string title: Last Id object: type: string const: list title: Object default: list type: object required: - data - has_more - first_id - last_id title: ListOpenAIResponseObject description: Paginated list of OpenAI response objects with navigation metadata. OpenAIResponseError: properties: code: type: string title: Code message: type: string title: Message type: object required: - code - message title: OpenAIResponseError description: Error details for failed OpenAI response requests. OpenAIResponseInput: anyOf: - discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage OpenAIResponseInputToolFileSearch: properties: type: type: string const: file_search title: Type default: file_search vector_store_ids: items: type: string type: array title: Vector Store Ids filters: anyOf: - additionalProperties: true type: object - type: 'null' max_num_results: anyOf: - type: integer maximum: 50.0 minimum: 1.0 - type: 'null' default: 10 ranking_options: anyOf: - $ref: '#/components/schemas/SearchRankingOptions' title: SearchRankingOptions - type: 'null' title: SearchRankingOptions type: object required: - vector_store_ids title: OpenAIResponseInputToolFileSearch description: File search tool configuration for OpenAI response inputs. OpenAIResponseInputToolFunction: properties: type: type: string const: function title: Type default: function name: type: string title: Name description: anyOf: - type: string - type: 'null' parameters: anyOf: - additionalProperties: true type: object - type: 'null' strict: anyOf: - type: boolean - type: 'null' type: object required: - name - parameters title: OpenAIResponseInputToolFunction description: Function tool configuration for OpenAI response inputs. OpenAIResponseInputToolWebSearch: properties: type: title: Type default: web_search type: string enum: - web_search - web_search_preview - web_search_preview_2025_03_11 - web_search_2025_08_26 search_context_size: anyOf: - type: string pattern: ^low|medium|high$ - type: 'null' default: medium type: object title: OpenAIResponseInputToolWebSearch description: Web search tool configuration for OpenAI response inputs. OpenAIResponseObjectWithInput: properties: created_at: type: integer title: Created At completed_at: anyOf: - type: integer - type: 'null' error: anyOf: - $ref: '#/components/schemas/OpenAIResponseError' title: OpenAIResponseError - type: 'null' title: OpenAIResponseError id: type: string title: Id model: type: string title: Model object: type: string const: response title: Object default: response output: items: oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage-Output' title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest discriminator: propertyName: type mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage-Output' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseMessage-Output | ... (7 variants) type: array title: Output parallel_tool_calls: anyOf: - type: boolean - type: 'null' default: true previous_response_id: anyOf: - type: string - type: 'null' prompt: anyOf: - $ref: '#/components/schemas/OpenAIResponsePrompt' title: OpenAIResponsePrompt - type: 'null' title: OpenAIResponsePrompt status: type: string title: Status temperature: anyOf: - type: number - type: 'null' text: $ref: '#/components/schemas/OpenAIResponseText' default: format: type: text top_p: anyOf: - type: number - type: 'null' tools: anyOf: - items: oneOf: - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' title: OpenAIResponseInputToolWebSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' title: OpenAIResponseInputToolFileSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseToolMCP' title: OpenAIResponseToolMCP discriminator: propertyName: type mapping: file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' function: '#/components/schemas/OpenAIResponseInputToolFunction' mcp: '#/components/schemas/OpenAIResponseToolMCP' web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' title: OpenAIResponseInputToolWebSearch | ... (4 variants) type: array - type: 'null' tool_choice: anyOf: - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceMode' title: OpenAIResponseInputToolChoiceMode - oneOf: - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceAllowedTools' title: OpenAIResponseInputToolChoiceAllowedTools - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceFileSearch' title: OpenAIResponseInputToolChoiceFileSearch - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' title: OpenAIResponseInputToolChoiceWebSearch - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceFunctionTool' title: OpenAIResponseInputToolChoiceFunctionTool - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceMCPTool' title: OpenAIResponseInputToolChoiceMCPTool - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceCustomTool' title: OpenAIResponseInputToolChoiceCustomTool discriminator: propertyName: type mapping: allowed_tools: '#/components/schemas/OpenAIResponseInputToolChoiceAllowedTools' custom: '#/components/schemas/OpenAIResponseInputToolChoiceCustomTool' file_search: '#/components/schemas/OpenAIResponseInputToolChoiceFileSearch' function: '#/components/schemas/OpenAIResponseInputToolChoiceFunctionTool' mcp: '#/components/schemas/OpenAIResponseInputToolChoiceMCPTool' web_search: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' web_search_preview: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' title: OpenAIResponseInputToolChoiceAllowedTools | ... (6 variants) - type: 'null' title: OpenAIResponseInputToolChoiceMode truncation: anyOf: - type: string - type: 'null' usage: anyOf: - $ref: '#/components/schemas/OpenAIResponseUsage' title: OpenAIResponseUsage - type: 'null' title: OpenAIResponseUsage instructions: anyOf: - type: string - type: 'null' max_tool_calls: anyOf: - type: integer - type: 'null' reasoning: anyOf: - $ref: '#/components/schemas/OpenAIResponseReasoning' title: OpenAIResponseReasoning - type: 'null' title: OpenAIResponseReasoning max_output_tokens: anyOf: - type: integer - type: 'null' safety_identifier: anyOf: - type: string - type: 'null' metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' store: type: boolean title: Store input: items: anyOf: - oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage-Output' title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest discriminator: propertyName: type mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage-Output' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseMessage-Output | ... (7 variants) - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseMessage-Output' title: OpenAIResponseMessage-Output title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Output type: array title: Input type: object required: - created_at - id - model - output - status - store - input title: OpenAIResponseObjectWithInput description: OpenAI response object extended with input context information. OpenAIResponseOutput: discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) OpenAIResponsePrompt: properties: id: type: string title: Id variables: anyOf: - additionalProperties: oneOf: - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' title: OpenAIResponseInputMessageContentText - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' title: OpenAIResponseInputMessageContentImage - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile discriminator: propertyName: type mapping: input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile type: object - type: 'null' version: anyOf: - type: string - type: 'null' type: object required: - id title: OpenAIResponsePrompt description: OpenAI compatible Prompt object that is used in OpenAI responses. OpenAIResponseText: properties: format: anyOf: - $ref: '#/components/schemas/OpenAIResponseTextFormat' title: OpenAIResponseTextFormat - type: 'null' title: OpenAIResponseTextFormat type: object title: OpenAIResponseText description: Text response configuration for OpenAI responses. OpenAIResponseTool: discriminator: mapping: file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' function: '#/components/schemas/OpenAIResponseInputToolFunction' mcp: '#/components/schemas/OpenAIResponseToolMCP' web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' title: OpenAIResponseInputToolWebSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' title: OpenAIResponseInputToolFileSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseToolMCP' title: OpenAIResponseToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) OpenAIResponseToolMCP: properties: type: type: string const: mcp title: Type default: mcp server_label: type: string title: Server Label allowed_tools: anyOf: - items: type: string type: array title: list[string] - $ref: '#/components/schemas/AllowedToolsFilter' title: AllowedToolsFilter - type: 'null' title: list[string] | AllowedToolsFilter type: object required: - server_label title: OpenAIResponseToolMCP description: Model Context Protocol (MCP) tool configuration for OpenAI response object. OpenAIResponseUsage: properties: input_tokens: type: integer title: Input Tokens output_tokens: type: integer title: Output Tokens total_tokens: type: integer title: Total Tokens input_tokens_details: $ref: '#/components/schemas/OpenAIResponseUsageInputTokensDetails' output_tokens_details: $ref: '#/components/schemas/OpenAIResponseUsageOutputTokensDetails' type: object required: - input_tokens - output_tokens - total_tokens - input_tokens_details - output_tokens_details title: OpenAIResponseUsage description: Usage information for OpenAI response. ResponseGuardrailSpec: properties: type: type: string title: Type additionalProperties: false type: object required: - type title: ResponseGuardrailSpec description: Specification for a guardrail to apply during response generation. OpenAIResponseInputTool: discriminator: mapping: file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' function: '#/components/schemas/OpenAIResponseInputToolFunction' mcp: '#/components/schemas/OpenAIResponseInputToolMCP' web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' title: OpenAIResponseInputToolWebSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' title: OpenAIResponseInputToolFileSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' title: OpenAIResponseInputToolMCP title: OpenAIResponseInputToolWebSearch | ... (4 variants) OpenAIResponseInputToolMCP: properties: type: type: string const: mcp title: Type default: mcp server_label: type: string title: Server Label connector_id: anyOf: - type: string - type: 'null' server_url: anyOf: - type: string - type: 'null' headers: anyOf: - additionalProperties: true type: object - type: 'null' authorization: anyOf: - type: string - type: 'null' require_approval: anyOf: - type: string const: always - type: string const: never - $ref: '#/components/schemas/ApprovalFilter' title: ApprovalFilter title: string | ApprovalFilter default: never allowed_tools: anyOf: - items: type: string type: array title: list[string] - $ref: '#/components/schemas/AllowedToolsFilter' title: AllowedToolsFilter - type: 'null' title: list[string] | AllowedToolsFilter type: object required: - server_label title: OpenAIResponseInputToolMCP description: Model Context Protocol (MCP) tool configuration for OpenAI response inputs. OpenAIResponseObject: properties: created_at: type: integer title: Created At completed_at: anyOf: - type: integer - type: 'null' error: anyOf: - $ref: '#/components/schemas/OpenAIResponseError' title: OpenAIResponseError - type: 'null' title: OpenAIResponseError id: type: string title: Id model: type: string title: Model object: type: string const: response title: Object default: response output: items: oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage-Output' title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest discriminator: propertyName: type mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage-Output' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseMessage-Output | ... (7 variants) type: array title: Output parallel_tool_calls: anyOf: - type: boolean - type: 'null' default: true previous_response_id: anyOf: - type: string - type: 'null' prompt: anyOf: - $ref: '#/components/schemas/OpenAIResponsePrompt' title: OpenAIResponsePrompt - type: 'null' title: OpenAIResponsePrompt status: type: string title: Status temperature: anyOf: - type: number - type: 'null' text: $ref: '#/components/schemas/OpenAIResponseText' default: format: type: text top_p: anyOf: - type: number - type: 'null' tools: anyOf: - items: oneOf: - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' title: OpenAIResponseInputToolWebSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' title: OpenAIResponseInputToolFileSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseToolMCP' title: OpenAIResponseToolMCP discriminator: propertyName: type mapping: file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' function: '#/components/schemas/OpenAIResponseInputToolFunction' mcp: '#/components/schemas/OpenAIResponseToolMCP' web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' title: OpenAIResponseInputToolWebSearch | ... (4 variants) type: array - type: 'null' tool_choice: anyOf: - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceMode' title: OpenAIResponseInputToolChoiceMode - oneOf: - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceAllowedTools' title: OpenAIResponseInputToolChoiceAllowedTools - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceFileSearch' title: OpenAIResponseInputToolChoiceFileSearch - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' title: OpenAIResponseInputToolChoiceWebSearch - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceFunctionTool' title: OpenAIResponseInputToolChoiceFunctionTool - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceMCPTool' title: OpenAIResponseInputToolChoiceMCPTool - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceCustomTool' title: OpenAIResponseInputToolChoiceCustomTool discriminator: propertyName: type mapping: allowed_tools: '#/components/schemas/OpenAIResponseInputToolChoiceAllowedTools' custom: '#/components/schemas/OpenAIResponseInputToolChoiceCustomTool' file_search: '#/components/schemas/OpenAIResponseInputToolChoiceFileSearch' function: '#/components/schemas/OpenAIResponseInputToolChoiceFunctionTool' mcp: '#/components/schemas/OpenAIResponseInputToolChoiceMCPTool' web_search: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' web_search_preview: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' title: OpenAIResponseInputToolChoiceAllowedTools | ... (6 variants) - type: 'null' title: OpenAIResponseInputToolChoiceMode truncation: anyOf: - type: string - type: 'null' usage: anyOf: - $ref: '#/components/schemas/OpenAIResponseUsage' title: OpenAIResponseUsage - type: 'null' title: OpenAIResponseUsage instructions: anyOf: - type: string - type: 'null' max_tool_calls: anyOf: - type: integer - type: 'null' reasoning: anyOf: - $ref: '#/components/schemas/OpenAIResponseReasoning' title: OpenAIResponseReasoning - type: 'null' title: OpenAIResponseReasoning max_output_tokens: anyOf: - type: integer - type: 'null' safety_identifier: anyOf: - type: string - type: 'null' metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' store: type: boolean title: Store type: object required: - created_at - id - model - output - status - store title: OpenAIResponseObject description: Complete OpenAI response object containing generation results and metadata. OpenAIResponseContentPartOutputText: description: Text content within a streamed response part. properties: type: const: output_text default: output_text title: Type type: string text: title: Text type: string annotations: items: discriminator: mapping: container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' title: OpenAIResponseAnnotationFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' title: OpenAIResponseAnnotationContainerFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) title: Annotations type: array logprobs: anyOf: - items: $ref: '#/components/schemas/OpenAITokenLogProb' type: array - type: 'null' nullable: true required: - text title: OpenAIResponseContentPartOutputText type: object OpenAIResponseContentPartReasoningSummary: description: Reasoning summary part in a streamed response. properties: type: const: summary_text default: summary_text title: Type type: string text: title: Text type: string required: - text title: OpenAIResponseContentPartReasoningSummary type: object OpenAIResponseContentPartReasoningText: description: Reasoning text emitted as part of a streamed response. properties: type: const: reasoning_text default: reasoning_text title: Type type: string text: title: Text type: string required: - text title: OpenAIResponseContentPartReasoningText type: object OpenAIResponseObjectStream: discriminator: mapping: response.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' response.content_part.added: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded' response.content_part.done: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone' response.created: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated' response.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed' response.file_search_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallCompleted' response.file_search_call.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallInProgress' response.file_search_call.searching: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallSearching' response.function_call_arguments.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta' response.function_call_arguments.done: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone' response.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress' response.incomplete: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete' response.mcp_call.arguments.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta' response.mcp_call.arguments.done: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDone' response.mcp_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted' response.mcp_call.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallFailed' response.mcp_call.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallInProgress' response.mcp_list_tools.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsCompleted' response.mcp_list_tools.failed: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsFailed' response.mcp_list_tools.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsInProgress' response.output_item.added: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded' response.output_item.done: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone' response.output_text.annotation.added: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded' response.output_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta' response.output_text.done: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDone' response.reasoning_summary_part.added: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded' response.reasoning_summary_part.done: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartDone' response.reasoning_summary_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta' response.reasoning_summary_text.done: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDone' response.reasoning_text.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDelta' response.reasoning_text.done: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDone' response.refusal.delta: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDelta' response.refusal.done: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDone' response.web_search_call.completed: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallCompleted' response.web_search_call.in_progress: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallInProgress' response.web_search_call.searching: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallSearching' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCreated' title: OpenAIResponseObjectStreamResponseCreated - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseInProgress' title: OpenAIResponseObjectStreamResponseInProgress - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemAdded' title: OpenAIResponseObjectStreamResponseOutputItemAdded - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputItemDone' title: OpenAIResponseObjectStreamResponseOutputItemDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDelta' title: OpenAIResponseObjectStreamResponseOutputTextDelta - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextDone' title: OpenAIResponseObjectStreamResponseOutputTextDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta' title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone' title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallInProgress' title: OpenAIResponseObjectStreamResponseWebSearchCallInProgress - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallSearching' title: OpenAIResponseObjectStreamResponseWebSearchCallSearching - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseWebSearchCallCompleted' title: OpenAIResponseObjectStreamResponseWebSearchCallCompleted - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsInProgress' title: OpenAIResponseObjectStreamResponseMcpListToolsInProgress - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsFailed' title: OpenAIResponseObjectStreamResponseMcpListToolsFailed - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpListToolsCompleted' title: OpenAIResponseObjectStreamResponseMcpListToolsCompleted - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta' title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallArgumentsDone' title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallInProgress' title: OpenAIResponseObjectStreamResponseMcpCallInProgress - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallFailed' title: OpenAIResponseObjectStreamResponseMcpCallFailed - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseMcpCallCompleted' title: OpenAIResponseObjectStreamResponseMcpCallCompleted - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartAdded' title: OpenAIResponseObjectStreamResponseContentPartAdded - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseContentPartDone' title: OpenAIResponseObjectStreamResponseContentPartDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDelta' title: OpenAIResponseObjectStreamResponseReasoningTextDelta - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningTextDone' title: OpenAIResponseObjectStreamResponseReasoningTextDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded' title: OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryPartDone' title: OpenAIResponseObjectStreamResponseReasoningSummaryPartDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta' title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseReasoningSummaryTextDone' title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDelta' title: OpenAIResponseObjectStreamResponseRefusalDelta - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseRefusalDone' title: OpenAIResponseObjectStreamResponseRefusalDone - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded' title: OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallInProgress' title: OpenAIResponseObjectStreamResponseFileSearchCallInProgress - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallSearching' title: OpenAIResponseObjectStreamResponseFileSearchCallSearching - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFileSearchCallCompleted' title: OpenAIResponseObjectStreamResponseFileSearchCallCompleted - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseIncomplete' title: OpenAIResponseObjectStreamResponseIncomplete - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseFailed' title: OpenAIResponseObjectStreamResponseFailed - $ref: '#/components/schemas/OpenAIResponseObjectStreamResponseCompleted' title: OpenAIResponseObjectStreamResponseCompleted title: OpenAIResponseObjectStreamResponseCreated | ... (36 variants) OpenAIResponseObjectStreamResponseCompleted: description: Streaming event indicating a response has been completed. properties: response: $ref: '#/components/schemas/OpenAIResponseObject' type: const: response.completed default: response.completed title: Type type: string required: - response title: OpenAIResponseObjectStreamResponseCompleted type: object OpenAIResponseObjectStreamResponseContentPartAdded: description: Streaming event for when a new content part is added to a response item. properties: content_index: title: Content Index type: integer response_id: title: Response Id type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer part: discriminator: mapping: output_text: '#/components/schemas/OpenAIResponseContentPartOutputText' reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseContentPartOutputText' title: OpenAIResponseContentPartOutputText - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' title: OpenAIResponseContentPartReasoningText title: OpenAIResponseContentPartOutputText | OpenAIResponseContentPartRefusal | OpenAIResponseContentPartReasoningText sequence_number: title: Sequence Number type: integer type: const: response.content_part.added default: response.content_part.added title: Type type: string required: - content_index - response_id - item_id - output_index - part - sequence_number title: OpenAIResponseObjectStreamResponseContentPartAdded type: object OpenAIResponseObjectStreamResponseContentPartDone: description: Streaming event for when a content part is completed. properties: content_index: title: Content Index type: integer response_id: title: Response Id type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer part: discriminator: mapping: output_text: '#/components/schemas/OpenAIResponseContentPartOutputText' reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseContentPartOutputText' title: OpenAIResponseContentPartOutputText - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' title: OpenAIResponseContentPartReasoningText title: OpenAIResponseContentPartOutputText | OpenAIResponseContentPartRefusal | OpenAIResponseContentPartReasoningText sequence_number: title: Sequence Number type: integer type: const: response.content_part.done default: response.content_part.done title: Type type: string required: - content_index - response_id - item_id - output_index - part - sequence_number title: OpenAIResponseObjectStreamResponseContentPartDone type: object OpenAIResponseObjectStreamResponseCreated: description: Streaming event indicating a new response has been created. properties: response: $ref: '#/components/schemas/OpenAIResponseObject' type: const: response.created default: response.created title: Type type: string required: - response title: OpenAIResponseObjectStreamResponseCreated type: object OpenAIResponseObjectStreamResponseFailed: description: Streaming event emitted when a response fails. properties: response: $ref: '#/components/schemas/OpenAIResponseObject' sequence_number: title: Sequence Number type: integer type: const: response.failed default: response.failed title: Type type: string required: - response - sequence_number title: OpenAIResponseObjectStreamResponseFailed type: object OpenAIResponseObjectStreamResponseFileSearchCallCompleted: description: Streaming event for completed file search calls. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.file_search_call.completed default: response.file_search_call.completed title: Type type: string required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseFileSearchCallCompleted type: object OpenAIResponseObjectStreamResponseFileSearchCallInProgress: description: Streaming event for file search calls in progress. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.file_search_call.in_progress default: response.file_search_call.in_progress title: Type type: string required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseFileSearchCallInProgress type: object OpenAIResponseObjectStreamResponseFileSearchCallSearching: description: Streaming event for file search currently searching. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.file_search_call.searching default: response.file_search_call.searching title: Type type: string required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseFileSearchCallSearching type: object OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta: description: Streaming event for incremental function call argument updates. properties: delta: title: Delta type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.function_call_arguments.delta default: response.function_call_arguments.delta title: Type type: string required: - delta - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDelta type: object OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone: description: Streaming event for when function call arguments are completed. properties: arguments: title: Arguments type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.function_call_arguments.done default: response.function_call_arguments.done title: Type type: string required: - arguments - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseFunctionCallArgumentsDone type: object OpenAIResponseObjectStreamResponseInProgress: description: Streaming event indicating the response remains in progress. properties: response: $ref: '#/components/schemas/OpenAIResponseObject' sequence_number: title: Sequence Number type: integer type: const: response.in_progress default: response.in_progress title: Type type: string required: - response - sequence_number title: OpenAIResponseObjectStreamResponseInProgress type: object OpenAIResponseObjectStreamResponseIncomplete: description: Streaming event emitted when a response ends in an incomplete state. properties: response: $ref: '#/components/schemas/OpenAIResponseObject' sequence_number: title: Sequence Number type: integer type: const: response.incomplete default: response.incomplete title: Type type: string required: - response - sequence_number title: OpenAIResponseObjectStreamResponseIncomplete type: object OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta: properties: delta: title: Delta type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.mcp_call.arguments.delta default: response.mcp_call.arguments.delta title: Type type: string required: - delta - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta type: object OpenAIResponseObjectStreamResponseMcpCallArgumentsDone: properties: arguments: title: Arguments type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.mcp_call.arguments.done default: response.mcp_call.arguments.done title: Type type: string required: - arguments - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDone type: object OpenAIResponseObjectStreamResponseMcpCallCompleted: description: Streaming event for completed MCP calls. properties: sequence_number: title: Sequence Number type: integer type: const: response.mcp_call.completed default: response.mcp_call.completed title: Type type: string required: - sequence_number title: OpenAIResponseObjectStreamResponseMcpCallCompleted type: object OpenAIResponseObjectStreamResponseMcpCallFailed: description: Streaming event for failed MCP calls. properties: sequence_number: title: Sequence Number type: integer type: const: response.mcp_call.failed default: response.mcp_call.failed title: Type type: string required: - sequence_number title: OpenAIResponseObjectStreamResponseMcpCallFailed type: object OpenAIResponseObjectStreamResponseMcpCallInProgress: description: Streaming event for MCP calls in progress. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.mcp_call.in_progress default: response.mcp_call.in_progress title: Type type: string required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseMcpCallInProgress type: object OpenAIResponseObjectStreamResponseMcpListToolsCompleted: properties: sequence_number: title: Sequence Number type: integer type: const: response.mcp_list_tools.completed default: response.mcp_list_tools.completed title: Type type: string required: - sequence_number title: OpenAIResponseObjectStreamResponseMcpListToolsCompleted type: object OpenAIResponseObjectStreamResponseMcpListToolsFailed: properties: sequence_number: title: Sequence Number type: integer type: const: response.mcp_list_tools.failed default: response.mcp_list_tools.failed title: Type type: string required: - sequence_number title: OpenAIResponseObjectStreamResponseMcpListToolsFailed type: object OpenAIResponseObjectStreamResponseMcpListToolsInProgress: properties: sequence_number: title: Sequence Number type: integer type: const: response.mcp_list_tools.in_progress default: response.mcp_list_tools.in_progress title: Type type: string required: - sequence_number title: OpenAIResponseObjectStreamResponseMcpListToolsInProgress type: object OpenAIResponseObjectStreamResponseOutputItemAdded: description: Streaming event for when a new output item is added to the response. properties: response_id: title: Response Id type: string item: discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.output_item.added default: response.output_item.added title: Type type: string required: - response_id - item - output_index - sequence_number title: OpenAIResponseObjectStreamResponseOutputItemAdded type: object OpenAIResponseObjectStreamResponseOutputItemDone: description: Streaming event for when an output item is completed. properties: response_id: title: Response Id type: string item: discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest title: OpenAIResponseMessage | ... (7 variants) output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.output_item.done default: response.output_item.done title: Type type: string required: - response_id - item - output_index - sequence_number title: OpenAIResponseObjectStreamResponseOutputItemDone type: object OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded: description: Streaming event for when an annotation is added to output text. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer content_index: title: Content Index type: integer annotation_index: title: Annotation Index type: integer annotation: discriminator: mapping: container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' title: OpenAIResponseAnnotationFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' title: OpenAIResponseAnnotationContainerFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath title: OpenAIResponseAnnotationFileCitation | ... (4 variants) sequence_number: title: Sequence Number type: integer type: const: response.output_text.annotation.added default: response.output_text.annotation.added title: Type type: string required: - item_id - output_index - content_index - annotation_index - annotation - sequence_number title: OpenAIResponseObjectStreamResponseOutputTextAnnotationAdded type: object OpenAIResponseObjectStreamResponseOutputTextDelta: description: Streaming event for incremental text content updates. properties: content_index: title: Content Index type: integer delta: title: Delta type: string item_id: title: Item Id type: string logprobs: anyOf: - items: $ref: '#/components/schemas/OpenAITokenLogProb' type: array - type: 'null' nullable: true output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.output_text.delta default: response.output_text.delta title: Type type: string required: - content_index - delta - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseOutputTextDelta type: object OpenAIResponseObjectStreamResponseOutputTextDone: description: Streaming event for when text output is completed. properties: content_index: title: Content Index type: integer text: title: Text type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.output_text.done default: response.output_text.done title: Type type: string required: - content_index - text - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseOutputTextDone type: object OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded: description: Streaming event for when a new reasoning summary part is added. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer part: $ref: '#/components/schemas/OpenAIResponseContentPartReasoningSummary' sequence_number: title: Sequence Number type: integer summary_index: title: Summary Index type: integer type: const: response.reasoning_summary_part.added default: response.reasoning_summary_part.added title: Type type: string required: - item_id - output_index - part - sequence_number - summary_index title: OpenAIResponseObjectStreamResponseReasoningSummaryPartAdded type: object OpenAIResponseObjectStreamResponseReasoningSummaryPartDone: description: Streaming event for when a reasoning summary part is completed. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer part: $ref: '#/components/schemas/OpenAIResponseContentPartReasoningSummary' sequence_number: title: Sequence Number type: integer summary_index: title: Summary Index type: integer type: const: response.reasoning_summary_part.done default: response.reasoning_summary_part.done title: Type type: string required: - item_id - output_index - part - sequence_number - summary_index title: OpenAIResponseObjectStreamResponseReasoningSummaryPartDone type: object OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta: description: Streaming event for incremental reasoning summary text updates. properties: delta: title: Delta type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer summary_index: title: Summary Index type: integer type: const: response.reasoning_summary_text.delta default: response.reasoning_summary_text.delta title: Type type: string required: - delta - item_id - output_index - sequence_number - summary_index title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDelta type: object OpenAIResponseObjectStreamResponseReasoningSummaryTextDone: description: Streaming event for when reasoning summary text is completed. properties: text: title: Text type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer summary_index: title: Summary Index type: integer type: const: response.reasoning_summary_text.done default: response.reasoning_summary_text.done title: Type type: string required: - text - item_id - output_index - sequence_number - summary_index title: OpenAIResponseObjectStreamResponseReasoningSummaryTextDone type: object OpenAIResponseObjectStreamResponseReasoningTextDelta: description: Streaming event for incremental reasoning text updates. properties: content_index: title: Content Index type: integer delta: title: Delta type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.reasoning_text.delta default: response.reasoning_text.delta title: Type type: string required: - content_index - delta - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseReasoningTextDelta type: object OpenAIResponseObjectStreamResponseReasoningTextDone: description: Streaming event for when reasoning text is completed. properties: content_index: title: Content Index type: integer text: title: Text type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.reasoning_text.done default: response.reasoning_text.done title: Type type: string required: - content_index - text - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseReasoningTextDone type: object OpenAIResponseObjectStreamResponseRefusalDelta: description: Streaming event for incremental refusal text updates. properties: content_index: title: Content Index type: integer delta: title: Delta type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.refusal.delta default: response.refusal.delta title: Type type: string required: - content_index - delta - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseRefusalDelta type: object OpenAIResponseObjectStreamResponseRefusalDone: description: Streaming event for when refusal text is completed. properties: content_index: title: Content Index type: integer refusal: title: Refusal type: string item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.refusal.done default: response.refusal.done title: Type type: string required: - content_index - refusal - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseRefusalDone type: object OpenAIResponseObjectStreamResponseWebSearchCallCompleted: description: Streaming event for completed web search calls. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.web_search_call.completed default: response.web_search_call.completed title: Type type: string required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseWebSearchCallCompleted type: object OpenAIResponseObjectStreamResponseWebSearchCallInProgress: description: Streaming event for web search calls in progress. properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.web_search_call.in_progress default: response.web_search_call.in_progress title: Type type: string required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseWebSearchCallInProgress type: object OpenAIResponseObjectStreamResponseWebSearchCallSearching: properties: item_id: title: Item Id type: string output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: const: response.web_search_call.searching default: response.web_search_call.searching title: Type type: string required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseWebSearchCallSearching type: object OpenAIDeleteResponseObject: properties: id: type: string title: Id object: type: string const: response title: Object default: response deleted: type: boolean title: Deleted default: true type: object required: - id title: OpenAIDeleteResponseObject description: Response object confirming deletion of an OpenAI response. ListOpenAIResponseInputItem: properties: data: items: anyOf: - oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage-Output' title: OpenAIResponseMessage-Output - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest discriminator: propertyName: type mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage-Output' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseMessage-Output | ... (7 variants) - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseMessage-Output' title: OpenAIResponseMessage-Output title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Output type: array title: Data object: type: string const: list title: Object default: list type: object required: - data title: ListOpenAIResponseInputItem description: List container for OpenAI response input items. RunShieldRequest: properties: shield_id: type: string minLength: 1 title: Shield Id description: The identifier of the shield to run messages: items: oneOf: - $ref: '#/components/schemas/OpenAIUserMessageParam-Input' title: OpenAIUserMessageParam-Input - $ref: '#/components/schemas/OpenAISystemMessageParam' title: OpenAISystemMessageParam - $ref: '#/components/schemas/OpenAIAssistantMessageParam-Input' title: OpenAIAssistantMessageParam-Input - $ref: '#/components/schemas/OpenAIToolMessageParam' title: OpenAIToolMessageParam - $ref: '#/components/schemas/OpenAIDeveloperMessageParam' title: OpenAIDeveloperMessageParam discriminator: propertyName: role mapping: assistant: '#/components/schemas/OpenAIAssistantMessageParam-Input' developer: '#/components/schemas/OpenAIDeveloperMessageParam' system: '#/components/schemas/OpenAISystemMessageParam' tool: '#/components/schemas/OpenAIToolMessageParam' user: '#/components/schemas/OpenAIUserMessageParam-Input' title: OpenAIUserMessageParam-Input | ... (5 variants) type: array title: Messages description: The messages to run the shield on type: object required: - shield_id - messages title: RunShieldRequest description: Request model for running a safety shield. RunShieldResponse: properties: violation: anyOf: - $ref: '#/components/schemas/SafetyViolation' title: SafetyViolation - type: 'null' description: Safety violation detected by the shield, if any title: SafetyViolation type: object title: RunShieldResponse description: Response from running a safety shield. SafetyViolation: properties: violation_level: $ref: '#/components/schemas/ViolationLevel' description: Severity level of the violation user_message: anyOf: - type: string - type: 'null' description: Message to convey to the user about the violation metadata: additionalProperties: true type: object title: Metadata description: Additional metadata including specific violation codes type: object required: - violation_level title: SafetyViolation description: Details of a safety violation detected by content moderation. ViolationLevel: type: string enum: - info - warn - error title: ViolationLevel description: Severity level of a safety violation. AggregationFunctionType: type: string enum: - average - weighted_average - median - categorical_count - accuracy title: AggregationFunctionType description: Types of aggregation functions for scoring results. ArrayType: properties: type: type: string const: array title: Type default: array type: object title: ArrayType description: Parameter type for array values. BasicScoringFnParams: properties: type: type: string const: basic title: Type default: basic aggregation_functions: items: $ref: '#/components/schemas/AggregationFunctionType' type: array title: Aggregation Functions description: Aggregation functions to apply to the scores of each row type: object title: BasicScoringFnParams description: Parameters for basic scoring function configuration. BooleanType: properties: type: type: string const: boolean title: Type default: boolean type: object title: BooleanType description: Parameter type for boolean values. ChatCompletionInputType: properties: type: type: string const: chat_completion_input title: Type default: chat_completion_input type: object title: ChatCompletionInputType description: Parameter type for chat completion input. CompletionInputType: properties: type: type: string const: completion_input title: Type default: completion_input type: object title: CompletionInputType description: Parameter type for completion input. JsonType: properties: type: type: string const: json title: Type default: json type: object title: JsonType description: Parameter type for JSON values. LLMAsJudgeScoringFnParams: properties: type: type: string const: llm_as_judge title: Type default: llm_as_judge judge_model: type: string title: Judge Model prompt_template: anyOf: - type: string - type: 'null' judge_score_regexes: items: type: string type: array title: Judge Score Regexes description: Regexes to extract the answer from generated response aggregation_functions: items: $ref: '#/components/schemas/AggregationFunctionType' type: array title: Aggregation Functions description: Aggregation functions to apply to the scores of each row type: object required: - judge_model title: LLMAsJudgeScoringFnParams description: Parameters for LLM-as-judge scoring function configuration. NumberType: properties: type: type: string const: number title: Type default: number type: object title: NumberType description: Parameter type for numeric values. ObjectType: properties: type: type: string const: object title: Type default: object type: object title: ObjectType description: Parameter type for object values. RegexParserScoringFnParams: properties: type: type: string const: regex_parser title: Type default: regex_parser parsing_regexes: items: type: string type: array title: Parsing Regexes description: Regex to extract the answer from generated response aggregation_functions: items: $ref: '#/components/schemas/AggregationFunctionType' type: array title: Aggregation Functions description: Aggregation functions to apply to the scores of each row type: object title: RegexParserScoringFnParams description: Parameters for regex parser scoring function configuration. ScoringFn: properties: identifier: type: string title: Identifier description: Unique identifier for this resource in llama stack provider_resource_id: anyOf: - type: string - type: 'null' description: Unique identifier for this resource in the provider provider_id: type: string title: Provider Id description: ID of the provider that owns this resource type: type: string const: scoring_function title: Type default: scoring_function description: anyOf: - type: string - type: 'null' metadata: additionalProperties: true type: object title: Metadata description: Any additional metadata for this definition return_type: oneOf: - $ref: '#/components/schemas/StringType' title: StringType - $ref: '#/components/schemas/NumberType' title: NumberType - $ref: '#/components/schemas/BooleanType' title: BooleanType - $ref: '#/components/schemas/ArrayType' title: ArrayType - $ref: '#/components/schemas/ObjectType' title: ObjectType - $ref: '#/components/schemas/JsonType' title: JsonType - $ref: '#/components/schemas/UnionType' title: UnionType - $ref: '#/components/schemas/ChatCompletionInputType' title: ChatCompletionInputType - $ref: '#/components/schemas/CompletionInputType' title: CompletionInputType title: StringType | ... (9 variants) description: The return type of the deterministic function discriminator: propertyName: type mapping: array: '#/components/schemas/ArrayType' boolean: '#/components/schemas/BooleanType' chat_completion_input: '#/components/schemas/ChatCompletionInputType' completion_input: '#/components/schemas/CompletionInputType' json: '#/components/schemas/JsonType' number: '#/components/schemas/NumberType' object: '#/components/schemas/ObjectType' string: '#/components/schemas/StringType' union: '#/components/schemas/UnionType' params: anyOf: - oneOf: - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' title: LLMAsJudgeScoringFnParams - $ref: '#/components/schemas/RegexParserScoringFnParams' title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams discriminator: propertyName: type mapping: basic: '#/components/schemas/BasicScoringFnParams' llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' regex_parser: '#/components/schemas/RegexParserScoringFnParams' title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - type: 'null' title: Params description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval type: object required: - identifier - provider_id - return_type title: ScoringFn description: A scoring function resource for evaluating model outputs. ScoringFnParams: discriminator: mapping: basic: '#/components/schemas/BasicScoringFnParams' llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' regex_parser: '#/components/schemas/RegexParserScoringFnParams' propertyName: type oneOf: - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' title: LLMAsJudgeScoringFnParams - $ref: '#/components/schemas/RegexParserScoringFnParams' title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams ScoringFnParamsType: description: Types of scoring function parameter configurations. enum: - llm_as_judge - regex_parser - basic title: ScoringFnParamsType type: string StringType: properties: type: type: string const: string title: Type default: string type: object title: StringType description: Parameter type for string values. UnionType: properties: type: type: string const: union title: Type default: union type: object title: UnionType description: Parameter type for union values. ListScoringFunctionsResponse: properties: data: items: $ref: '#/components/schemas/ScoringFn' type: array title: Data description: List of scoring function objects. type: object required: - data title: ListScoringFunctionsResponse description: Response containing a list of scoring function objects. ScoreRequest: properties: input_rows: items: additionalProperties: true type: object type: array title: Input Rows description: The rows to score. scoring_functions: additionalProperties: anyOf: - oneOf: - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' title: LLMAsJudgeScoringFnParams - $ref: '#/components/schemas/RegexParserScoringFnParams' title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams discriminator: propertyName: type mapping: basic: '#/components/schemas/BasicScoringFnParams' llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' regex_parser: '#/components/schemas/RegexParserScoringFnParams' title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - type: 'null' title: AdditionalpropertiesUnion type: object title: Scoring Functions description: The scoring functions to use for the scoring. type: object required: - input_rows - scoring_functions title: ScoreRequest description: Request model for scoring a list of rows. ScoreResponse: properties: results: additionalProperties: $ref: '#/components/schemas/ScoringResult' type: object title: Results description: A map of scoring function name to ScoringResult. type: object required: - results title: ScoreResponse description: The response from scoring. ScoringResult: properties: score_rows: items: additionalProperties: true type: object type: array title: Score Rows description: The scoring result for each row. Each row is a map of column name to value. aggregated_results: additionalProperties: true type: object title: Aggregated Results description: Map of metric name to aggregated value type: object required: - score_rows - aggregated_results title: ScoringResult description: A scoring result for a single row. ScoreBatchRequest: properties: dataset_id: type: string title: Dataset Id description: The ID of the dataset to score. scoring_functions: additionalProperties: anyOf: - oneOf: - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' title: LLMAsJudgeScoringFnParams - $ref: '#/components/schemas/RegexParserScoringFnParams' title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams discriminator: propertyName: type mapping: basic: '#/components/schemas/BasicScoringFnParams' llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' regex_parser: '#/components/schemas/RegexParserScoringFnParams' title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - type: 'null' title: AdditionalpropertiesUnion type: object title: Scoring Functions description: The scoring functions to use for the scoring. save_results_dataset: type: boolean title: Save Results Dataset description: Whether to save the results to a dataset. default: false type: object required: - dataset_id - scoring_functions title: ScoreBatchRequest description: Request model for scoring a batch of rows from a dataset. ScoreBatchResponse: properties: dataset_id: anyOf: - type: string - type: 'null' description: (Optional) The identifier of the dataset that was scored results: additionalProperties: $ref: '#/components/schemas/ScoringResult' type: object title: Results description: A map of scoring function name to ScoringResult type: object required: - results title: ScoreBatchResponse description: Response from batch scoring operations on datasets. Shield: properties: identifier: type: string title: Identifier description: Unique identifier for this resource in llama stack provider_resource_id: anyOf: - type: string - type: 'null' description: Unique identifier for this resource in the provider provider_id: type: string title: Provider Id description: ID of the provider that owns this resource type: type: string const: shield title: Type default: shield params: anyOf: - additionalProperties: true type: object - type: 'null' type: object required: - identifier - provider_id title: Shield description: A safety shield resource that can be used to check content. ListShieldsResponse: properties: data: items: $ref: '#/components/schemas/Shield' type: array title: Data description: List of shield objects type: object required: - data title: ListShieldsResponse description: Response containing a list of all shields. ImageContentItem: description: A image content item properties: type: const: image default: image title: Type type: string image: $ref: '#/components/schemas/_URLOrData' required: - image title: ImageContentItem type: object InterleavedContent: anyOf: - type: string - discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem - items: discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem type: array title: list[ImageContentItem | TextContentItem] title: string | list[ImageContentItem | TextContentItem] InterleavedContentItem: discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem TextContentItem: properties: type: type: string const: text title: Type default: text text: type: string title: Text type: object required: - text title: TextContentItem description: A text content item ToolInvocationResult: properties: content: anyOf: - type: string - oneOf: - $ref: '#/components/schemas/ImageContentItem-Output' title: ImageContentItem-Output - $ref: '#/components/schemas/TextContentItem' title: TextContentItem discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem-Output' text: '#/components/schemas/TextContentItem' title: ImageContentItem-Output | TextContentItem - items: oneOf: - $ref: '#/components/schemas/ImageContentItem-Output' title: ImageContentItem-Output - $ref: '#/components/schemas/TextContentItem' title: TextContentItem discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem-Output' text: '#/components/schemas/TextContentItem' title: ImageContentItem-Output | TextContentItem type: array title: list[ImageContentItem-Output | TextContentItem] - type: 'null' title: string | list[ImageContentItem-Output | TextContentItem] error_message: anyOf: - type: string - type: 'null' error_code: anyOf: - type: integer - type: 'null' metadata: anyOf: - additionalProperties: true type: object - type: 'null' type: object title: ToolInvocationResult description: Result of a tool invocation. URL: properties: uri: type: string title: Uri type: object required: - uri title: URL description: A URL reference to external content. ToolDef: properties: toolgroup_id: anyOf: - type: string - type: 'null' name: type: string title: Name description: anyOf: - type: string - type: 'null' input_schema: anyOf: - additionalProperties: true type: object - type: 'null' output_schema: anyOf: - additionalProperties: true type: object - type: 'null' metadata: anyOf: - additionalProperties: true type: object - type: 'null' type: object required: - name title: ToolDef description: Tool definition used in runtime contexts. ListToolDefsResponse: properties: data: items: $ref: '#/components/schemas/ToolDef' type: array title: Data type: object required: - data title: ListToolDefsResponse description: Response containing a list of tool definitions. ToolGroup: properties: identifier: type: string title: Identifier description: Unique identifier for this resource in llama stack provider_resource_id: anyOf: - type: string - type: 'null' description: Unique identifier for this resource in the provider provider_id: type: string title: Provider Id description: ID of the provider that owns this resource type: type: string const: tool_group title: Type default: tool_group mcp_endpoint: anyOf: - $ref: '#/components/schemas/URL' title: URL - type: 'null' title: URL args: anyOf: - additionalProperties: true type: object - type: 'null' type: object required: - identifier - provider_id title: ToolGroup description: A group of related tools managed together. ListToolGroupsResponse: properties: data: items: $ref: '#/components/schemas/ToolGroup' type: array title: Data type: object required: - data title: ListToolGroupsResponse description: Response containing a list of tool groups. Chunk: description: A chunk of content from file processing. properties: content: anyOf: - type: string - discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem - items: discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem type: array title: list[ImageContentItem | TextContentItem] title: string | list[ImageContentItem | TextContentItem] chunk_id: title: Chunk Id type: string metadata: additionalProperties: true title: Metadata type: object chunk_metadata: $ref: '#/components/schemas/ChunkMetadata' required: - content - chunk_id - chunk_metadata title: Chunk type: object ChunkMetadata: properties: chunk_id: anyOf: - type: string - type: 'null' document_id: anyOf: - type: string - type: 'null' source: anyOf: - type: string - type: 'null' created_timestamp: anyOf: - type: integer - type: 'null' updated_timestamp: anyOf: - type: integer - type: 'null' chunk_window: anyOf: - type: string - type: 'null' chunk_tokenizer: anyOf: - type: string - type: 'null' content_token_count: anyOf: - type: integer - type: 'null' metadata_token_count: anyOf: - type: integer - type: 'null' type: object title: ChunkMetadata description: |- `ChunkMetadata` is backend metadata for a `Chunk` that is used to store additional information about the chunk that will not be used in the context during inference, but is required for backend functionality. The `ChunkMetadata` is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not expected to change after. Use `Chunk.metadata` for metadata that will be used in the context during inference. InsertChunksRequest: properties: vector_store_id: type: string title: Vector Store Id description: The ID of the vector store to insert chunks into. chunks: items: $ref: '#/components/schemas/EmbeddedChunk-Input' type: array title: Chunks description: The list of embedded chunks to insert. ttl_seconds: anyOf: - type: integer - type: 'null' description: Time-to-live in seconds for the inserted chunks. type: object required: - vector_store_id - chunks title: InsertChunksRequest description: Request body for inserting chunks into a vector store. QueryChunksRequest: properties: vector_store_id: type: string title: Vector Store Id description: The ID of the vector store to query. query: anyOf: - type: string - oneOf: - $ref: '#/components/schemas/ImageContentItem-Input' title: ImageContentItem-Input - $ref: '#/components/schemas/TextContentItem' title: TextContentItem discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem-Input' text: '#/components/schemas/TextContentItem' title: ImageContentItem-Input | TextContentItem - items: oneOf: - $ref: '#/components/schemas/ImageContentItem-Input' title: ImageContentItem-Input - $ref: '#/components/schemas/TextContentItem' title: TextContentItem discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem-Input' text: '#/components/schemas/TextContentItem' title: ImageContentItem-Input | TextContentItem type: array title: list[ImageContentItem-Input | TextContentItem] title: string | list[ImageContentItem-Input | TextContentItem] description: The query content to search for. params: anyOf: - additionalProperties: true type: object - type: 'null' description: Additional query parameters. type: object required: - vector_store_id - query title: QueryChunksRequest description: Request body for querying chunks from a vector store. QueryChunksResponse: properties: chunks: items: $ref: '#/components/schemas/EmbeddedChunk-Output' type: array title: Chunks scores: items: type: number type: array title: Scores type: object required: - chunks - scores title: QueryChunksResponse description: Response from querying chunks in a vector database. VectorStoreFileCounts: properties: completed: type: integer title: Completed cancelled: type: integer title: Cancelled failed: type: integer title: Failed in_progress: type: integer title: In Progress total: type: integer title: Total type: object required: - completed - cancelled - failed - in_progress - total title: VectorStoreFileCounts description: File processing status counts for a vector store. VectorStoreListResponse: properties: object: type: string title: Object default: list data: items: $ref: '#/components/schemas/VectorStoreObject' type: array title: Data first_id: anyOf: - type: string - type: 'null' last_id: anyOf: - type: string - type: 'null' has_more: type: boolean title: Has More default: false type: object required: - data title: VectorStoreListResponse description: Response from listing vector stores. VectorStoreObject: properties: id: type: string title: Id object: type: string title: Object default: vector_store created_at: type: integer title: Created At name: anyOf: - type: string - type: 'null' usage_bytes: type: integer title: Usage Bytes default: 0 file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' status: type: string title: Status default: completed expires_after: anyOf: - additionalProperties: true type: object - type: 'null' expires_at: anyOf: - type: integer - type: 'null' last_active_at: anyOf: - type: integer - type: 'null' metadata: additionalProperties: true type: object title: Metadata type: object required: - id - created_at - file_counts title: VectorStoreObject description: OpenAI Vector Store object. VectorStoreChunkingStrategy: discriminator: mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' propertyName: type oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic VectorStoreChunkingStrategyAuto: properties: type: type: string const: auto title: Type default: auto type: object title: VectorStoreChunkingStrategyAuto description: Automatic chunking strategy for vector store files. VectorStoreChunkingStrategyStatic: properties: type: type: string const: static title: Type default: static static: $ref: '#/components/schemas/VectorStoreChunkingStrategyStaticConfig' type: object required: - static title: VectorStoreChunkingStrategyStatic description: Static chunking strategy with configurable parameters. VectorStoreChunkingStrategyStaticConfig: properties: chunk_overlap_tokens: type: integer title: Chunk Overlap Tokens default: 400 max_chunk_size_tokens: type: integer maximum: 4096.0 minimum: 100.0 title: Max Chunk Size Tokens default: 800 type: object title: VectorStoreChunkingStrategyStaticConfig description: Configuration for static chunking strategy. OpenAICreateVectorStoreRequestWithExtraBody: properties: name: anyOf: - type: string - type: 'null' file_ids: anyOf: - items: type: string type: array - type: 'null' expires_after: anyOf: - additionalProperties: true type: object - type: 'null' chunking_strategy: anyOf: - oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic discriminator: propertyName: type mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - type: 'null' title: Chunking Strategy metadata: anyOf: - additionalProperties: true type: object - type: 'null' additionalProperties: true type: object title: OpenAICreateVectorStoreRequestWithExtraBody description: Request to create a vector store with extra_body support. VectorStoreDeleteResponse: properties: id: type: string title: Id object: type: string title: Object default: vector_store.deleted deleted: type: boolean title: Deleted default: true type: object required: - id title: VectorStoreDeleteResponse description: Response from deleting a vector store. OpenAICreateVectorStoreFileBatchRequestWithExtraBody: properties: file_ids: items: type: string type: array title: File Ids attributes: anyOf: - additionalProperties: true type: object - type: 'null' chunking_strategy: anyOf: - oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic discriminator: propertyName: type mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - type: 'null' title: Chunking Strategy additionalProperties: true type: object required: - file_ids title: OpenAICreateVectorStoreFileBatchRequestWithExtraBody description: Request to create a vector store file batch with extra_body support. VectorStoreFileBatchObject: properties: id: type: string title: Id object: type: string title: Object default: vector_store.file_batch created_at: type: integer title: Created At vector_store_id: type: string title: Vector Store Id status: title: Status type: string enum: - completed - in_progress - cancelled - failed default: completed file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' type: object required: - id - created_at - vector_store_id - status - file_counts title: VectorStoreFileBatchObject description: OpenAI Vector Store File Batch object. VectorStoreFileStatus: type: string enum: - completed - in_progress - cancelled - failed default: completed VectorStoreFileLastError: properties: code: title: Code type: string enum: - server_error - rate_limit_exceeded default: server_error message: type: string title: Message type: object required: - code - message title: VectorStoreFileLastError description: Error information for failed vector store file processing. VectorStoreFileObject: properties: id: type: string title: Id object: type: string title: Object default: vector_store.file attributes: additionalProperties: anyOf: - type: string maxLength: 512 - type: number - type: boolean title: string | number | boolean propertyNames: type: string maxLength: 64 type: object maxProperties: 16 title: Attributes description: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers. x-oaiTypeLabel: map chunking_strategy: oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic discriminator: propertyName: type mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' created_at: type: integer title: Created At last_error: anyOf: - $ref: '#/components/schemas/VectorStoreFileLastError' title: VectorStoreFileLastError - type: 'null' title: VectorStoreFileLastError status: title: Status type: string enum: - completed - in_progress - cancelled - failed default: completed usage_bytes: type: integer title: Usage Bytes default: 0 vector_store_id: type: string title: Vector Store Id type: object required: - id - chunking_strategy - created_at - status - vector_store_id title: VectorStoreFileObject description: OpenAI Vector Store File object. VectorStoreFilesListInBatchResponse: properties: object: type: string title: Object default: list data: items: $ref: '#/components/schemas/VectorStoreFileObject' type: array title: Data first_id: anyOf: - type: string - type: 'null' last_id: anyOf: - type: string - type: 'null' has_more: type: boolean title: Has More default: false type: object required: - data title: VectorStoreFilesListInBatchResponse description: Response from listing files in a vector store file batch. VectorStoreListFilesResponse: properties: object: type: string title: Object default: list data: items: $ref: '#/components/schemas/VectorStoreFileObject' type: array title: Data first_id: anyOf: - type: string - type: 'null' last_id: anyOf: - type: string - type: 'null' has_more: type: boolean title: Has More default: false type: object required: - data title: VectorStoreListFilesResponse description: Response from listing files in a vector store. VectorStoreFileDeleteResponse: properties: id: type: string title: Id object: type: string title: Object default: vector_store.file.deleted deleted: type: boolean title: Deleted default: true type: object required: - id title: VectorStoreFileDeleteResponse description: Response from deleting a vector store file. VectorStoreContent: properties: type: type: string const: text title: Type text: type: string title: Text embedding: anyOf: - items: type: number type: array - type: 'null' chunk_metadata: anyOf: - $ref: '#/components/schemas/ChunkMetadata' title: ChunkMetadata - type: 'null' title: ChunkMetadata metadata: anyOf: - additionalProperties: true type: object - type: 'null' type: object required: - type - text title: VectorStoreContent description: Content item from a vector store file or search result. VectorStoreFileContentResponse: properties: object: type: string const: vector_store.file_content.page title: Object default: vector_store.file_content.page data: items: $ref: '#/components/schemas/VectorStoreContent' type: array title: Data has_more: type: boolean title: Has More default: false next_page: anyOf: - type: string - type: 'null' type: object required: - data title: VectorStoreFileContentResponse description: Represents the parsed content of a vector store file. VectorStoreSearchResponse: properties: file_id: type: string title: File Id filename: type: string title: Filename score: type: number title: Score attributes: anyOf: - additionalProperties: anyOf: - type: string - type: number - type: boolean title: string | number | boolean type: object - type: 'null' content: items: $ref: '#/components/schemas/VectorStoreContent' type: array title: Content type: object required: - file_id - filename - score - content title: VectorStoreSearchResponse description: Response from searching a vector store. VectorStoreSearchResponsePage: properties: object: type: string title: Object default: vector_store.search_results.page search_query: items: type: string type: array title: Search Query data: items: $ref: '#/components/schemas/VectorStoreSearchResponse' type: array title: Data has_more: type: boolean title: Has More default: false next_page: anyOf: - type: string - type: 'null' type: object required: - search_query - data title: VectorStoreSearchResponsePage description: Paginated response from searching a vector store. VersionInfo: properties: version: type: string title: Version description: The version string of the service type: object required: - version title: VersionInfo description: Version information for the service. AppendRowsRequest: properties: dataset_id: type: string title: Dataset Id description: The ID of the dataset to append the rows to. rows: items: additionalProperties: true type: object type: array title: Rows description: The rows to append to the dataset. type: object required: - dataset_id - rows title: AppendRowsRequest description: Request model for appending rows to a dataset. PaginatedResponse: properties: data: items: additionalProperties: true type: object type: array title: Data has_more: type: boolean title: Has More url: anyOf: - type: string - type: 'null' type: object required: - data - has_more title: PaginatedResponse description: A generic paginated response that follows a simple format. Dataset: properties: identifier: type: string title: Identifier description: Unique identifier for this resource in llama stack provider_resource_id: anyOf: - type: string - type: 'null' description: Unique identifier for this resource in the provider provider_id: type: string title: Provider Id description: ID of the provider that owns this resource type: type: string const: dataset title: Type description: Type of resource, always 'dataset' for datasets default: dataset purpose: $ref: '#/components/schemas/DatasetPurpose' description: Purpose of the dataset indicating its intended use source: oneOf: - $ref: '#/components/schemas/URIDataSource' title: URIDataSource - $ref: '#/components/schemas/RowsDataSource' title: RowsDataSource title: URIDataSource | RowsDataSource description: Data source configuration for the dataset discriminator: propertyName: type mapping: rows: '#/components/schemas/RowsDataSource' uri: '#/components/schemas/URIDataSource' metadata: additionalProperties: true type: object title: Metadata description: Any additional metadata for this dataset type: object required: - identifier - provider_id - purpose - source title: Dataset description: Dataset resource for storing and accessing training or evaluation data. RowsDataSource: properties: type: type: string const: rows title: Type description: The type of data source. default: rows rows: items: additionalProperties: true type: object type: array title: Rows description: 'The dataset is stored in rows. E.g. [{"messages": [{"role": "user", "content": "Hello, world!"}, {"role": "assistant", "content": "Hello, world!"}]}]' type: object required: - rows title: RowsDataSource description: A dataset stored in rows. URIDataSource: properties: type: type: string const: uri title: Type description: The type of data source. default: uri uri: type: string title: Uri description: The dataset can be obtained from a URI. E.g. "https://mywebsite.com/mydata.jsonl", "lsfs://mydata.jsonl", "data:csv;base64,{base64_content}" type: object required: - uri title: URIDataSource description: A dataset that can be obtained from a URI. ListDatasetsResponse: properties: data: items: $ref: '#/components/schemas/Dataset' type: array title: Data description: List of datasets type: object required: - data title: ListDatasetsResponse description: Response from listing datasets. Benchmark: properties: identifier: type: string title: Identifier description: Unique identifier for this resource in llama stack provider_resource_id: anyOf: - type: string - type: 'null' description: Unique identifier for this resource in the provider provider_id: type: string title: Provider Id description: ID of the provider that owns this resource type: type: string const: benchmark title: Type description: The resource type, always benchmark. default: benchmark dataset_id: type: string title: Dataset Id description: Identifier of the dataset to use for the benchmark evaluation. scoring_functions: items: type: string type: array title: Scoring Functions description: List of scoring function identifiers to apply during evaluation. metadata: additionalProperties: true type: object title: Metadata description: Metadata for this evaluation task. type: object required: - identifier - provider_id - dataset_id - scoring_functions title: Benchmark description: A benchmark resource for evaluating model performance. ListBenchmarksResponse: properties: data: items: $ref: '#/components/schemas/Benchmark' type: array title: Data description: List of benchmark objects. type: object required: - data title: ListBenchmarksResponse description: Response containing a list of benchmark objects. BenchmarkConfig: properties: eval_candidate: $ref: '#/components/schemas/ModelCandidate' description: The candidate to evaluate scoring_params: additionalProperties: oneOf: - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' title: LLMAsJudgeScoringFnParams - $ref: '#/components/schemas/RegexParserScoringFnParams' title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams discriminator: propertyName: type mapping: basic: '#/components/schemas/BasicScoringFnParams' llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' regex_parser: '#/components/schemas/RegexParserScoringFnParams' title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams type: object title: Scoring Params description: Map between scoring function id and parameters for each scoring function you want to run num_examples: anyOf: - type: integer minimum: 1.0 - type: 'null' description: Number of examples to evaluate (useful for testing), if not provided, all examples in the dataset will be evaluated type: object required: - eval_candidate title: BenchmarkConfig description: A benchmark configuration for evaluation. GreedySamplingStrategy: properties: type: type: string const: greedy title: Type description: Must be 'greedy' to identify this sampling strategy. default: greedy type: object title: GreedySamplingStrategy description: Greedy sampling strategy that selects the highest probability token at each step. ModelCandidate: properties: type: type: string const: model title: Type default: model model: type: string minLength: 1 title: Model description: The model ID to evaluate sampling_params: $ref: '#/components/schemas/SamplingParams' description: The sampling parameters for the model system_message: anyOf: - $ref: '#/components/schemas/SystemMessage' title: SystemMessage - type: 'null' description: The system message providing instructions or context to the model title: SystemMessage type: object required: - model - sampling_params title: ModelCandidate description: A model candidate for evaluation. SamplingParams: properties: strategy: oneOf: - $ref: '#/components/schemas/GreedySamplingStrategy' title: GreedySamplingStrategy - $ref: '#/components/schemas/TopPSamplingStrategy' title: TopPSamplingStrategy - $ref: '#/components/schemas/TopKSamplingStrategy' title: TopKSamplingStrategy title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy description: The sampling strategy to use. discriminator: propertyName: type mapping: greedy: '#/components/schemas/GreedySamplingStrategy' top_k: '#/components/schemas/TopKSamplingStrategy' top_p: '#/components/schemas/TopPSamplingStrategy' max_tokens: anyOf: - type: integer minimum: 1.0 - type: 'null' description: The maximum number of tokens that can be generated in the completion. The token count of your prompt plus max_tokens cannot exceed the model's context length. repetition_penalty: anyOf: - type: number maximum: 2.0 minimum: -2.0 - type: 'null' description: Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far. default: 1.0 stop: anyOf: - items: type: string type: array maxItems: 4 - type: 'null' description: Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence. type: object title: SamplingParams description: Sampling parameters for text generation. SystemMessage: properties: role: type: string const: system title: Role description: Must be 'system' to identify this as a system message. default: system content: anyOf: - type: string - oneOf: - $ref: '#/components/schemas/ImageContentItem-Input' title: ImageContentItem-Input - $ref: '#/components/schemas/TextContentItem' title: TextContentItem discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem-Input' text: '#/components/schemas/TextContentItem' title: ImageContentItem-Input | TextContentItem - items: oneOf: - $ref: '#/components/schemas/ImageContentItem-Input' title: ImageContentItem-Input - $ref: '#/components/schemas/TextContentItem' title: TextContentItem discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem-Input' text: '#/components/schemas/TextContentItem' title: ImageContentItem-Input | TextContentItem type: array title: list[ImageContentItem-Input | TextContentItem] title: string | list[ImageContentItem-Input | TextContentItem] description: The content of the 'system prompt'. If multiple system messages are provided, they are concatenated. The underlying Llama Stack code may also add other system messages. type: object required: - content title: SystemMessage description: A system message providing instructions or context to the model. TopKSamplingStrategy: properties: type: type: string const: top_k title: Type description: Must be 'top_k' to identify this sampling strategy. default: top_k top_k: type: integer minimum: 1.0 title: Top K description: Number of top tokens to consider for sampling. Must be at least 1. type: object required: - top_k title: TopKSamplingStrategy description: Top-k sampling strategy that restricts sampling to the k most likely tokens. TopPSamplingStrategy: properties: type: type: string const: top_p title: Type description: Must be 'top_p' to identify this sampling strategy. default: top_p temperature: type: number maximum: 2.0 title: Temperature description: Controls randomness in sampling. Higher values increase randomness. minimum: 0.0 top_p: type: number maximum: 1.0 minimum: 0.0 title: Top P description: Cumulative probability threshold for nucleus sampling. default: 0.95 type: object required: - temperature title: TopPSamplingStrategy description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. EvaluateRowsRequest: description: Request model for evaluating a list of rows on a benchmark. properties: benchmark_id: description: The ID of the benchmark to run the evaluation on minLength: 1 title: Benchmark Id type: string input_rows: description: The rows to evaluate items: additionalProperties: true type: object minItems: 1 title: Input Rows type: array scoring_functions: description: The scoring functions to use for the evaluation items: type: string minItems: 1 title: Scoring Functions type: array benchmark_config: $ref: '#/components/schemas/BenchmarkConfig' description: The configuration for the benchmark required: - benchmark_id - input_rows - scoring_functions - benchmark_config title: EvaluateRowsRequest type: object EvaluateResponse: properties: generations: items: additionalProperties: true type: object type: array title: Generations description: The generations from the evaluation scores: additionalProperties: $ref: '#/components/schemas/ScoringResult' type: object title: Scores description: The scores from the evaluation. Each key in the dict is a scoring function name type: object required: - generations - scores title: EvaluateResponse description: The response from an evaluation. RunEvalRequest: description: Request model for running an evaluation on a benchmark. properties: benchmark_id: description: The ID of the benchmark to run the evaluation on minLength: 1 title: Benchmark Id type: string benchmark_config: $ref: '#/components/schemas/BenchmarkConfig' description: The configuration for the benchmark required: - benchmark_id - benchmark_config title: RunEvalRequest type: object Job: properties: job_id: type: string title: Job Id status: $ref: '#/components/schemas/JobStatus' type: object required: - job_id - status title: Job description: A job execution instance with status tracking. RerankRequest: properties: model: type: string title: Model description: The identifier of the reranking model to use. query: anyOf: - type: string - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' title: OpenAIChatCompletionContentPartTextParam - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' title: OpenAIChatCompletionContentPartImageParam title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam description: The search query to rank items against. Can be a string, text content part, or image content part. items: items: anyOf: - type: string - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' title: OpenAIChatCompletionContentPartTextParam - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' title: OpenAIChatCompletionContentPartImageParam title: string | OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam type: array minItems: 1 title: Items description: List of items to rerank. Each item can be a string, text content part, or image content part. max_num_results: anyOf: - type: integer minimum: 1.0 - type: 'null' description: 'Maximum number of results to return. Default: returns all.' type: object required: - model - query - items title: RerankRequest description: Request model for reranking documents. RerankData: properties: index: type: integer minimum: 0.0 title: Index description: The original index of the document in the input list. relevance_score: type: number title: Relevance Score description: The relevance score from the model output. Higher scores indicate greater relevance. type: object required: - index - relevance_score title: RerankData description: A single rerank result from a reranking response. RerankResponse: properties: data: items: $ref: '#/components/schemas/RerankData' type: array title: Data description: List of rerank result objects, sorted by relevance score (descending). type: object required: - data title: RerankResponse description: Response from a reranking request. Checkpoint: properties: identifier: type: string title: Identifier created_at: type: string format: date-time title: Created At epoch: type: integer title: Epoch post_training_job_id: type: string title: Post Training Job Id path: type: string title: Path training_metrics: anyOf: - $ref: '#/components/schemas/PostTrainingMetric' title: PostTrainingMetric - type: 'null' title: PostTrainingMetric type: object required: - identifier - created_at - epoch - post_training_job_id - path title: Checkpoint description: Checkpoint created during training runs. PostTrainingJobArtifactsResponse: properties: job_uuid: type: string title: Job Uuid checkpoints: items: $ref: '#/components/schemas/Checkpoint' type: array title: Checkpoints type: object required: - job_uuid title: PostTrainingJobArtifactsResponse description: Artifacts of a finetuning job. PostTrainingMetric: properties: epoch: type: integer title: Epoch train_loss: type: number title: Train Loss validation_loss: type: number title: Validation Loss perplexity: type: number title: Perplexity type: object required: - epoch - train_loss - validation_loss - perplexity title: PostTrainingMetric description: Training metrics captured during post-training jobs. CancelTrainingJobRequest: description: Request to cancel a training job. properties: job_uuid: description: The UUID of the job to cancel. title: Job Uuid type: string required: - job_uuid title: CancelTrainingJobRequest type: object PostTrainingJobStatusResponse: properties: job_uuid: type: string title: Job Uuid status: $ref: '#/components/schemas/JobStatus' scheduled_at: anyOf: - type: string format: date-time - type: 'null' started_at: anyOf: - type: string format: date-time - type: 'null' completed_at: anyOf: - type: string format: date-time - type: 'null' resources_allocated: anyOf: - additionalProperties: true type: object - type: 'null' checkpoints: items: $ref: '#/components/schemas/Checkpoint' type: array title: Checkpoints type: object required: - job_uuid - status title: PostTrainingJobStatusResponse description: Status of a finetuning job. ListPostTrainingJobsResponse: properties: data: items: $ref: '#/components/schemas/PostTrainingJob' type: array title: Data type: object required: - data title: ListPostTrainingJobsResponse DPOAlignmentConfig: properties: beta: type: number title: Beta loss_type: $ref: '#/components/schemas/DPOLossType' default: sigmoid type: object required: - beta title: DPOAlignmentConfig description: Configuration for Direct Preference Optimization (DPO) alignment. DPOLossType: type: string enum: - sigmoid - hinge - ipo - kto_pair title: DPOLossType DataConfig: properties: dataset_id: type: string title: Dataset Id batch_size: type: integer title: Batch Size shuffle: type: boolean title: Shuffle data_format: $ref: '#/components/schemas/DatasetFormat' validation_dataset_id: anyOf: - type: string - type: 'null' packed: anyOf: - type: boolean - type: 'null' default: false train_on_input: anyOf: - type: boolean - type: 'null' default: false type: object required: - dataset_id - batch_size - shuffle - data_format title: DataConfig description: Configuration for training data and data loading. DatasetFormat: type: string enum: - instruct - dialog title: DatasetFormat description: Format of the training dataset. EfficiencyConfig: properties: enable_activation_checkpointing: anyOf: - type: boolean - type: 'null' default: false enable_activation_offloading: anyOf: - type: boolean - type: 'null' default: false memory_efficient_fsdp_wrap: anyOf: - type: boolean - type: 'null' default: false fsdp_cpu_offload: anyOf: - type: boolean - type: 'null' default: false type: object title: EfficiencyConfig description: Configuration for memory and compute efficiency optimizations. OptimizerConfig: properties: optimizer_type: $ref: '#/components/schemas/OptimizerType' lr: type: number title: Lr weight_decay: type: number title: Weight Decay num_warmup_steps: type: integer title: Num Warmup Steps type: object required: - optimizer_type - lr - weight_decay - num_warmup_steps title: OptimizerConfig description: Configuration parameters for the optimization algorithm. OptimizerType: type: string enum: - adam - adamw - sgd title: OptimizerType description: Available optimizer algorithms for training. TrainingConfig: properties: n_epochs: type: integer title: N Epochs max_steps_per_epoch: type: integer title: Max Steps Per Epoch default: 1 gradient_accumulation_steps: type: integer title: Gradient Accumulation Steps default: 1 max_validation_steps: anyOf: - type: integer - type: 'null' default: 1 data_config: anyOf: - $ref: '#/components/schemas/DataConfig' title: DataConfig - type: 'null' title: DataConfig optimizer_config: anyOf: - $ref: '#/components/schemas/OptimizerConfig' title: OptimizerConfig - type: 'null' title: OptimizerConfig efficiency_config: anyOf: - $ref: '#/components/schemas/EfficiencyConfig' title: EfficiencyConfig - type: 'null' title: EfficiencyConfig dtype: anyOf: - type: string - type: 'null' default: bf16 type: object required: - n_epochs title: TrainingConfig description: Comprehensive configuration for the training process. PreferenceOptimizeRequest: properties: job_uuid: type: string title: Job Uuid description: The UUID of the job to create. finetuned_model: type: string title: Finetuned Model description: The model to fine-tune. algorithm_config: $ref: '#/components/schemas/DPOAlignmentConfig' description: The algorithm configuration. training_config: $ref: '#/components/schemas/TrainingConfig' description: The training configuration. hyperparam_search_config: additionalProperties: true type: object title: Hyperparam Search Config description: The hyperparam search configuration. logger_config: additionalProperties: true type: object title: Logger Config description: The logger configuration. type: object required: - job_uuid - finetuned_model - algorithm_config - training_config - hyperparam_search_config - logger_config title: PreferenceOptimizeRequest description: Request to run preference optimization of a model. PostTrainingJob: properties: job_uuid: type: string title: Job Uuid type: object required: - job_uuid title: PostTrainingJob AlgorithmConfig: discriminator: mapping: LoRA: '#/components/schemas/LoraFinetuningConfig' QAT: '#/components/schemas/QATFinetuningConfig' propertyName: type oneOf: - $ref: '#/components/schemas/LoraFinetuningConfig' title: LoraFinetuningConfig - $ref: '#/components/schemas/QATFinetuningConfig' title: QATFinetuningConfig title: LoraFinetuningConfig | QATFinetuningConfig LoraFinetuningConfig: properties: type: type: string const: LoRA title: Type default: LoRA lora_attn_modules: items: type: string type: array title: Lora Attn Modules apply_lora_to_mlp: type: boolean title: Apply Lora To Mlp apply_lora_to_output: type: boolean title: Apply Lora To Output rank: type: integer title: Rank alpha: type: integer title: Alpha use_dora: anyOf: - type: boolean - type: 'null' default: false quantize_base: anyOf: - type: boolean - type: 'null' default: false type: object required: - lora_attn_modules - apply_lora_to_mlp - apply_lora_to_output - rank - alpha title: LoraFinetuningConfig description: Configuration for Low-Rank Adaptation (LoRA) fine-tuning. QATFinetuningConfig: properties: type: type: string const: QAT title: Type default: QAT quantizer_name: type: string title: Quantizer Name group_size: type: integer title: Group Size type: object required: - quantizer_name - group_size title: QATFinetuningConfig description: Configuration for Quantization-Aware Training (QAT) fine-tuning. SupervisedFineTuneRequest: properties: job_uuid: type: string title: Job Uuid description: The UUID of the job to create. training_config: $ref: '#/components/schemas/TrainingConfig' description: The training configuration. hyperparam_search_config: additionalProperties: true type: object title: Hyperparam Search Config description: The hyperparam search configuration. logger_config: additionalProperties: true type: object title: Logger Config description: The logger configuration. model: anyOf: - type: string - type: 'null' description: Model descriptor for training if not in provider config checkpoint_dir: anyOf: - type: string - type: 'null' description: The directory to save checkpoint(s) to. algorithm_config: anyOf: - oneOf: - $ref: '#/components/schemas/LoraFinetuningConfig' title: LoraFinetuningConfig - $ref: '#/components/schemas/QATFinetuningConfig' title: QATFinetuningConfig discriminator: propertyName: type mapping: LoRA: '#/components/schemas/LoraFinetuningConfig' QAT: '#/components/schemas/QATFinetuningConfig' title: LoraFinetuningConfig | QATFinetuningConfig - type: 'null' title: Algorithm Config description: The algorithm configuration. type: object required: - job_uuid - training_config - hyperparam_search_config - logger_config title: SupervisedFineTuneRequest description: Request to run supervised fine-tuning of a model. RegisterModelRequest: properties: model_id: type: string title: Model Id description: The identifier of the model to register. provider_model_id: anyOf: - type: string - type: 'null' description: The identifier of the model in the provider. provider_id: anyOf: - type: string - type: 'null' description: The identifier of the provider. metadata: anyOf: - additionalProperties: true type: object - type: 'null' description: Any additional metadata for this model. model_type: anyOf: - $ref: '#/components/schemas/ModelType' title: ModelType - type: 'null' description: The type of model to register. title: ModelType type: object required: - model_id title: RegisterModelRequest description: Request model for registering a model. ParamType: discriminator: mapping: array: '#/components/schemas/ArrayType' boolean: '#/components/schemas/BooleanType' chat_completion_input: '#/components/schemas/ChatCompletionInputType' completion_input: '#/components/schemas/CompletionInputType' json: '#/components/schemas/JsonType' number: '#/components/schemas/NumberType' object: '#/components/schemas/ObjectType' string: '#/components/schemas/StringType' union: '#/components/schemas/UnionType' propertyName: type oneOf: - $ref: '#/components/schemas/StringType' title: StringType - $ref: '#/components/schemas/NumberType' title: NumberType - $ref: '#/components/schemas/BooleanType' title: BooleanType - $ref: '#/components/schemas/ArrayType' title: ArrayType - $ref: '#/components/schemas/ObjectType' title: ObjectType - $ref: '#/components/schemas/JsonType' title: JsonType - $ref: '#/components/schemas/UnionType' title: UnionType - $ref: '#/components/schemas/ChatCompletionInputType' title: ChatCompletionInputType - $ref: '#/components/schemas/CompletionInputType' title: CompletionInputType title: StringType | ... (9 variants) RegisterScoringFunctionRequest: properties: scoring_fn_id: type: string title: Scoring Fn Id description: The ID of the scoring function to register. description: type: string title: Description description: The description of the scoring function. return_type: oneOf: - $ref: '#/components/schemas/StringType' title: StringType - $ref: '#/components/schemas/NumberType' title: NumberType - $ref: '#/components/schemas/BooleanType' title: BooleanType - $ref: '#/components/schemas/ArrayType' title: ArrayType - $ref: '#/components/schemas/ObjectType' title: ObjectType - $ref: '#/components/schemas/JsonType' title: JsonType - $ref: '#/components/schemas/UnionType' title: UnionType - $ref: '#/components/schemas/ChatCompletionInputType' title: ChatCompletionInputType - $ref: '#/components/schemas/CompletionInputType' title: CompletionInputType title: StringType | ... (9 variants) description: The return type of the scoring function. discriminator: propertyName: type mapping: array: '#/components/schemas/ArrayType' boolean: '#/components/schemas/BooleanType' chat_completion_input: '#/components/schemas/ChatCompletionInputType' completion_input: '#/components/schemas/CompletionInputType' json: '#/components/schemas/JsonType' number: '#/components/schemas/NumberType' object: '#/components/schemas/ObjectType' string: '#/components/schemas/StringType' union: '#/components/schemas/UnionType' provider_scoring_fn_id: anyOf: - type: string - type: 'null' description: The ID of the provider scoring function to use for the scoring function. provider_id: anyOf: - type: string - type: 'null' description: The ID of the provider to use for the scoring function. params: anyOf: - oneOf: - $ref: '#/components/schemas/LLMAsJudgeScoringFnParams' title: LLMAsJudgeScoringFnParams - $ref: '#/components/schemas/RegexParserScoringFnParams' title: RegexParserScoringFnParams - $ref: '#/components/schemas/BasicScoringFnParams' title: BasicScoringFnParams discriminator: propertyName: type mapping: basic: '#/components/schemas/BasicScoringFnParams' llm_as_judge: '#/components/schemas/LLMAsJudgeScoringFnParams' regex_parser: '#/components/schemas/RegexParserScoringFnParams' title: LLMAsJudgeScoringFnParams | RegexParserScoringFnParams | BasicScoringFnParams - type: 'null' title: Params description: The parameters for the scoring function for benchmark eval, these can be overridden for app eval. type: object required: - scoring_fn_id - description - return_type title: RegisterScoringFunctionRequest description: Request model for registering a scoring function. RegisterShieldRequest: properties: shield_id: type: string title: Shield Id description: The identifier of the shield to register. provider_shield_id: anyOf: - type: string - type: 'null' description: The identifier of the shield in the provider. provider_id: anyOf: - type: string - type: 'null' description: The identifier of the provider. params: anyOf: - additionalProperties: true type: object - type: 'null' description: The parameters of the shield. type: object required: - shield_id title: RegisterShieldRequest description: Request model for registering a shield. DataSource: discriminator: mapping: rows: '#/components/schemas/RowsDataSource' uri: '#/components/schemas/URIDataSource' propertyName: type oneOf: - $ref: '#/components/schemas/URIDataSource' title: URIDataSource - $ref: '#/components/schemas/RowsDataSource' title: RowsDataSource title: URIDataSource | RowsDataSource RegisterDatasetRequest: properties: purpose: $ref: '#/components/schemas/DatasetPurpose' description: The purpose of the dataset. source: oneOf: - $ref: '#/components/schemas/URIDataSource' title: URIDataSource - $ref: '#/components/schemas/RowsDataSource' title: RowsDataSource title: URIDataSource | RowsDataSource description: The data source of the dataset. discriminator: propertyName: type mapping: rows: '#/components/schemas/RowsDataSource' uri: '#/components/schemas/URIDataSource' metadata: anyOf: - additionalProperties: true type: object - type: 'null' description: The metadata for the dataset. dataset_id: anyOf: - type: string - type: 'null' description: The ID of the dataset. If not provided, an ID will be generated. type: object required: - purpose - source title: RegisterDatasetRequest description: Request model for registering a dataset. RegisterBenchmarkRequest: properties: benchmark_id: type: string title: Benchmark Id description: The ID of the benchmark to register. dataset_id: type: string title: Dataset Id description: The ID of the dataset to use for the benchmark. scoring_functions: items: type: string type: array title: Scoring Functions description: The scoring functions to use for the benchmark. provider_benchmark_id: anyOf: - type: string - type: 'null' description: The ID of the provider benchmark to use for the benchmark. provider_id: anyOf: - type: string - type: 'null' description: The ID of the provider to use for the benchmark. metadata: anyOf: - additionalProperties: true type: object - type: 'null' description: The metadata to use for the benchmark. type: object required: - benchmark_id - dataset_id - scoring_functions title: RegisterBenchmarkRequest description: Request model for registering a benchmark. AllowedToolsFilter: properties: tool_names: anyOf: - items: type: string type: array - type: 'null' type: object title: AllowedToolsFilter description: Filter configuration for restricting which MCP tools can be used. ApprovalFilter: properties: always: anyOf: - items: type: string type: array - type: 'null' never: anyOf: - items: type: string type: array - type: 'null' type: object title: ApprovalFilter description: Filter configuration for MCP tool approval requirements. BatchError: properties: code: anyOf: - type: string - type: 'null' line: anyOf: - type: integer - type: 'null' message: anyOf: - type: string - type: 'null' param: anyOf: - type: string - type: 'null' additionalProperties: true type: object title: BatchError BatchRequestCounts: properties: completed: type: integer title: Completed failed: type: integer title: Failed total: type: integer title: Total additionalProperties: true type: object required: - completed - failed - total title: BatchRequestCounts BatchUsage: properties: input_tokens: type: integer title: Input Tokens input_tokens_details: $ref: '#/components/schemas/InputTokensDetails' output_tokens: type: integer title: Output Tokens output_tokens_details: $ref: '#/components/schemas/OutputTokensDetails' total_tokens: type: integer title: Total Tokens additionalProperties: true type: object required: - input_tokens - input_tokens_details - output_tokens - output_tokens_details - total_tokens title: BatchUsage Body_upload_file_v1_files_post: properties: file: type: string format: binary title: File description: The file to upload. purpose: $ref: '#/components/schemas/OpenAIFilePurpose' description: The intended purpose of the uploaded file. expires_after: anyOf: - $ref: '#/components/schemas/ExpiresAfter' title: ExpiresAfter - type: 'null' description: Optional expiration settings. title: ExpiresAfter type: object required: - file - purpose title: Body_upload_file_v1_files_post Connector: properties: connector_type: $ref: '#/components/schemas/ConnectorType' default: mcp connector_id: type: string title: Connector Id description: Identifier for the connector url: type: string title: Url description: URL of the connector server_label: anyOf: - type: string - type: 'null' description: Label of the server server_name: anyOf: - type: string - type: 'null' description: Name of the server server_description: anyOf: - type: string - type: 'null' description: Description of the server server_version: anyOf: - type: string - type: 'null' description: Version of the server type: object required: - connector_id - url title: Connector description: A connector registered in Llama Stack ConnectorType: type: string enum: - mcp title: ConnectorType description: Type of connector. ConversationItemInclude: type: string enum: - web_search_call.action.sources - code_interpreter_call.outputs - computer_call_output.output.image_url - file_search_call.results - message.input_image.image_url - message.output_text.logprobs - reasoning.encrypted_content title: ConversationItemInclude description: Specify additional output data to include in the model response. CreateResponseRequest: properties: input: anyOf: - type: string - items: anyOf: - oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage-Input' title: OpenAIResponseMessage-Input - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest discriminator: propertyName: type mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage-Input' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseMessage-Input | ... (7 variants) - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseMessage-Input' title: OpenAIResponseMessage-Input title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseMessage-Input type: array title: list[OpenAIResponseMessageUnion | OpenAIResponseInputFunctionToolCallOutput | ...] title: string | list[OpenAIResponseMessageUnion | OpenAIResponseInputFunctionToolCallOutput | ...] description: Input message(s) to create the response. model: type: string title: Model description: The underlying LLM used for completions. prompt: anyOf: - $ref: '#/components/schemas/OpenAIResponsePrompt' title: OpenAIResponsePrompt - type: 'null' description: Prompt object with ID, version, and variables. title: OpenAIResponsePrompt instructions: anyOf: - type: string - type: 'null' description: Instructions to guide the model's behavior. parallel_tool_calls: anyOf: - type: boolean - type: 'null' description: Whether to enable parallel tool calls. default: true previous_response_id: anyOf: - type: string - type: 'null' description: Optional ID of a previous response to continue from. conversation: anyOf: - type: string - type: 'null' description: Optional ID of a conversation to add the response to. store: anyOf: - type: boolean - type: 'null' description: Whether to store the response in the database. default: true stream: anyOf: - type: boolean - type: 'null' description: Whether to stream the response. default: false temperature: anyOf: - type: number maximum: 2.0 minimum: 0.0 - type: 'null' description: Sampling temperature. text: anyOf: - $ref: '#/components/schemas/OpenAIResponseText' title: OpenAIResponseText - type: 'null' description: Configuration for text response generation. title: OpenAIResponseText tool_choice: anyOf: - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceMode' title: OpenAIResponseInputToolChoiceMode - oneOf: - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceAllowedTools' title: OpenAIResponseInputToolChoiceAllowedTools - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceFileSearch' title: OpenAIResponseInputToolChoiceFileSearch - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' title: OpenAIResponseInputToolChoiceWebSearch - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceFunctionTool' title: OpenAIResponseInputToolChoiceFunctionTool - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceMCPTool' title: OpenAIResponseInputToolChoiceMCPTool - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceCustomTool' title: OpenAIResponseInputToolChoiceCustomTool discriminator: propertyName: type mapping: allowed_tools: '#/components/schemas/OpenAIResponseInputToolChoiceAllowedTools' custom: '#/components/schemas/OpenAIResponseInputToolChoiceCustomTool' file_search: '#/components/schemas/OpenAIResponseInputToolChoiceFileSearch' function: '#/components/schemas/OpenAIResponseInputToolChoiceFunctionTool' mcp: '#/components/schemas/OpenAIResponseInputToolChoiceMCPTool' web_search: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' web_search_preview: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' title: OpenAIResponseInputToolChoiceAllowedTools | ... (6 variants) - type: 'null' title: OpenAIResponseInputToolChoiceMode description: How the model should select which tool to call (if any). tools: anyOf: - items: oneOf: - $ref: '#/components/schemas/OpenAIResponseInputToolWebSearch' title: OpenAIResponseInputToolWebSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFileSearch' title: OpenAIResponseInputToolFileSearch - $ref: '#/components/schemas/OpenAIResponseInputToolFunction' title: OpenAIResponseInputToolFunction - $ref: '#/components/schemas/OpenAIResponseInputToolMCP' title: OpenAIResponseInputToolMCP discriminator: propertyName: type mapping: file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' function: '#/components/schemas/OpenAIResponseInputToolFunction' mcp: '#/components/schemas/OpenAIResponseInputToolMCP' web_search: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview: '#/components/schemas/OpenAIResponseInputToolWebSearch' web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolWebSearch' title: OpenAIResponseInputToolWebSearch | ... (4 variants) type: array - type: 'null' description: List of tools available to the model. include: anyOf: - items: $ref: '#/components/schemas/ResponseItemInclude' type: array - type: 'null' description: Additional fields to include in the response. max_infer_iters: anyOf: - type: integer minimum: 1.0 - type: 'null' description: Maximum number of inference iterations. default: 10 guardrails: anyOf: - items: anyOf: - type: string - $ref: '#/components/schemas/ResponseGuardrailSpec' title: ResponseGuardrailSpec title: string | ResponseGuardrailSpec type: array - type: 'null' description: List of guardrails to apply during response generation. max_tool_calls: anyOf: - type: integer minimum: 1.0 - type: 'null' description: Max number of total calls to built-in tools that can be processed in a response. max_output_tokens: anyOf: - type: integer minimum: 16.0 - type: 'null' description: Upper bound for the number of tokens that can be generated for a response. reasoning: anyOf: - $ref: '#/components/schemas/OpenAIResponseReasoning' title: OpenAIResponseReasoning - type: 'null' description: Configuration for reasoning effort in responses. title: OpenAIResponseReasoning safety_identifier: anyOf: - type: string maxLength: 64 - type: 'null' description: A stable identifier used for safety monitoring and abuse detection. metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' description: Dictionary of metadata key-value pairs to attach to the response. additionalProperties: false type: object required: - input - model title: CreateResponseRequest description: Request model for creating a response. DatasetPurpose: type: string enum: - post-training/messages - eval/question-answer - eval/messages-answer title: DatasetPurpose description: Purpose of the dataset. Each purpose has a required input data schema. EmbeddedChunk-Input: properties: content: anyOf: - type: string - oneOf: - $ref: '#/components/schemas/ImageContentItem-Input' title: ImageContentItem-Input - $ref: '#/components/schemas/TextContentItem' title: TextContentItem discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem-Input' text: '#/components/schemas/TextContentItem' title: ImageContentItem-Input | TextContentItem - items: oneOf: - $ref: '#/components/schemas/ImageContentItem-Input' title: ImageContentItem-Input - $ref: '#/components/schemas/TextContentItem' title: TextContentItem discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem-Input' text: '#/components/schemas/TextContentItem' title: ImageContentItem-Input | TextContentItem type: array title: list[ImageContentItem-Input | TextContentItem] title: string | list[ImageContentItem-Input | TextContentItem] chunk_id: type: string title: Chunk Id metadata: additionalProperties: true type: object title: Metadata chunk_metadata: $ref: '#/components/schemas/ChunkMetadata' embedding: items: type: number type: array title: Embedding embedding_model: type: string title: Embedding Model embedding_dimension: type: integer title: Embedding Dimension type: object required: - content - chunk_id - chunk_metadata - embedding - embedding_model - embedding_dimension title: EmbeddedChunk description: |- A chunk of content with its embedding vector for vector database operations. Inherits all fields from Chunk and adds embedding-related fields. EmbeddedChunk-Output: properties: content: anyOf: - type: string - oneOf: - $ref: '#/components/schemas/ImageContentItem-Output' title: ImageContentItem-Output - $ref: '#/components/schemas/TextContentItem' title: TextContentItem discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem-Output' text: '#/components/schemas/TextContentItem' title: ImageContentItem-Output | TextContentItem - items: oneOf: - $ref: '#/components/schemas/ImageContentItem-Output' title: ImageContentItem-Output - $ref: '#/components/schemas/TextContentItem' title: TextContentItem discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem-Output' text: '#/components/schemas/TextContentItem' title: ImageContentItem-Output | TextContentItem type: array title: list[ImageContentItem-Output | TextContentItem] title: string | list[ImageContentItem-Output | TextContentItem] chunk_id: type: string title: Chunk Id metadata: additionalProperties: true type: object title: Metadata chunk_metadata: $ref: '#/components/schemas/ChunkMetadata' embedding: items: type: number type: array title: Embedding embedding_model: type: string title: Embedding Model embedding_dimension: type: integer title: Embedding Dimension type: object required: - content - chunk_id - chunk_metadata - embedding - embedding_model - embedding_dimension title: EmbeddedChunk description: |- A chunk of content with its embedding vector for vector database operations. Inherits all fields from Chunk and adds embedding-related fields. Errors: properties: data: anyOf: - items: $ref: '#/components/schemas/BatchError' type: array - type: 'null' object: anyOf: - type: string - type: 'null' additionalProperties: true type: object title: Errors EvaluateRowsBodyRequest: properties: input_rows: items: additionalProperties: true type: object type: array minItems: 1 title: Input Rows description: The rows to evaluate scoring_functions: items: type: string type: array minItems: 1 title: Scoring Functions description: The scoring functions to use for the evaluation benchmark_config: $ref: '#/components/schemas/BenchmarkConfig' description: The configuration for the benchmark type: object required: - input_rows - scoring_functions - benchmark_config title: EvaluateRowsBodyRequest description: Request body model for evaluating rows (without path parameter). HealthStatus: type: string enum: - OK - Error - Not Implemented title: HealthStatus ImageContentItem-Input: properties: type: type: string const: image title: Type default: image image: $ref: '#/components/schemas/_URLOrData' type: object required: - image title: ImageContentItem description: A image content item ImageContentItem-Output: properties: type: type: string const: image title: Type default: image image: $ref: '#/components/schemas/_URLOrData' type: object required: - image title: ImageContentItem description: A image content item InputTokensDetails: properties: cached_tokens: type: integer title: Cached Tokens additionalProperties: true type: object required: - cached_tokens title: InputTokensDetails JobStatus: type: string enum: - completed - in_progress - failed - scheduled - cancelled title: JobStatus description: Status of a job execution. ListConnectorsResponse: properties: data: items: $ref: '#/components/schemas/Connector' type: array title: Data type: object required: - data title: ListConnectorsResponse description: Response containing a list of configured connectors ListToolsResponse: properties: data: items: $ref: '#/components/schemas/ToolDef' type: array title: Data type: object required: - data title: ListToolsResponse description: Response containing a list of tools MCPListToolsTool: properties: input_schema: additionalProperties: true type: object title: Input Schema name: type: string title: Name description: anyOf: - type: string - type: 'null' type: object required: - input_schema - name title: MCPListToolsTool description: Tool definition returned by MCP list tools operation. OpenAIAssistantMessageParam-Input: properties: role: type: string const: assistant title: Role description: Must be 'assistant' to identify this as the model's response. default: assistant content: anyOf: - type: string - items: $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' type: array title: list[OpenAIChatCompletionContentPartTextParam] - type: 'null' title: string | list[OpenAIChatCompletionContentPartTextParam] description: The content of the model's response. name: anyOf: - type: string - type: 'null' description: The name of the assistant message participant. tool_calls: anyOf: - items: $ref: '#/components/schemas/OpenAIChatCompletionToolCall' type: array - type: 'null' description: List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object. type: object title: OpenAIAssistantMessageParam description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. OpenAIAssistantMessageParam-Output: properties: role: type: string const: assistant title: Role description: Must be 'assistant' to identify this as the model's response. default: assistant content: anyOf: - type: string - items: $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' type: array title: list[OpenAIChatCompletionContentPartTextParam] - type: 'null' title: string | list[OpenAIChatCompletionContentPartTextParam] description: The content of the model's response. name: anyOf: - type: string - type: 'null' description: The name of the assistant message participant. tool_calls: anyOf: - items: $ref: '#/components/schemas/OpenAIChatCompletionToolCall' type: array - type: 'null' description: List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object. type: object title: OpenAIAssistantMessageParam description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. OpenAIAttachFileRequest: properties: file_id: type: string title: File Id description: The ID of the file to attach. attributes: anyOf: - additionalProperties: true type: object - type: 'null' description: Attributes to associate with the file. chunking_strategy: anyOf: - oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic discriminator: propertyName: type mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic - type: 'null' title: Chunking Strategy description: Strategy for chunking the file content. type: object required: - file_id title: OpenAIAttachFileRequest description: Request body for attaching a file to a vector store. OpenAIChatCompletionUsageCompletionTokensDetails: properties: reasoning_tokens: anyOf: - type: integer minimum: 0.0 - type: 'null' description: Number of tokens used for reasoning (o1/o3 models). type: object title: OpenAIChatCompletionUsageCompletionTokensDetails description: Token details for output tokens in OpenAI chat completion usage. OpenAIChatCompletionUsagePromptTokensDetails: properties: cached_tokens: anyOf: - type: integer minimum: 0.0 - type: 'null' description: Number of tokens retrieved from cache. type: object title: OpenAIChatCompletionUsagePromptTokensDetails description: Token details for prompt tokens in OpenAI chat completion usage. OpenAIResponseInputToolChoiceAllowedTools: properties: mode: type: string enum: - auto - required title: Mode default: auto tools: items: additionalProperties: type: string type: object type: array title: Tools type: type: string const: allowed_tools title: Type default: allowed_tools type: object required: - tools title: OpenAIResponseInputToolChoiceAllowedTools description: Constrains the tools available to the model to a pre-defined set. OpenAIResponseInputToolChoiceCustomTool: properties: type: type: string const: custom title: Type default: custom name: type: string title: Name type: object required: - name title: OpenAIResponseInputToolChoiceCustomTool description: Forces the model to call a custom tool. OpenAIResponseInputToolChoiceFileSearch: properties: type: type: string const: file_search title: Type default: file_search type: object title: OpenAIResponseInputToolChoiceFileSearch description: Indicates that the model should use file search to generate a response. OpenAIResponseInputToolChoiceFunctionTool: properties: name: type: string title: Name type: type: string const: function title: Type default: function type: object required: - name title: OpenAIResponseInputToolChoiceFunctionTool description: Forces the model to call a specific function. OpenAIResponseInputToolChoiceMCPTool: properties: server_label: type: string title: Server Label type: type: string const: mcp title: Type default: mcp name: anyOf: - type: string - type: 'null' type: object required: - server_label title: OpenAIResponseInputToolChoiceMCPTool description: Forces the model to call a specific tool on a remote MCP server OpenAIResponseInputToolChoiceMode: type: string enum: - auto - required - none title: OpenAIResponseInputToolChoiceMode OpenAIResponseInputToolChoiceWebSearch: properties: type: title: Type default: web_search type: string enum: - web_search - web_search_preview - web_search_preview_2025_03_11 - web_search_2025_08_26 type: object title: OpenAIResponseInputToolChoiceWebSearch description: Indicates that the model should use web search to generate a response OpenAIResponseMessage-Input: properties: content: anyOf: - type: string - items: oneOf: - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' title: OpenAIResponseInputMessageContentText - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' title: OpenAIResponseInputMessageContentImage - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile discriminator: propertyName: type mapping: input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile type: array title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] - items: oneOf: - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Input' title: OpenAIResponseOutputMessageContentOutputText-Input - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal discriminator: propertyName: type mapping: output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Input' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal type: array title: list[OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal] title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText-Input | OpenAIResponseContentPartRefusal] role: title: Role type: string enum: - system - developer - user - assistant default: system type: type: string const: message title: Type default: message id: anyOf: - type: string - type: 'null' status: anyOf: - type: string - type: 'null' type: object required: - content - role title: OpenAIResponseMessage description: |- Corresponds to the various Message types in the Responses API. They are all under one type because the Responses API gives them all the same "type" value, and there is no way to tell them apart in certain scenarios. OpenAIResponseMessage-Output: properties: content: anyOf: - type: string - items: oneOf: - $ref: '#/components/schemas/OpenAIResponseInputMessageContentText' title: OpenAIResponseInputMessageContentText - $ref: '#/components/schemas/OpenAIResponseInputMessageContentImage' title: OpenAIResponseInputMessageContentImage - $ref: '#/components/schemas/OpenAIResponseInputMessageContentFile' title: OpenAIResponseInputMessageContentFile discriminator: propertyName: type mapping: input_file: '#/components/schemas/OpenAIResponseInputMessageContentFile' input_image: '#/components/schemas/OpenAIResponseInputMessageContentImage' input_text: '#/components/schemas/OpenAIResponseInputMessageContentText' title: OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile type: array title: list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] - items: oneOf: - $ref: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Output' title: OpenAIResponseOutputMessageContentOutputText-Output - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal discriminator: propertyName: type mapping: output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText-Output' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal type: array title: list[OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal] title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText-Output | OpenAIResponseContentPartRefusal] role: title: Role type: string enum: - system - developer - user - assistant default: system type: type: string const: message title: Type default: message id: anyOf: - type: string - type: 'null' status: anyOf: - type: string - type: 'null' type: object required: - content - role title: OpenAIResponseMessage description: |- Corresponds to the various Message types in the Responses API. They are all under one type because the Responses API gives them all the same "type" value, and there is no way to tell them apart in certain scenarios. OpenAIResponseOutputMessageContentOutputText-Input: properties: text: type: string title: Text type: type: string const: output_text title: Type default: output_text annotations: items: oneOf: - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' title: OpenAIResponseAnnotationFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' title: OpenAIResponseAnnotationContainerFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath discriminator: propertyName: type mapping: container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationFileCitation | ... (4 variants) type: array title: Annotations logprobs: anyOf: - items: $ref: '#/components/schemas/OpenAITokenLogProb' type: array - type: 'null' type: object required: - text title: OpenAIResponseOutputMessageContentOutputText OpenAIResponseOutputMessageContentOutputText-Output: properties: text: type: string title: Text type: type: string const: output_text title: Type default: output_text annotations: items: oneOf: - $ref: '#/components/schemas/OpenAIResponseAnnotationFileCitation' title: OpenAIResponseAnnotationFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' title: OpenAIResponseAnnotationContainerFileCitation - $ref: '#/components/schemas/OpenAIResponseAnnotationFilePath' title: OpenAIResponseAnnotationFilePath discriminator: propertyName: type mapping: container_file_citation: '#/components/schemas/OpenAIResponseAnnotationContainerFileCitation' file_citation: '#/components/schemas/OpenAIResponseAnnotationFileCitation' file_path: '#/components/schemas/OpenAIResponseAnnotationFilePath' url_citation: '#/components/schemas/OpenAIResponseAnnotationCitation' title: OpenAIResponseAnnotationFileCitation | ... (4 variants) type: array title: Annotations logprobs: anyOf: - items: $ref: '#/components/schemas/OpenAITokenLogProb' type: array - type: 'null' type: object required: - text title: OpenAIResponseOutputMessageContentOutputText OpenAIResponseOutputMessageFileSearchToolCallResults: properties: attributes: additionalProperties: true type: object title: Attributes file_id: type: string title: File Id filename: type: string title: Filename score: type: number title: Score text: type: string title: Text type: object required: - attributes - file_id - filename - score - text title: OpenAIResponseOutputMessageFileSearchToolCallResults description: Search results returned by the file search operation. OpenAIResponseReasoning: properties: effort: anyOf: - type: string enum: - none - minimal - low - medium - high - xhigh - type: 'null' type: object title: OpenAIResponseReasoning description: |- Configuration for reasoning effort in OpenAI responses. Controls how much reasoning the model performs before generating a response. OpenAIResponseTextFormat: properties: type: title: Type type: string enum: - text - json_schema - json_object default: text name: anyOf: - type: string - type: 'null' schema: anyOf: - additionalProperties: true type: object - type: 'null' description: anyOf: - type: string - type: 'null' strict: anyOf: - type: boolean - type: 'null' type: object title: OpenAIResponseTextFormat description: Configuration for Responses API text format. OpenAIResponseUsageInputTokensDetails: properties: cached_tokens: type: integer title: Cached Tokens type: object required: - cached_tokens title: OpenAIResponseUsageInputTokensDetails description: Token details for input tokens in OpenAI response usage. OpenAIResponseUsageOutputTokensDetails: properties: reasoning_tokens: type: integer title: Reasoning Tokens type: object required: - reasoning_tokens title: OpenAIResponseUsageOutputTokensDetails description: Token details for output tokens in OpenAI response usage. OpenAISearchVectorStoreRequest: properties: query: anyOf: - type: string - items: type: string type: array title: list[string] title: string | list[string] description: The search query string or list of query strings. filters: anyOf: - additionalProperties: true type: object - type: 'null' description: Filters to apply to the search. max_num_results: anyOf: - type: integer - type: 'null' description: Maximum number of results to return. default: 10 ranking_options: anyOf: - $ref: '#/components/schemas/SearchRankingOptions' title: SearchRankingOptions - type: 'null' description: Options for ranking results. title: SearchRankingOptions rewrite_query: anyOf: - type: boolean - type: 'null' description: Whether to rewrite the query for better results. default: false search_mode: anyOf: - type: string - type: 'null' description: The search mode to use (e.g., 'vector', 'keyword'). default: vector type: object required: - query title: OpenAISearchVectorStoreRequest description: Request body for searching a vector store. OpenAIUpdateVectorStoreFileRequest: properties: attributes: additionalProperties: true type: object title: Attributes description: The new attributes for the file. type: object required: - attributes title: OpenAIUpdateVectorStoreFileRequest description: Request body for updating a vector store file. OpenAIUpdateVectorStoreRequest: properties: name: anyOf: - type: string - type: 'null' description: The new name for the vector store. expires_after: anyOf: - additionalProperties: true type: object - type: 'null' description: Expiration policy for the vector store. metadata: anyOf: - additionalProperties: true type: object - type: 'null' description: Metadata to associate with the vector store. type: object title: OpenAIUpdateVectorStoreRequest description: Request body for updating a vector store. OpenAIUserMessageParam-Input: properties: role: type: string const: user title: Role description: Must be 'user' to identify this as a user message. default: user content: anyOf: - type: string - items: oneOf: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' title: OpenAIChatCompletionContentPartTextParam - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' title: OpenAIChatCompletionContentPartImageParam - $ref: '#/components/schemas/OpenAIFile' title: OpenAIFile discriminator: propertyName: type mapping: file: '#/components/schemas/OpenAIFile' image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile type: array title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] description: The content of the message, which can include text and other media. name: anyOf: - type: string - type: 'null' description: The name of the user message participant. type: object required: - content title: OpenAIUserMessageParam description: A message from the user in an OpenAI-compatible chat completion request. OpenAIUserMessageParam-Output: properties: role: type: string const: user title: Role description: Must be 'user' to identify this as a user message. default: user content: anyOf: - type: string - items: oneOf: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' title: OpenAIChatCompletionContentPartTextParam - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' title: OpenAIChatCompletionContentPartImageParam - $ref: '#/components/schemas/OpenAIFile' title: OpenAIFile discriminator: propertyName: type mapping: file: '#/components/schemas/OpenAIFile' image_url: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' text: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile type: array title: list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] title: string | list[OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam | OpenAIFile] description: The content of the message, which can include text and other media. name: anyOf: - type: string - type: 'null' description: The name of the user message participant. type: object required: - content title: OpenAIUserMessageParam description: A message from the user in an OpenAI-compatible chat completion request. OutputTokensDetails: properties: reasoning_tokens: type: integer title: Reasoning Tokens additionalProperties: true type: object required: - reasoning_tokens title: OutputTokensDetails ResponseItemInclude: type: string enum: - web_search_call.action.sources - code_interpreter_call.outputs - computer_call_output.output.image_url - file_search_call.results - message.input_image.image_url - message.output_text.logprobs - reasoning.encrypted_content title: ResponseItemInclude description: Specify additional output data to include in the model response. RunEvalBodyRequest: properties: benchmark_config: $ref: '#/components/schemas/BenchmarkConfig' description: The configuration for the benchmark type: object required: - benchmark_config title: RunEvalBodyRequest description: Request body model for running an evaluation (without path parameter). SearchRankingOptions: properties: ranker: anyOf: - type: string - type: 'null' score_threshold: anyOf: - type: number - type: 'null' default: 0.0 alpha: anyOf: - type: number maximum: 1.0 minimum: 0.0 - type: 'null' description: Weight factor for weighted ranker impact_factor: anyOf: - type: number minimum: 0.0 - type: 'null' description: Impact factor for RRF algorithm weights: anyOf: - additionalProperties: type: number type: object - type: 'null' description: "Weights for combining vector, keyword, and neural scores. Keys: 'vector', 'keyword', 'neural'" model: anyOf: - type: string - type: 'null' description: Model identifier for neural reranker type: object title: SearchRankingOptions description: |- Options for ranking and filtering search results. This class configures how search results are ranked and filtered. You can use algorithm-based rerankers (weighted, RRF) or neural rerankers. Defaults from VectorStoresConfig are used when parameters are not provided. Examples: # Weighted ranker with custom alpha SearchRankingOptions(ranker="weighted", alpha=0.7) # RRF ranker with custom impact factor SearchRankingOptions(ranker="rrf", impact_factor=50.0) # Use config defaults (just specify ranker type) SearchRankingOptions(ranker="weighted") # Uses alpha from VectorStoresConfig # Score threshold filtering SearchRankingOptions(ranker="weighted", score_threshold=0.5) SetDefaultVersionBodyRequest: properties: version: type: integer title: Version description: The version to set as default. type: object required: - version title: SetDefaultVersionBodyRequest description: Request body model for setting the default version of a prompt. UpdatePromptBodyRequest: properties: prompt: type: string title: Prompt description: The updated prompt text content. version: type: integer title: Version description: The current version of the prompt being updated. variables: anyOf: - items: type: string type: array - type: 'null' description: Updated list of variable names that can be used in the prompt template. set_as_default: type: boolean title: Set As Default description: Set the new version as the default (default=True). default: true type: object required: - prompt - version title: UpdatePromptBodyRequest description: Request body model for updating a prompt. _URLOrData: properties: url: anyOf: - $ref: '#/components/schemas/URL' title: URL - type: 'null' title: URL data: anyOf: - type: string - type: 'null' contentEncoding: base64 type: object title: _URLOrData description: A URL or a base64 encoded string SamplingStrategy: discriminator: mapping: greedy: '#/components/schemas/GreedySamplingStrategy' top_k: '#/components/schemas/TopKSamplingStrategy' top_p: '#/components/schemas/TopPSamplingStrategy' propertyName: type oneOf: - $ref: '#/components/schemas/GreedySamplingStrategy' title: GreedySamplingStrategy - $ref: '#/components/schemas/TopPSamplingStrategy' title: TopPSamplingStrategy - $ref: '#/components/schemas/TopKSamplingStrategy' title: TopKSamplingStrategy title: GreedySamplingStrategy | TopPSamplingStrategy | TopKSamplingStrategy GrammarResponseFormat: description: Configuration for grammar-guided response generation. properties: type: const: grammar default: grammar description: Must be 'grammar' to identify this format type. title: Type type: string bnf: additionalProperties: true description: The BNF grammar specification the response should conform to. title: Bnf type: object required: - bnf title: GrammarResponseFormat type: object JsonSchemaResponseFormat: description: Configuration for JSON schema-guided response generation. properties: type: const: json_schema default: json_schema description: Must be 'json_schema' to identify this format type. title: Type type: string json_schema: additionalProperties: true description: The JSON schema the response should conform to. title: Json Schema type: object required: - json_schema title: JsonSchemaResponseFormat type: object ResponseFormat: discriminator: mapping: grammar: '#/components/schemas/GrammarResponseFormat' json_schema: '#/components/schemas/JsonSchemaResponseFormat' propertyName: type oneOf: - $ref: '#/components/schemas/JsonSchemaResponseFormat' title: JsonSchemaResponseFormat - $ref: '#/components/schemas/GrammarResponseFormat' title: GrammarResponseFormat title: JsonSchemaResponseFormat | GrammarResponseFormat AllowedToolsConfig: properties: tools: description: List of allowed tools. items: additionalProperties: true type: object title: Tools type: array mode: description: Mode for allowed tools. enum: - auto - required title: Mode type: string required: - tools - mode title: AllowedToolsConfig type: object CustomToolConfig: description: Custom tool configuration for OpenAI-compatible chat completion requests. properties: name: description: Name of the custom tool. title: Name type: string required: - name title: CustomToolConfig type: object FunctionToolConfig: properties: name: description: Name of the function. title: Name type: string required: - name title: FunctionToolConfig type: object OpenAIChatCompletionToolChoiceAllowedTools: description: Allowed tools response format for OpenAI-compatible chat completion requests. properties: type: const: allowed_tools default: allowed_tools description: Must be 'allowed_tools' to indicate allowed tools response format. title: Type type: string allowed_tools: $ref: '#/components/schemas/AllowedToolsConfig' description: Allowed tools configuration. required: - allowed_tools title: OpenAIChatCompletionToolChoiceAllowedTools type: object OpenAIChatCompletionToolChoiceCustomTool: description: Custom tool choice for OpenAI-compatible chat completion requests. properties: type: const: custom default: custom description: Must be 'custom' to indicate custom tool choice. title: Type type: string custom: $ref: '#/components/schemas/CustomToolConfig' description: Custom tool configuration. required: - custom title: OpenAIChatCompletionToolChoiceCustomTool type: object OpenAIChatCompletionToolChoiceFunctionTool: description: Function tool choice for OpenAI-compatible chat completion requests. properties: type: const: function default: function description: Must be 'function' to indicate function tool choice. title: Type type: string function: $ref: '#/components/schemas/FunctionToolConfig' description: The function tool configuration. required: - function title: OpenAIChatCompletionToolChoiceFunctionTool type: object OpenAIChatCompletionToolChoice: discriminator: mapping: allowed_tools: '#/components/schemas/OpenAIChatCompletionToolChoiceAllowedTools' custom: '#/components/schemas/OpenAIChatCompletionToolChoiceCustomTool' function: '#/components/schemas/OpenAIChatCompletionToolChoiceFunctionTool' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIChatCompletionToolChoiceAllowedTools' title: OpenAIChatCompletionToolChoiceAllowedTools - $ref: '#/components/schemas/OpenAIChatCompletionToolChoiceFunctionTool' title: OpenAIChatCompletionToolChoiceFunctionTool - $ref: '#/components/schemas/OpenAIChatCompletionToolChoiceCustomTool' title: OpenAIChatCompletionToolChoiceCustomTool title: OpenAIChatCompletionToolChoiceAllowedTools | OpenAIChatCompletionToolChoiceFunctionTool | OpenAIChatCompletionToolChoiceCustomTool OpenAIFinishReason: enum: - stop - length - tool_calls - content_filter - function_call type: string OpenAIResponseInputToolChoice: anyOf: - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceMode' title: OpenAIResponseInputToolChoiceMode - discriminator: mapping: allowed_tools: '#/components/schemas/OpenAIResponseInputToolChoiceAllowedTools' custom: '#/components/schemas/OpenAIResponseInputToolChoiceCustomTool' file_search: '#/components/schemas/OpenAIResponseInputToolChoiceFileSearch' function: '#/components/schemas/OpenAIResponseInputToolChoiceFunctionTool' mcp: '#/components/schemas/OpenAIResponseInputToolChoiceMCPTool' web_search: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' web_search_2025_08_26: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' web_search_preview: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' web_search_preview_2025_03_11: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceAllowedTools' title: OpenAIResponseInputToolChoiceAllowedTools - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceFileSearch' title: OpenAIResponseInputToolChoiceFileSearch - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceWebSearch' title: OpenAIResponseInputToolChoiceWebSearch - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceFunctionTool' title: OpenAIResponseInputToolChoiceFunctionTool - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceMCPTool' title: OpenAIResponseInputToolChoiceMCPTool - $ref: '#/components/schemas/OpenAIResponseInputToolChoiceCustomTool' title: OpenAIResponseInputToolChoiceCustomTool title: OpenAIResponseInputToolChoiceAllowedTools | ... (6 variants) title: OpenAIResponseInputToolChoiceMode OpenAIResponseContentPart: discriminator: mapping: output_text: '#/components/schemas/OpenAIResponseContentPartOutputText' reasoning_text: '#/components/schemas/OpenAIResponseContentPartReasoningText' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseContentPartOutputText' title: OpenAIResponseContentPartOutputText - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal - $ref: '#/components/schemas/OpenAIResponseContentPartReasoningText' title: OpenAIResponseContentPartReasoningText title: OpenAIResponseContentPartOutputText | OpenAIResponseContentPartRefusal | OpenAIResponseContentPartReasoningText ListBenchmarksRequest: description: Request model for listing benchmarks. properties: {} title: ListBenchmarksRequest type: object GetBenchmarkRequest: description: Request model for getting a benchmark. properties: benchmark_id: description: The ID of the benchmark to get. title: Benchmark Id type: string required: - benchmark_id title: GetBenchmarkRequest type: object UnregisterBenchmarkRequest: description: Request model for unregistering a benchmark. properties: benchmark_id: description: The ID of the benchmark to unregister. title: Benchmark Id type: string required: - benchmark_id title: UnregisterBenchmarkRequest type: object GetDatasetRequest: description: Request model for getting a dataset by ID. properties: dataset_id: description: The ID of the dataset to get. title: Dataset Id type: string required: - dataset_id title: GetDatasetRequest type: object UnregisterDatasetRequest: description: Request model for unregistering a dataset. properties: dataset_id: description: The ID of the dataset to unregister. title: Dataset Id type: string required: - dataset_id title: UnregisterDatasetRequest type: object ListModelsResponse: description: Response containing a list of model objects. properties: data: description: List of model objects. items: $ref: '#/components/schemas/Model' title: Data type: array required: - data title: ListModelsResponse type: object GetModelRequest: description: Request model for getting a model by ID. properties: model_id: description: The ID of the model to get. title: Model Id type: string required: - model_id title: GetModelRequest type: object UnregisterModelRequest: description: Request model for unregistering a model. properties: model_id: description: The ID of the model to unregister. title: Model Id type: string required: - model_id title: UnregisterModelRequest type: object DialogType: description: Parameter type for dialog data with semantic output labels. properties: type: const: dialog default: dialog title: Type type: string title: DialogType type: object ListScoringFunctionsRequest: description: Request model for listing scoring functions. properties: {} title: ListScoringFunctionsRequest type: object GetScoringFunctionRequest: description: Request model for getting a scoring function. properties: scoring_fn_id: description: The ID of the scoring function to get. title: Scoring Fn Id type: string required: - scoring_fn_id title: GetScoringFunctionRequest type: object UnregisterScoringFunctionRequest: description: Request model for unregistering a scoring function. properties: scoring_fn_id: description: The ID of the scoring function to unregister. title: Scoring Fn Id type: string required: - scoring_fn_id title: UnregisterScoringFunctionRequest type: object GetShieldRequest: description: Request model for getting a shield by identifier. properties: identifier: description: The identifier of the shield to get. title: Identifier type: string required: - identifier title: GetShieldRequest type: object UnregisterShieldRequest: description: Request model for unregistering a shield. properties: identifier: description: The identifier of the shield to unregister. title: Identifier type: string required: - identifier title: UnregisterShieldRequest type: object TextDelta: description: A text content delta for streaming responses. properties: type: const: text default: text title: Type type: string text: title: Text type: string required: - text title: TextDelta type: object ImageDelta: description: An image content delta for streaming responses. properties: type: const: image default: image title: Type type: string image: format: binary title: Image type: string required: - image title: ImageDelta type: object ToolGroupInput: description: Input data for registering a tool group. properties: toolgroup_id: title: Toolgroup Id type: string provider_id: title: Provider Id type: string args: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true mcp_endpoint: anyOf: - $ref: '#/components/schemas/URL' title: URL - type: 'null' nullable: true title: URL required: - toolgroup_id - provider_id title: ToolGroupInput type: object Api: description: Enumeration of all available APIs in the Llama Stack system. enum: - providers - inference - safety - agents - batches - vector_io - datasetio - scoring - eval - post_training - tool_runtime - models - shields - vector_stores - datasets - scoring_functions - benchmarks - tool_groups - files - file_processors - prompts - conversations - connectors - inspect - admin title: Api type: string ProviderSpec: properties: api: $ref: '#/components/schemas/Api' provider_type: title: Provider Type type: string config_class: description: Fully-qualified classname of the config for this provider title: Config Class type: string api_dependencies: description: Higher-level API surfaces may depend on other providers to provide their functionality items: $ref: '#/components/schemas/Api' title: Api Dependencies type: array optional_api_dependencies: items: $ref: '#/components/schemas/Api' title: Optional Api Dependencies type: array deprecation_warning: anyOf: - type: string - type: 'null' description: If this provider is deprecated, specify the warning message here nullable: true deprecation_error: anyOf: - type: string - type: 'null' description: If this provider is deprecated and does NOT work, specify the error message here nullable: true module: anyOf: - type: string - type: 'null' description: |2- Fully-qualified name of the module to import. The module is expected to have: - `get_adapter_impl(config, deps)`: returns the adapter implementation Example: `module: ramalama_stack` nullable: true pip_packages: description: The pip dependencies needed for this implementation items: type: string title: Pip Packages type: array provider_data_validator: anyOf: - type: string - type: 'null' nullable: true is_external: default: false description: Notes whether this provider is an external provider. title: Is External type: boolean deps__: items: type: string title: Deps type: array required: - api - provider_type - config_class title: ProviderSpec type: object InlineProviderSpec: properties: api: $ref: '#/components/schemas/Api' provider_type: title: Provider Type type: string config_class: description: Fully-qualified classname of the config for this provider title: Config Class type: string api_dependencies: description: Higher-level API surfaces may depend on other providers to provide their functionality items: $ref: '#/components/schemas/Api' title: Api Dependencies type: array optional_api_dependencies: items: $ref: '#/components/schemas/Api' title: Optional Api Dependencies type: array deprecation_warning: anyOf: - type: string - type: 'null' description: If this provider is deprecated, specify the warning message here nullable: true deprecation_error: anyOf: - type: string - type: 'null' description: If this provider is deprecated and does NOT work, specify the error message here nullable: true module: anyOf: - type: string - type: 'null' description: |2- Fully-qualified name of the module to import. The module is expected to have: - `get_adapter_impl(config, deps)`: returns the adapter implementation Example: `module: ramalama_stack` nullable: true pip_packages: description: The pip dependencies needed for this implementation items: type: string title: Pip Packages type: array provider_data_validator: anyOf: - type: string - type: 'null' nullable: true is_external: default: false description: Notes whether this provider is an external provider. title: Is External type: boolean deps__: items: type: string title: Deps type: array container_image: anyOf: - type: string - type: 'null' description: |2 The container image to use for this implementation. If one is provided, pip_packages will be ignored. If a provider depends on other providers, the dependencies MUST NOT specify a container image. nullable: true description: anyOf: - type: string - type: 'null' description: |2 A description of the provider. This is used to display in the documentation. nullable: true required: - api - provider_type - config_class title: InlineProviderSpec type: object RemoteProviderSpec: properties: api: $ref: '#/components/schemas/Api' provider_type: title: Provider Type type: string config_class: description: Fully-qualified classname of the config for this provider title: Config Class type: string api_dependencies: description: Higher-level API surfaces may depend on other providers to provide their functionality items: $ref: '#/components/schemas/Api' title: Api Dependencies type: array optional_api_dependencies: items: $ref: '#/components/schemas/Api' title: Optional Api Dependencies type: array deprecation_warning: anyOf: - type: string - type: 'null' description: If this provider is deprecated, specify the warning message here nullable: true deprecation_error: anyOf: - type: string - type: 'null' description: If this provider is deprecated and does NOT work, specify the error message here nullable: true module: anyOf: - type: string - type: 'null' description: |2- Fully-qualified name of the module to import. The module is expected to have: - `get_adapter_impl(config, deps)`: returns the adapter implementation Example: `module: ramalama_stack` nullable: true pip_packages: description: The pip dependencies needed for this implementation items: type: string title: Pip Packages type: array provider_data_validator: anyOf: - type: string - type: 'null' nullable: true is_external: default: false description: Notes whether this provider is an external provider. title: Is External type: boolean deps__: items: type: string title: Deps type: array adapter_type: description: Unique identifier for this adapter title: Adapter Type type: string description: anyOf: - type: string - type: 'null' description: |2 A description of the provider. This is used to display in the documentation. nullable: true required: - api - provider_type - config_class - adapter_type title: RemoteProviderSpec type: object ListRoutesRequest: description: Request to list API routes. properties: api_filter: anyOf: - enum: - v1 - v1alpha - v1beta - deprecated type: string - type: 'null' description: Filter to control which routes are returned. Can be an API level ('v1', 'v1alpha', 'v1beta') to show non-deprecated routes at that level, or 'deprecated' to show deprecated routes across all levels. If not specified, returns all non-deprecated routes. nullable: true title: ListRoutesRequest type: object InspectProviderRequest: description: Request to inspect a specific provider. properties: provider_id: description: The ID of the provider to inspect. title: Provider Id type: string required: - provider_id title: InspectProviderRequest type: object MetricInResponse: description: A metric value included in API responses. properties: metric: title: Metric type: string value: anyOf: - type: integer - type: number title: integer | number unit: anyOf: - type: string - type: 'null' nullable: true required: - metric - value title: MetricInResponse type: object Fp8QuantizationConfig: description: Configuration for 8-bit floating point quantization. properties: type: const: fp8_mixed default: fp8_mixed description: Must be 'fp8_mixed' to identify this quantization type. title: Type type: string title: Fp8QuantizationConfig type: object Bf16QuantizationConfig: description: Configuration for BFloat16 precision (typically no quantization). properties: type: const: bf16 default: bf16 description: Must be 'bf16' to identify this quantization type. title: Type type: string title: Bf16QuantizationConfig type: object Int4QuantizationConfig: description: Configuration for 4-bit integer quantization. properties: type: const: int4_mixed default: int4_mixed description: Must be 'int4' to identify this quantization type. title: Type type: string scheme: anyOf: - type: string - type: 'null' default: int4_weight_int8_dynamic_activation description: Quantization scheme to use. title: Int4QuantizationConfig type: object UserMessage: description: A message from the user in a chat conversation. properties: role: const: user default: user description: Must be 'user' to identify this as a user message. title: Role type: string content: anyOf: - type: string - discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem - items: discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem type: array title: list[ImageContentItem | TextContentItem] description: The content of the message, which can include text and other media. title: string | list[ImageContentItem | TextContentItem] context: anyOf: - type: string - discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem - items: discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem type: array title: list[ImageContentItem | TextContentItem] - type: 'null' description: This field is used internally by Llama Stack to pass RAG context. This field may be removed in the API in the future. title: string | list[ImageContentItem | TextContentItem] nullable: true required: - content title: UserMessage type: object ToolResponseMessage: description: A message representing the result of a tool invocation. properties: role: const: tool default: tool description: Must be 'tool' to identify this as a tool response. title: Role type: string call_id: description: Unique identifier for the tool call this response is for. title: Call Id type: string content: anyOf: - type: string - discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem - items: discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem type: array title: list[ImageContentItem | TextContentItem] description: The response content from the tool. title: string | list[ImageContentItem | TextContentItem] required: - call_id - content title: ToolResponseMessage type: object TokenLogProbs: description: Log probabilities for generated tokens. properties: logprobs_by_token: additionalProperties: type: number description: Dictionary mapping tokens to their log probabilities. title: Logprobs By Token type: object required: - logprobs_by_token title: TokenLogProbs type: object EmbeddingsResponse: description: Response containing generated embeddings. properties: embeddings: description: List of embedding vectors, one per input content. Each embedding is a list of floats. The dimensionality is model-specific. items: items: type: number type: array title: Embeddings type: array required: - embeddings title: EmbeddingsResponse type: object OpenAICompletionLogprobs: description: The log probabilities for the tokens from an OpenAI-compatible completion response. properties: text_offset: anyOf: - items: type: integer type: array - type: 'null' description: The offset of the token in the text. nullable: true token_logprobs: anyOf: - items: type: number type: array - type: 'null' description: The log probabilities for the tokens. nullable: true tokens: anyOf: - items: type: string type: array - type: 'null' description: The tokens. nullable: true top_logprobs: anyOf: - items: additionalProperties: type: number type: object type: array - type: 'null' description: The top log probabilities for the tokens. nullable: true title: OpenAICompletionLogprobs type: object ListChatCompletionsRequest: description: Request model for listing chat completions. properties: after: anyOf: - type: string - type: 'null' description: The ID of the last chat completion to return. nullable: true limit: anyOf: - minimum: 1 type: integer - type: 'null' default: 20 description: The maximum number of chat completions to return. model: anyOf: - type: string - type: 'null' description: The model to filter by. nullable: true order: anyOf: - $ref: '#/components/schemas/Order' title: Order - type: 'null' default: desc description: 'The order to sort the chat completions by: "asc" or "desc". Defaults to "desc".' title: Order title: ListChatCompletionsRequest type: object GetChatCompletionRequest: description: Request model for getting a chat completion. properties: completion_id: description: ID of the chat completion. title: Completion Id type: string required: - completion_id title: GetChatCompletionRequest type: object EmbeddedChunk: description: |- A chunk of content with its embedding vector for vector database operations. Inherits all fields from Chunk and adds embedding-related fields. properties: content: anyOf: - type: string - discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem - items: discriminator: mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' propertyName: type oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem title: ImageContentItem | TextContentItem type: array title: list[ImageContentItem | TextContentItem] title: string | list[ImageContentItem | TextContentItem] chunk_id: title: Chunk Id type: string metadata: additionalProperties: true title: Metadata type: object chunk_metadata: $ref: '#/components/schemas/ChunkMetadata' embedding: items: type: number title: Embedding type: array embedding_model: title: Embedding Model type: string embedding_dimension: title: Embedding Dimension type: integer required: - content - chunk_id - chunk_metadata - embedding - embedding_model - embedding_dimension title: EmbeddedChunk type: object VectorStoreCreateRequest: description: Request to create a vector store. properties: name: anyOf: - type: string - type: 'null' nullable: true file_ids: items: type: string title: File Ids type: array expires_after: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true chunking_strategy: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true metadata: additionalProperties: true title: Metadata type: object title: VectorStoreCreateRequest type: object VectorStoreModifyRequest: description: Request to modify a vector store. properties: name: anyOf: - type: string - type: 'null' nullable: true expires_after: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true metadata: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true title: VectorStoreModifyRequest type: object VectorStoreSearchRequest: description: Request to search a vector store. properties: query: anyOf: - type: string - items: type: string type: array title: list[string] title: string | list[string] filters: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true max_num_results: default: 10 title: Max Num Results type: integer ranking_options: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true rewrite_query: default: false title: Rewrite Query type: boolean required: - query title: VectorStoreSearchRequest type: object ListBatchesRequest: description: Request model for listing batches. properties: after: anyOf: - type: string - type: 'null' description: Optional cursor for pagination. Returns batches after this ID. nullable: true limit: default: 20 description: Maximum number of batches to return. Defaults to 20. title: Limit type: integer title: ListBatchesRequest type: object RetrieveBatchRequest: description: Request model for retrieving a batch. properties: batch_id: description: The ID of the batch to retrieve. title: Batch Id type: string required: - batch_id title: RetrieveBatchRequest type: object CancelBatchRequest: description: Request model for canceling a batch. properties: batch_id: description: The ID of the batch to cancel. title: Batch Id type: string required: - batch_id title: CancelBatchRequest type: object ConnectorInput: description: Input for creating a connector properties: connector_type: $ref: '#/components/schemas/ConnectorType' default: mcp connector_id: description: Identifier for the connector title: Connector Id type: string url: description: URL of the connector title: Url type: string server_label: anyOf: - type: string - type: 'null' description: Label of the server nullable: true required: - connector_id - url title: ConnectorInput type: object GetConnectorRequest: description: Request model for getting a connector by ID. properties: connector_id: description: Identifier for the connector title: Connector Id type: string required: - connector_id title: GetConnectorRequest type: object ListConnectorToolsRequest: description: Request model for listing tools from a connector. properties: connector_id: description: Identifier for the connector title: Connector Id type: string required: - connector_id title: ListConnectorToolsRequest type: object GetConnectorToolRequest: description: Request model for getting a tool from a connector. properties: connector_id: description: Identifier for the connector title: Connector Id type: string tool_name: description: Name of the tool title: Tool Name type: string required: - connector_id - tool_name title: GetConnectorToolRequest type: object ConversationMessage: description: OpenAI-compatible message item for conversations. properties: id: description: unique identifier for this message title: Id type: string content: description: message content items: additionalProperties: true type: object title: Content type: array role: description: message role title: Role type: string status: description: message status title: Status type: string type: const: message default: message title: Type type: string object: const: message default: message title: Object type: string required: - id - content - role - status title: ConversationMessage type: object ConversationItemCreateRequest: description: Request body for creating conversation items. properties: items: description: Items to include in the conversation context. You may add up to 20 items at a time. items: discriminator: mapping: file_search_call: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' function_call: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' function_call_output: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' mcp_approval_request: '#/components/schemas/OpenAIResponseMCPApprovalRequest' mcp_approval_response: '#/components/schemas/OpenAIResponseMCPApprovalResponse' mcp_call: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' message: '#/components/schemas/OpenAIResponseMessage' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' propertyName: type oneOf: - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage - $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseOutputMessageWebSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall' title: OpenAIResponseOutputMessageFileSearchToolCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall' title: OpenAIResponseOutputMessageFunctionToolCall - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalRequest' title: OpenAIResponseMCPApprovalRequest - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPCall' title: OpenAIResponseOutputMessageMCPCall - $ref: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools' title: OpenAIResponseOutputMessageMCPListTools title: OpenAIResponseMessage | ... (9 variants) maxItems: 20 title: Items type: array required: - items title: ConversationItemCreateRequest type: object GetConversationRequest: description: Request model for getting a conversation by ID. properties: conversation_id: description: The conversation identifier. title: Conversation Id type: string required: - conversation_id title: GetConversationRequest type: object DeleteConversationRequest: description: Request model for deleting a conversation. properties: conversation_id: description: The conversation identifier. title: Conversation Id type: string required: - conversation_id title: DeleteConversationRequest type: object RetrieveItemRequest: description: Request model for retrieving a conversation item. properties: conversation_id: description: The conversation identifier. title: Conversation Id type: string item_id: description: The item identifier. title: Item Id type: string required: - conversation_id - item_id title: RetrieveItemRequest type: object ListItemsRequest: description: Request model for listing items in a conversation. properties: conversation_id: description: The conversation identifier. title: Conversation Id type: string after: anyOf: - type: string - type: 'null' description: An item ID to list items after, used in pagination. nullable: true include: anyOf: - items: $ref: '#/components/schemas/ConversationItemInclude' type: array - type: 'null' description: Specify additional output data to include in the response. nullable: true limit: anyOf: - type: integer - type: 'null' description: A limit on the number of objects to be returned (1-100, default 20). nullable: true order: anyOf: - enum: - asc - desc type: string - type: 'null' description: The order to return items in (asc or desc, default desc). nullable: true required: - conversation_id title: ListItemsRequest type: object DeleteItemRequest: description: Request model for deleting a conversation item. properties: conversation_id: description: The conversation identifier. title: Conversation Id type: string item_id: description: The item identifier. title: Item Id type: string required: - conversation_id - item_id title: DeleteItemRequest type: object IterRowsRequest: description: Request model for iterating over rows in a dataset. properties: dataset_id: description: The ID of the dataset to get the rows from. title: Dataset Id type: string start_index: anyOf: - type: integer - type: 'null' description: Index into dataset for the first row to get. Get all rows if None. nullable: true limit: anyOf: - type: integer - type: 'null' description: The number of rows to get. nullable: true required: - dataset_id title: IterRowsRequest type: object BenchmarkIdRequest: description: Request model containing benchmark_id path parameter. properties: benchmark_id: description: The ID of the benchmark minLength: 1 title: Benchmark Id type: string required: - benchmark_id title: BenchmarkIdRequest type: object JobStatusRequest: description: Request model for getting the status of a job. properties: benchmark_id: description: The ID of the benchmark associated with the job minLength: 1 title: Benchmark Id type: string job_id: description: The ID of the job to get the status of minLength: 1 title: Job Id type: string required: - benchmark_id - job_id title: JobStatusRequest type: object JobCancelRequest: description: Request model for canceling a job. properties: benchmark_id: description: The ID of the benchmark associated with the job minLength: 1 title: Benchmark Id type: string job_id: description: The ID of the job to cancel minLength: 1 title: Job Id type: string required: - benchmark_id - job_id title: JobCancelRequest type: object JobResultRequest: description: Request model for getting the result of a job. properties: benchmark_id: description: The ID of the benchmark associated with the job minLength: 1 title: Benchmark Id type: string job_id: description: The ID of the job to get the result of minLength: 1 title: Job Id type: string required: - benchmark_id - job_id title: JobResultRequest type: object ProcessFileResponse: description: |- Response model for file processing operation. Returns a list of chunks ready for storage in vector databases. Each chunk contains the content and metadata. properties: chunks: description: Processed chunks from the file. Always returns at least one chunk. items: $ref: '#/components/schemas/Chunk' title: Chunks type: array metadata: additionalProperties: true description: Processing-run metadata such as processor name/version, processing_time_ms, page_count, extraction_method (e.g. docling/pypdf/ocr), confidence scores, plus provider-specific fields. title: Metadata type: object required: - chunks - metadata title: ProcessFileResponse type: object ListFilesRequest: description: Request model for listing files. properties: after: anyOf: - type: string - type: 'null' description: A cursor for pagination. Returns files after this ID. nullable: true limit: anyOf: - type: integer - type: 'null' default: 10000 description: Maximum number of files to return (1-10,000). order: anyOf: - $ref: '#/components/schemas/Order' title: Order - type: 'null' default: desc description: Sort order by created_at timestamp ('asc' or 'desc'). title: Order purpose: anyOf: - $ref: '#/components/schemas/OpenAIFilePurpose' title: OpenAIFilePurpose - type: 'null' description: Filter files by purpose. nullable: true title: OpenAIFilePurpose title: ListFilesRequest type: object RetrieveFileRequest: description: Request model for retrieving a file. properties: file_id: description: The ID of the file to retrieve. title: File Id type: string required: - file_id title: RetrieveFileRequest type: object DeleteFileRequest: description: Request model for deleting a file. properties: file_id: description: The ID of the file to delete. title: File Id type: string required: - file_id title: DeleteFileRequest type: object RetrieveFileContentRequest: description: Request model for retrieving file content. properties: file_id: description: The ID of the file to retrieve content from. title: File Id type: string required: - file_id title: RetrieveFileContentRequest type: object UploadFileRequest: description: Request model for uploading a file. properties: purpose: $ref: '#/components/schemas/OpenAIFilePurpose' description: The intended purpose of the uploaded file. expires_after: anyOf: - $ref: '#/components/schemas/ExpiresAfter' title: ExpiresAfter - type: 'null' description: Optional expiration settings for the file. nullable: true title: ExpiresAfter required: - purpose title: UploadFileRequest type: object PostTrainingJobLogStream: description: Stream of logs from a finetuning job. properties: job_uuid: title: Job Uuid type: string log_lines: items: type: string title: Log Lines type: array required: - job_uuid - log_lines title: PostTrainingJobLogStream type: object RLHFAlgorithm: description: Available reinforcement learning from human feedback algorithms. enum: - dpo title: RLHFAlgorithm type: string PostTrainingRLHFRequest: description: Request to finetune a model using reinforcement learning from human feedback. properties: job_uuid: title: Job Uuid type: string finetuned_model: $ref: '#/components/schemas/URL' dataset_id: title: Dataset Id type: string validation_dataset_id: title: Validation Dataset Id type: string algorithm: $ref: '#/components/schemas/RLHFAlgorithm' algorithm_config: $ref: '#/components/schemas/DPOAlignmentConfig' optimizer_config: $ref: '#/components/schemas/OptimizerConfig' training_config: $ref: '#/components/schemas/TrainingConfig' hyperparam_search_config: additionalProperties: true title: Hyperparam Search Config type: object logger_config: additionalProperties: true title: Logger Config type: object required: - job_uuid - finetuned_model - dataset_id - validation_dataset_id - algorithm - algorithm_config - optimizer_config - training_config - hyperparam_search_config - logger_config title: PostTrainingRLHFRequest type: object GetTrainingJobStatusRequest: description: Request to get the status of a training job. properties: job_uuid: description: The UUID of the job to get the status of. title: Job Uuid type: string required: - job_uuid title: GetTrainingJobStatusRequest type: object GetTrainingJobArtifactsRequest: description: Request to get the artifacts of a training job. properties: job_uuid: description: The UUID of the job to get the artifacts of. title: Job Uuid type: string required: - job_uuid title: GetTrainingJobArtifactsRequest type: object ListPromptVersionsRequest: description: Request model for listing all versions of a prompt. properties: prompt_id: description: The identifier of the prompt to list versions for. title: Prompt Id type: string required: - prompt_id title: ListPromptVersionsRequest type: object GetPromptRequest: description: Request model for getting a prompt by ID and optional version. properties: prompt_id: description: The identifier of the prompt to get. title: Prompt Id type: string version: anyOf: - type: integer - type: 'null' description: The version of the prompt to get (defaults to latest). nullable: true required: - prompt_id title: GetPromptRequest type: object DeletePromptRequest: description: Request model for deleting a prompt. properties: prompt_id: description: The identifier of the prompt to delete. title: Prompt Id type: string required: - prompt_id title: DeletePromptRequest type: object responses: BadRequest400: description: The request was invalid or malformed content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 400 title: Bad Request detail: The request was invalid or malformed TooManyRequests429: description: The client has sent too many requests in a given amount of time content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 429 title: Too Many Requests detail: You have exceeded the rate limit. Please try again later. InternalServerError500: description: The server encountered an unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' example: status: 500 title: Internal Server Error detail: An unexpected error occurred DefaultError: description: An error occurred content: application/json: schema: $ref: '#/components/schemas/Error' tags: - description: APIs for creating and interacting with agentic systems. name: Agents x-displayName: Agents - description: |- The API is designed to allow use of openai client libraries for seamless integration. This API provides the following extensions: - idempotent batch creation Note: This API is currently under active development and may undergo changes. name: Batches x-displayName: The Batches API enables efficient processing of multiple requests in a single operation, particularly useful for processing large datasets, batch evaluation workflows, and cost-effective inference at scale. - description: '' name: Benchmarks - description: Protocol for conversation management operations. name: Conversations x-displayName: Conversations - description: '' name: DatasetIO - description: '' name: Datasets - description: Llama Stack Evaluation API for running evaluations on model and agent candidates. name: Eval x-displayName: Evaluations - description: This API is used to upload documents that can be used with other Llama Stack APIs. name: Files x-displayName: Files - description: |- Llama Stack Inference API for generating completions, chat completions, and embeddings. This API provides the raw interface to the underlying models. Three kinds of models are supported: - LLM models: these models generate "raw" and "chat" (conversational) completions. - Embedding models: these models generate embeddings to be used for semantic search. - Rerank models: these models reorder the documents based on their relevance to a query. name: Inference x-displayName: Inference - description: APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers. name: Inspect x-displayName: Inspect - description: '' name: Models - description: '' name: PostTraining (Coming Soon) - description: Protocol for prompt management operations. name: Prompts x-displayName: Prompts - description: Providers API for inspecting, listing, and modifying providers and their configurations. name: Providers x-displayName: Providers - description: OpenAI-compatible Moderations API. name: Safety x-displayName: Safety - description: '' name: Scoring - description: '' name: ScoringFunctions - description: '' name: Shields - description: '' name: ToolGroups - description: '' name: ToolRuntime - description: '' name: VectorIO x-tagGroups: - name: Operations tags: - Agents - Batches - Benchmarks - Conversations - DatasetIO - Datasets - Eval - Files - Inference - Inspect - Models - PostTraining (Coming Soon) - Prompts - Providers - Safety - Scoring - ScoringFunctions - Shields - ToolGroups - ToolRuntime - VectorIO security: - Default: []