openapi: 3.1.0 info: title: OGX Specification - Stable & Experimental APIs description: |- This is the specification of the OGX that provides a set of endpoints and their corresponding interfaces that are tailored to best leverage Llama Models. **🔗 COMBINED**: This specification includes both stable production-ready APIs and experimental pre-release APIs. Use stable APIs for production deployments and experimental APIs for testing new features. version: v1 servers: - url: http://any-hosted-ogx.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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") batches = client.batches.list() for batch in batches: print(batch.id, batch.status) 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' x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") batch = client.batches.create( input_file_id="file-abc123", endpoint="/v1/chat/completions", completion_window="24h", ) print(batch.id) /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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") batch = client.batches.retrieve("batch_abc123") print(batch) /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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") batch = client.batches.cancel("batch_abc123") print(batch) /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".' x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") response = client.chat.completions.list() print(response) 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' x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") response = client.chat.completions.create( model="meta-llama/Llama-3.1-8B-Instruct", messages=[ {"role": "user", "content": "What is the capital of France?"}, ], ) print(response.choices[0].message.content) /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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") completion = client.chat.completions.retrieve("completion_id") print(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 x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") response = client.completions.create( model="meta-llama/Llama-3.1-8B-Instruct", prompt="The capital of France is", ) print(response.choices[0].text) /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' - $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' - $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' - $ref: '#/components/schemas/OpenAIResponseCompaction' discriminator: propertyName: type mapping: message: '#/components/schemas/OpenAIResponseMessage' 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' reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' compaction: '#/components/schemas/OpenAIResponseCompaction' 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. - name: include in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/ConversationItemInclude' - type: 'null' title: Include delete: responses: '200': description: The parent 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: 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 x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") response = client.embeddings.create( model="all-MiniLM-L6-v2", input="OGX is awesome", ) print(response.data[0].embedding[:5]) /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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") files = client.files.list() for f in files: print(f.id, f.filename) 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' x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") file = client.files.create( file=open("data.jsonl", "rb"), purpose="batch", ) print(file.id) /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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") file = client.files.retrieve("file-abc123") print(file) 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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") response = client.files.delete("file-abc123") print(response) /v1/files/{file_id}/content: get: responses: '200': description: The file content. content: application/json: schema: type: string '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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") content = client.files.content("file-abc123") print(content.text) /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: Returns OpenAI format by default. Send `anthropic-version` header for Anthropic format, or any Google SDK header (`x-goog-api-key`, `x-goog-user-project`, `x-goog-api-client`) for Google format. content: application/json: schema: oneOf: - $ref: '#/components/schemas/OpenAIListModelsResponse' title: OpenAIListModelsResponse - $ref: '#/components/schemas/AnthropicListModelsResponse' title: AnthropicListModelsResponse - $ref: '#/components/schemas/GoogleListModelsResponse' title: GoogleListModelsResponse '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: List models. description: List models. Returns OpenAI, Anthropic, or Google response format based on SDK detection headers. operationId: list_models_v1_models_get parameters: - name: before_id in: query required: false schema: anyOf: - type: string - type: 'null' description: Return models before this model ID (Anthropic SDK format only). title: Before Id description: Return models before this model ID (Anthropic SDK format only). - name: after_id in: query required: false schema: anyOf: - type: string - type: 'null' description: Return models after this model ID (Anthropic SDK format only). title: After Id description: Return models after this model ID (Anthropic SDK format only). - name: limit in: query required: false schema: anyOf: - type: integer maximum: 1000 minimum: 1 - type: 'null' description: Maximum number of models to return (Anthropic SDK format only). title: Limit description: Maximum number of models to return (Anthropic SDK format only). - name: anthropic-version in: header required: false schema: anyOf: - type: string - type: 'null' title: Anthropic-Version - name: x-goog-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: X-Goog-Api-Key - name: x-goog-user-project in: header required: false schema: anyOf: - type: string - type: 'null' title: X-Goog-User-Project - name: x-goog-api-client in: header required: false schema: anyOf: - type: string - type: 'null' title: X-Goog-Api-Client - name: x-typesafe-sdk in: header required: false schema: anyOf: - type: string - type: 'null' title: X-Typesafe-Sdk x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") models = client.models.list() for model in models: print(model.id) - lang: Anthropic label: Anthropic source: |- from anthropic import Anthropic client = Anthropic( base_url="http://localhost:8321/v1", api_key="fake", ) models = client.models.list() for model in models: print(model.id) - lang: Google label: Google source: |- from google import genai from google.genai import types client = genai.Client( api_key="fake", http_options=types.HttpOptions( base_url="http://localhost:8321", api_version="v1", ), ) for model in client.models.list(): print(model.name) /v1/models/{model_id}: get: responses: '200': description: Returns OpenAI format by default. Send `anthropic-version` header for Anthropic format, or any Google SDK header (`x-goog-api-key`, `x-goog-user-project`, `x-goog-api-client`) for Google format. content: application/json: schema: oneOf: - $ref: '#/components/schemas/Model' title: Model - $ref: '#/components/schemas/AnthropicModelInfo' title: AnthropicModelInfo - $ref: '#/components/schemas/GoogleModelInfo' title: GoogleModelInfo '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. Returns OpenAI, Anthropic, or Google response format based on SDK detection headers. 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. - name: anthropic-version in: header required: false schema: anyOf: - type: string - type: 'null' title: Anthropic-Version - name: x-goog-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: X-Goog-Api-Key - name: x-goog-user-project in: header required: false schema: anyOf: - type: string - type: 'null' title: X-Goog-User-Project - name: x-goog-api-client in: header required: false schema: anyOf: - type: string - type: 'null' title: X-Goog-Api-Client x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") model = client.models.retrieve("meta-llama/Llama-3.1-8B-Instruct") print(model) - lang: Anthropic label: Anthropic source: |- from anthropic import Anthropic client = Anthropic( base_url="http://localhost:8321/v1", api_key="fake", ) model = client.models.retrieve("openai/gpt-4o") print(model.id) - lang: Google label: Google source: |- from google import genai from google.genai import types client = genai.Client( api_key="fake", http_options=types.HttpOptions( base_url="http://localhost:8321", api_version="v1", ), ) model = client.models.get(model="openai/gpt-4o") print(model.name) /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: - Responses 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'). x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") responses = client.responses.list() for r in responses: print(r.id) 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: - Responses 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' application/x-www-form-urlencoded: {} x-ogx-extra-body-params: guardrails: anyOf: - type: boolean - type: 'null' title: Guardrails description: Enable content moderation via the configured moderation_endpoint. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") response = client.responses.create( model="meta-llama/Llama-3.1-8B-Instruct", input="What is the capital of France?", ) print(response.output_text) /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: - Responses 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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") response = client.responses.retrieve("resp_abc123") print(response) 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: - Responses 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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") response = client.responses.delete("resp_abc123") print(response) /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: - Responses 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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") input_items = client.responses.input_items.list("resp_abc123") for item in input_items: print(item) /v1/admin/tools: get: responses: '200': description: A ListToolDefsResponse. content: application/json: schema: $ref: '#/components/schemas/ListToolDefsResponse' '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: - Tools summary: List tools with optional tool group filter. description: List tools with optional tool group filter. operationId: list_tools_v1_admin_tools_get parameters: - name: toolgroup_id in: query required: false schema: anyOf: - type: string - type: 'null' description: The ID of the tool group to filter tools by. title: Toolgroup Id description: The ID of the tool group to filter tools by. /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: - Vector Stores 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 maximum: 100 minimum: 1 - 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). x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") vector_stores = client.vector_stores.list() for vs in vector_stores: print(vs.id, vs.name) 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: - Vector Stores 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' x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") vector_store = client.vector_stores.create( name="my-vector-store", ) print(vector_store.id) /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: - Vector Stores 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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") vector_store = client.vector_stores.retrieve("vs_abc123") print(vector_store) 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: - Vector Stores 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' x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") vector_store = client.vector_stores.update( "vs_abc123", name="updated-name", ) print(vector_store) 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: - Vector Stores 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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") response = client.vector_stores.delete("vs_abc123") print(response) /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: - Vector Stores 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' x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") batch = client.vector_stores.file_batches.create( vector_store_id="vs_abc123", file_ids=["file-abc123", "file-def456"], ) print(batch) /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: - Vector Stores 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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") batch = client.vector_stores.file_batches.retrieve( vector_store_id="vs_abc123", batch_id="vsfb_abc123", ) print(batch) /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: - Vector Stores 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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") batch = client.vector_stores.file_batches.cancel( vector_store_id="vs_abc123", batch_id="vsfb_abc123", ) print(batch) /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: - Vector Stores 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 maximum: 100 minimum: 1 - 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.' x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") files = client.vector_stores.file_batches.list_files( vector_store_id="vs_abc123", batch_id="vsfb_abc123", ) for f in files: print(f.id) /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: - Vector Stores 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 maximum: 100 minimum: 1 - 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: anyOf: - enum: - in_progress - completed - cancelled - failed type: string - type: 'null' description: Filter by file status. title: Filter description: Filter by file status. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") files = client.vector_stores.files.list("vs_abc123") for f in files: print(f.id) 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: - Vector Stores 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' x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") file = client.vector_stores.files.create( vector_store_id="vs_abc123", file_id="file-abc123", ) print(file) /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: - Vector Stores 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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") file = client.vector_stores.files.retrieve( vector_store_id="vs_abc123", file_id="file-abc123", ) print(file) 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: - Vector Stores 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: - Vector Stores 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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") response = client.vector_stores.files.delete( vector_store_id="vs_abc123", file_id="file-abc123", ) print(response) /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: - Vector Stores 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. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") content = client.vector_stores.files.content( vector_store_id="vs_abc123", file_id="file-abc123", ) print(content) /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: - Vector Stores 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' x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") results = client.vector_stores.search( vector_store_id="vs_abc123", query="What is OGX?", ) for result in results: print(result) /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 /v1alpha/inference/rerank: post: responses: '200': description: RerankResponse with indices sorted by relevance score (descending). content: application/json: schema: $ref: '#/components/schemas/RerankResponse' '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: Rerank documents based on relevance to a query. description: Rerank a list of documents based on their relevance to a query. operationId: rerank_v1alpha_inference_rerank_post requestBody: content: application/json: schema: $ref: '#/components/schemas/RerankRequest' required: true /v1alpha/admin/providers: get: responses: '200': description: A list of provider information objects. 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: - Admin summary: List all available providers description: List all available providers with their configuration and health status. operationId: list_providers_v1alpha_admin_providers_get /v1alpha/admin/providers/{provider_id}: get: responses: '200': description: The provider information object. 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 '404': description: Provider not found. tags: - Admin summary: Get provider details description: Get detailed information about a specific provider. operationId: inspect_provider_v1alpha_admin_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. /v1alpha/admin/inspect/routes: get: responses: '200': description: A list of route information objects. 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: - Admin summary: List all available API routes description: List all available API routes with their methods and implementing providers. operationId: list_routes_v1alpha_admin_inspect_routes_get parameters: - name: api_filter in: query required: false schema: 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. title: Api Filter 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. /v1alpha/admin/health: get: responses: '200': description: Health information object. 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: - Admin summary: Get service health status description: Get the current health status of the service. operationId: health_v1alpha_admin_health_get /v1alpha/admin/version: get: responses: '200': description: Version information object. 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: - Admin summary: Get service version description: Get the version of the service. operationId: version_v1alpha_admin_version_get /v1alpha/admin/connectors: get: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListConnectorsResponse' '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: - Admin - Connectors summary: List all connectors. description: List all configured connectors. operationId: list_connectors_v1alpha_admin_connectors_get /v1alpha/admin/connectors/{connector_id}/tools/{tool_name}: get: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ToolDef' '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: - Admin - Connectors summary: Get a tool by name from a connector. description: Get a tool definition by its name from a connector. operationId: get_connector_tool_v1alpha_admin_connectors__connector_id__tools__tool_name__get parameters: - name: connector_id in: path required: true schema: type: string description: Identifier for the connector title: Connector Id description: Identifier for the connector - name: tool_name in: path required: true schema: type: string description: Name of the tool title: Tool Name description: Name of the tool - name: authorization in: query required: false schema: anyOf: - type: string - type: 'null' description: Authorization token title: Authorization description: Authorization token /v1alpha/admin/connectors/{connector_id}/tools: get: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListToolsResponse' '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: - Admin - Connectors summary: List tools from a connector. description: List all tools available from a connector. operationId: list_connector_tools_v1alpha_admin_connectors__connector_id__tools_get parameters: - name: connector_id in: path required: true schema: type: string description: Identifier for the connector title: Connector Id description: Identifier for the connector - name: authorization in: query required: false schema: anyOf: - type: string - type: 'null' description: Authorization token title: Authorization description: Authorization token /v1alpha/admin/connectors/{connector_id}: get: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Connector' '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: - Admin - Connectors summary: Get a connector by its ID. description: Get a connector by its ID. operationId: get_connector_v1alpha_admin_connectors__connector_id__get parameters: - name: connector_id in: path required: true schema: type: string description: Identifier for the connector title: Connector Id description: Identifier for the connector - name: authorization in: query required: false schema: anyOf: - type: string - type: 'null' description: Authorization token title: Authorization description: Authorization token /v1/responses/compact: post: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OpenAICompactedResponse' '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: - Responses summary: Compact a conversation. [alpha] description: '**[alpha]** Compresses conversation history into a smaller representation while preserving context. This endpoint is in alpha and may change without notice.' operationId: compact_openai_response_v1_responses_compact_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CompactResponseRequest' application/x-www-form-urlencoded: {} required: true /v1/responses/{response_id}/cancel: post: responses: '200': description: The updated response object with status 'cancelled'. 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 '404': description: Response not found. '409': description: 'Conflict: Cannot cancel response (not a background response or already in terminal state).' tags: - Responses summary: Cancel a background response that is in progress. description: Cancel a background response that is queued or in progress. Only responses created with background=true can be cancelled. operationId: cancel_openai_response_v1_responses__response_id__cancel_post parameters: - name: response_id in: path required: true schema: type: string description: The ID of the OpenAI response to cancel. title: Response Id description: The ID of the OpenAI response to cancel. x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") response = client.responses.cancel("resp_abc123") print(response) /v1/chat/completions/{completion_id}/messages: get: responses: '200': description: A ChatCompletionMessageList. content: application/json: schema: $ref: '#/components/schemas/ChatCompletionMessageList' '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 completion messages. description: Get the messages in a stored chat completion. operationId: list_chat_completion_messages_v1_chat_completions__completion_id__messages_get parameters: - name: completion_id in: path required: true schema: type: string description: The ID of the chat completion to retrieve messages from. title: Completion Id description: The ID of the chat completion to retrieve messages from. - name: after in: query required: false schema: anyOf: - type: string - type: 'null' description: Identifier for the last message from the previous pagination request. title: After description: Identifier for the last message from the previous pagination request. - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Number of messages to retrieve. default: 20 title: Limit description: Number of messages to retrieve. - name: order in: query required: false schema: anyOf: - $ref: '#/components/schemas/Order' - type: 'null' description: Sort order for messages by timestamp. Use "asc" or "desc". Defaults to "asc". default: asc title: Order description: Sort order for messages by timestamp. Use "asc" or "desc". Defaults to "asc". x-codeSamples: - lang: OpenAI label: OpenAI source: |- from openai import OpenAI client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake") messages = client.chat.completions.messages.list(completion_id="completion_id") print(messages.data) /v1/systemone: post: responses: '200': description: SystemOneResponse with one answer per question. content: application/json: schema: $ref: '#/components/schemas/SystemOneResponse' '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: Answer SystemOne judgment questions about a piece of state. description: Run a decision model's questions against `state` and return calibrated answers. operationId: systemone_v1_systemone_post requestBody: content: application/json: schema: $ref: '#/components/schemas/SystemOneRequest' required: true /v1alpha/file-processors/process: post: responses: '200': description: The processed file chunks. content: application/json: schema: $ref: '#/components/schemas/ProcessFileResponse' '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: - File Processors summary: Process a file into chunks ready for vector database storage. description: Deprecated. This endpoint blocks until processing completes, which can hold a connection open for large files. Use POST /file-processors/jobs to submit the file asynchronously and poll GET /file-processors/jobs/{job_id} for the result. Supports direct upload via multipart form or processing files already uploaded to file storage via file_id. Exactly one of file or file_id must be provided. operationId: process_file_v1alpha_file_processors_process_post requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_process_file_v1alpha_file_processors_process_post' deprecated: true /v1alpha/file-processors/jobs: get: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListProcessFileJobsResponse' '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: - File Processors summary: List file-processing jobs. description: List file-processing jobs, most recent first. operationId: list_process_file_jobs_v1alpha_file_processors_jobs_get parameters: - name: after in: query required: false schema: anyOf: - type: string - type: 'null' description: Return jobs after this job ID. title: After description: Return jobs after this job ID. - name: limit in: query required: false schema: type: integer maximum: 100 minimum: 1 description: Maximum jobs to return. default: 100 title: Limit description: Maximum jobs to return. post: responses: '200': description: The created file-processing job. content: application/json: schema: $ref: '#/components/schemas/ProcessFileJob' '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: - File Processors summary: Submit a file for asynchronous processing. description: Submit a file for processing and return immediately with a job handle. The work runs out-of-process so the server is not blocked. Poll GET /file-processors/jobs/{job_id} until the status is terminal. Supports direct upload via multipart form or a previously uploaded file_id. operationId: create_process_file_job_v1alpha_file_processors_jobs_post requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_create_process_file_job_v1alpha_file_processors_jobs_post' /v1alpha/file-processors/jobs/{job_id}: get: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProcessFileJob' '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: - File Processors summary: Retrieve a file-processing job. description: Retrieve the current state of a file-processing job, including its result once completed. operationId: retrieve_process_file_job_v1alpha_file_processors_jobs__job_id__get parameters: - name: job_id in: path required: true schema: type: string title: Job Id /v1alpha/file-processors/jobs/{job_id}/cancel: post: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProcessFileJob' '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: - File Processors summary: Cancel a file-processing job. description: Cancel a scheduled or in-progress file-processing job. operationId: cancel_process_file_job_v1alpha_file_processors_jobs__job_id__cancel_post parameters: - name: job_id in: path required: true schema: type: string title: Job Id /v1/messages: post: responses: '200': description: An AnthropicMessageResponse or a stream of Anthropic SSE events. content: application/json: schema: $ref: '#/components/schemas/AnthropicMessageResponse' text/event-stream: {} '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: - Messages summary: Create a message. description: Create a message using the Anthropic Messages API format. operationId: create_message_v1_messages_post requestBody: content: application/json: schema: $ref: '#/components/schemas/AnthropicCreateMessageRequest' required: true x-codeSamples: - lang: Anthropic label: Anthropic source: |- from anthropic import Anthropic client = Anthropic( base_url="http://localhost:8321/v1", api_key="fake", ) message = client.messages.create( model="llama-3.3-70b", max_tokens=1024, messages=[ {"role": "user", "content": "What is OGX?"} ], ) print(message.content[0].text) /v1/messages/count_tokens: post: responses: '200': description: Token count for the request. content: application/json: schema: $ref: '#/components/schemas/AnthropicCountTokensResponse' '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: - Messages summary: Count tokens in a message. description: Count the number of tokens in a message request. For some providers, this will cost input tokens and 1 output token. operationId: count_message_tokens_v1_messages_count_tokens_post requestBody: content: application/json: schema: $ref: '#/components/schemas/AnthropicCountTokensRequest' required: true /v1/messages/batches: get: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListMessageBatchesResponse' '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: - Messages summary: List Message Batches. description: List all Message Batches with pagination. operationId: list_message_batches_v1_messages_batches_get parameters: - name: limit in: query required: false schema: type: integer maximum: 1000 minimum: 1 description: Maximum number of batches to return. default: 20 title: Limit description: Maximum number of batches to return. - name: before_id in: query required: false schema: anyOf: - type: string - type: 'null' description: Return batches created before this batch ID. title: Before Id description: Return batches created before this batch ID. - name: after_id in: query required: false schema: anyOf: - type: string - type: 'null' description: Return batches created after this batch ID. title: After Id description: Return batches created after this batch ID. post: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageBatch' '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: - Messages summary: Create a Message Batch. description: Send a batch of message creation requests. operationId: create_message_batch_v1_messages_batches_post requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateMessageBatchRequest' /v1/messages/batches/{message_batch_id}: get: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageBatch' '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: - Messages summary: Retrieve a Message Batch. description: Retrieve the status of a Message Batch by its ID. operationId: retrieve_message_batch_v1_messages_batches__message_batch_id__get parameters: - name: message_batch_id in: path required: true schema: type: string title: Message Batch Id /v1/messages/batches/{message_batch_id}/cancel: post: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageBatch' '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: - Messages summary: Cancel a Message Batch. description: Cancel a Message Batch before processing ends. operationId: cancel_message_batch_v1_messages_batches__message_batch_id__cancel_post parameters: - name: message_batch_id in: path required: true schema: type: string title: Message Batch Id /v1/messages/batches/{message_batch_id}/results: get: 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: Successful Response tags: - Messages summary: Retrieve Message Batch results. description: Stream the results of a Message Batch as JSONL. operationId: retrieve_message_batch_results_v1_messages_batches__message_batch_id__results_get parameters: - name: message_batch_id in: path required: true schema: type: string title: Message Batch Id /v1alpha/interactions: post: responses: '200': description: A GoogleInteractionResponse or a stream of Google SSE events. content: application/json: schema: $ref: '#/components/schemas/GoogleInteractionResponse' text/event-stream: {} '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: - Interactions summary: Create an interaction. description: Create an interaction using the Google Interactions API format. operationId: create_interaction_v1alpha_interactions_post requestBody: content: application/json: schema: $ref: '#/components/schemas/GoogleCreateInteractionRequest' required: true x-codeSamples: - lang: Google label: Google source: |- from google import genai from google.genai import types client = genai.Client( api_key="fake", http_options=types.HttpOptions( base_url="http://localhost:8321", api_version="v1alpha", ), ) interaction = client.interactions.create( model="meta-llama/Llama-3.1-8B-Instruct", input="What is the capital of France?", ) print(interaction.outputs[0].text) /v1alpha/skills: get: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListSkillsResponse' '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: - Skills summary: List skills description: List all skills. operationId: list_skills_v1alpha_skills_get parameters: - name: after in: query required: false schema: anyOf: - type: string - type: 'null' description: Cursor for pagination title: After description: Cursor for pagination - name: limit in: query required: false schema: type: integer description: Maximum number of results default: 20 title: Limit description: Maximum number of results - name: order in: query required: false schema: enum: - asc - desc type: string description: Sort order by created_at default: desc title: Order description: Sort order by created_at post: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Skill' '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: - Skills summary: Create skill description: Create a skill by uploading a zip bundle containing a SKILL.md manifest. operationId: create_skill_v1alpha_skills_post requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/Body_create_skill_v1alpha_skills_post' /v1alpha/skills/{skill_id}: get: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Skill' '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: - Skills summary: Get skill description: Get metadata for a specific skill. operationId: get_skill_v1alpha_skills__skill_id__get parameters: - name: skill_id in: path required: true schema: type: string title: Skill Id post: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Skill' '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: - Skills summary: Update skill description: Update a skill's default version. operationId: update_skill_v1alpha_skills__skill_id__post parameters: - name: skill_id in: path required: true schema: type: string title: Skill Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SkillUpdateRequest' delete: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SkillDeleteResponse' '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: - Skills summary: Delete skill description: Delete a skill and all its versions. operationId: delete_skill_v1alpha_skills__skill_id__delete parameters: - name: skill_id in: path required: true schema: type: string title: Skill Id /v1alpha/skills/{skill_id}/content: get: 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 skill bundle as a zip archive. tags: - Skills summary: Get skill content description: Download the default version's zip bundle. operationId: get_skill_content_v1alpha_skills__skill_id__content_get parameters: - name: skill_id in: path required: true schema: type: string title: Skill Id /v1alpha/skills/{skill_id}/versions: get: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListSkillVersionsResponse' '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: - Skills summary: List skill versions description: List all versions of a skill. operationId: list_skill_versions_v1alpha_skills__skill_id__versions_get parameters: - name: skill_id in: path required: true schema: type: string title: Skill Id - name: after in: query required: false schema: anyOf: - type: string - type: 'null' description: Cursor for pagination title: After description: Cursor for pagination - name: limit in: query required: false schema: type: integer description: Maximum number of results default: 20 title: Limit description: Maximum number of results - name: order in: query required: false schema: enum: - asc - desc type: string description: Sort order by version default: desc title: Order description: Sort order by version post: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SkillVersion' '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: - Skills summary: Create skill version description: Upload a new version of a skill. operationId: create_skill_version_v1alpha_skills__skill_id__versions_post parameters: - name: skill_id in: path required: true schema: type: string title: Skill Id requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/Body_create_skill_version_v1alpha_skills__skill_id__versions_post' /v1alpha/skills/{skill_id}/versions/{version}: get: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SkillVersion' '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: - Skills summary: Get skill version description: Get metadata for a specific skill version. operationId: get_skill_version_v1alpha_skills__skill_id__versions__version__get parameters: - name: skill_id in: path required: true schema: type: string title: Skill Id - name: version in: path required: true schema: type: string title: Version delete: responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SkillVersionDeleteResponse' '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: - Skills summary: Delete skill version description: Delete a specific version of a skill. operationId: delete_skill_version_v1alpha_skills__skill_id__versions__version__delete parameters: - name: skill_id in: path required: true schema: type: string title: Skill Id - name: version in: path required: true schema: type: string title: Version /v1alpha/skills/{skill_id}/versions/{version}/content: get: 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 skill bundle as a zip archive. tags: - Skills summary: Get skill version content description: Download a specific version's zip bundle. operationId: get_skill_version_content_v1alpha_skills__skill_id__versions__version__content_get parameters: - name: skill_id in: path required: true schema: type: string title: Skill Id - name: version in: path required: true schema: type: string title: Version 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 title: Object enum: - 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 title: Completion Window description: The time window within which the batch should be processed. enum: - 24h 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 title: Object enum: - batch 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 title: Object description: Must be 'list' to identify this as a list response. enum: - list default: list type: object required: - data - has_more - first_id - last_id title: ListOpenAIChatCompletionResponse description: Response from listing OpenAI-compatible chat completions. OpenAIAssistantMessageParam: properties: role: type: string title: Role description: Must be 'assistant' to identify this as the model's response. enum: - 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/ChatCompletionMessageToolCall' type: array - type: 'null' description: List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object. additionalProperties: true type: object title: OpenAIAssistantMessageParam description: A message containing the model's (assistant) response in an OpenAI-compatible chat completion request. OpenAIChatCompletionContentPartImageParam: properties: type: type: string title: Type description: Must be 'image_url' to identify this as image content. enum: - 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 title: Type description: Must be 'text' to identify this as text content. enum: - 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. OpenAIChatCompletionToolCallFunction: properties: name: type: string title: Name description: Name of the function to call. arguments: type: string title: Arguments description: Arguments to pass to the function as a JSON string. type: object required: - name - arguments 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. default: 0 completion_tokens: type: integer minimum: 0.0 title: Completion Tokens description: Number of tokens in the completion. default: 0 total_tokens: type: integer minimum: 0.0 title: Total Tokens description: Total tokens used (prompt + completion). default: 0 prompt_tokens_details: $ref: '#/components/schemas/OpenAIChatCompletionUsagePromptTokensDetails' description: Detailed breakdown of input token usage. completion_tokens_details: $ref: '#/components/schemas/OpenAIChatCompletionUsageCompletionTokensDetails' description: Detailed breakdown of output token usage. type: object title: OpenAIChatCompletionUsage description: Usage information for OpenAI chat completion. OpenAIChoice: properties: message: $ref: '#/components/schemas/OpenAIChatCompletionResponseMessage' description: The message from the model. 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: - 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 - type: 'null' description: The log probabilities for the tokens in the message. 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 title: Role description: Must be 'developer' to identify this as a developer message. enum: - 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 title: Type description: Must be 'file' to identify this as file content. enum: - file file: $ref: '#/components/schemas/OpenAIFileFile' description: File specification. required: - file title: OpenAIFile description: File content part for OpenAI-compatible chat completion messages. 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 title: Role description: Must be 'system' to identify this as a system message. enum: - 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 title: Role description: Must be 'tool' to identify this as a tool response. enum: - 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: properties: role: type: string title: Role description: Must be 'user' to identify this as a user message. enum: - 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. 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 required: - name title: OpenAIJSONSchema description: JSON schema specification for OpenAI-compatible structured response format. OpenAIResponseFormatJSONObject: properties: type: type: string title: Type description: Must be 'json_object' to indicate generic JSON object response format. enum: - json_object type: object title: OpenAIResponseFormatJSONObject description: JSON object response format for OpenAI-compatible chat completion requests. OpenAIResponseFormatJSONSchema: properties: type: type: string title: Type description: Must be 'json_schema' to indicate structured JSON response format. enum: - 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 title: Type description: Must be 'text' to indicate plain text response format. enum: - 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' 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 discriminator: propertyName: role mapping: assistant: '#/components/schemas/OpenAIAssistantMessageParam' developer: '#/components/schemas/OpenAIDeveloperMessageParam' system: '#/components/schemas/OpenAISystemMessageParam' tool: '#/components/schemas/OpenAIToolMessageParam' user: '#/components/schemas/OpenAIUserMessageParam' title: OpenAIUserMessageParam | ... (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 maximum: 20.0 minimum: 0.0 - type: 'null' description: The number of most likely tokens to return at each position. 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. service_tier: anyOf: - $ref: '#/components/schemas/ServiceTier' title: ServiceTier - type: 'null' description: The service tier to use for this request. title: ServiceTier reasoning_effort: anyOf: - type: string enum: - none - minimal - low - medium - high - xhigh - type: 'null' description: The effort level for reasoning models. prompt_cache_key: anyOf: - type: string maxLength: 64 - type: 'null' description: A key to use when reading from or writing to the prompt cache. 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: description: The object type. title: Object type: string enum: - chat.completion 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 service_tier: anyOf: - type: string - type: 'null' description: The service tier that was used for this response. nullable: true system_fingerprint: description: System fingerprint for this completion. title: System Fingerprint type: string nullable: true usage: $ref: '#/components/schemas/OpenAIChatCompletionUsage' description: Token usage information for the completion. nullable: true 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: description: The object type. title: Object type: string enum: - chat.completion.chunk 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 service_tier: anyOf: - type: string - type: 'null' description: The service tier that was used for this response. nullable: true system_fingerprint: description: System fingerprint for this completion chunk. title: System Fingerprint type: string nullable: true usage: $ref: '#/components/schemas/OpenAIChatCompletionUsage' description: Token usage information (typically included in final chunk with stream_options). nullable: true 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: description: The role of the delta. enum: - developer - system - user - assistant - tool title: Role type: string nullable: true tool_calls: description: The tool calls of the delta. items: $ref: '#/components/schemas/ChoiceDeltaToolCall' title: Tool Calls type: array 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: 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 description: The log probabilities for the tokens in the message. 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 title: Object description: The object type. enum: - 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. service_tier: anyOf: - type: string - type: 'null' description: The service tier that was used for this response. system_fingerprint: type: string title: System Fingerprint description: System fingerprint for this completion. usage: $ref: '#/components/schemas/OpenAIChatCompletionUsage' description: Token usage information for the completion. input_messages: items: 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 discriminator: propertyName: role mapping: assistant: '#/components/schemas/OpenAIAssistantMessageParam' developer: '#/components/schemas/OpenAIDeveloperMessageParam' system: '#/components/schemas/OpenAISystemMessageParam' tool: '#/components/schemas/OpenAIToolMessageParam' user: '#/components/schemas/OpenAIUserMessageParam' title: OpenAIUserMessageParam | ... (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 description: Chat completion response extended with the original input messages. 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: integer maximum: 5.0 minimum: 0.0 - type: 'null' description: Include the log probabilities on the logprobs most likely output tokens. 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' 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: description: The object type. title: Object type: string enum: - text_completion usage: $ref: '#/components/schemas/OpenAIChatCompletionUsage' description: Token usage information (typically included in the final chunk with stream_options). nullable: true 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: - 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 - type: 'null' description: The log probabilities for the tokens in the choice. nullable: true required: - finish_reason - text - index title: OpenAICompletionChoice type: object ConversationItem: discriminator: mapping: compaction: '#/components/schemas/OpenAIResponseCompaction' 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' reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' 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 - $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' title: OpenAIResponseOutputMessageReasoningItem - $ref: '#/components/schemas/OpenAIResponseCompaction' title: OpenAIResponseCompaction title: OpenAIResponseMessage | ... (11 variants) OpenAIResponseAnnotationCitation: properties: type: type: string title: Type enum: - 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 title: Type enum: - 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 description: Container file citation annotation referencing a file within a container. OpenAIResponseAnnotationFileCitation: properties: type: type: string title: Type enum: - 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 title: Type enum: - file_path file_id: type: string title: File Id index: type: integer title: Index type: object required: - file_id - index title: OpenAIResponseAnnotationFilePath description: File path annotation referencing a generated file in response content. 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 title: Type enum: - 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: 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] title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] type: type: string title: Type enum: - 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 title: Type enum: - 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: anyOf: - type: string enum: - low - type: string enum: - high - type: string enum: - auto title: string default: auto type: type: string title: Type enum: - 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 title: Type enum: - 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 title: Type enum: - 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 title: Type enum: - 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: 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' title: OpenAIResponseOutputMessageContentOutputText - $ref: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseContentPartRefusal discriminator: propertyName: type mapping: output_text: '#/components/schemas/OpenAIResponseOutputMessageContentOutputText' refusal: '#/components/schemas/OpenAIResponseContentPartRefusal' title: OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal type: array title: list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] title: string | list[OpenAIResponseInputMessageContentText | OpenAIResponseInputMessageContentImage | OpenAIResponseInputMessageContentFile] | list[OpenAIResponseOutputMessageContentOutputText | OpenAIResponseContentPartRefusal] role: anyOf: - type: string enum: - system - type: string enum: - developer - type: string enum: - user - type: string enum: - assistant title: string type: type: string title: Type enum: - 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. 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: type: string title: Text type: type: string title: Type enum: - 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 description: Text content within an output message of an OpenAI response. OpenAIResponseOutputMessageFileSearchToolCall: properties: id: type: string title: Id queries: items: type: string type: array title: Queries status: type: string title: Status type: type: string title: Type enum: - 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 title: Type enum: - function_call id: anyOf: - type: string - type: 'null' status: anyOf: - type: string - type: 'null' namespace: 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 title: Type enum: - 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 title: Type enum: - 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 title: Type enum: - web_search_call action: anyOf: - $ref: '#/components/schemas/WebSearchActionSearch' title: WebSearchActionSearch - $ref: '#/components/schemas/WebSearchActionOpenPage' title: WebSearchActionOpenPage - $ref: '#/components/schemas/WebSearchActionFind' title: WebSearchActionFind - type: 'null' title: WebSearchActionSearch | WebSearchActionOpenPage | WebSearchActionFind 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' 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 - $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' title: OpenAIResponseOutputMessageReasoningItem - $ref: '#/components/schemas/OpenAIResponseCompaction' title: OpenAIResponseCompaction discriminator: propertyName: type mapping: compaction: '#/components/schemas/OpenAIResponseCompaction' 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' reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseMessage | ... (11 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 title: Object description: The object type, which is always conversation. enum: - 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. 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 enum: - 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: The type of object returned, must be list. enum: - list data: items: 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 - $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' title: OpenAIResponseOutputMessageReasoningItem - $ref: '#/components/schemas/OpenAIResponseCompaction' title: OpenAIResponseCompaction discriminator: propertyName: type mapping: compaction: '#/components/schemas/OpenAIResponseCompaction' 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' reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseMessage | ... (11 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. type: object required: - data - first_id - last_id - has_more title: ConversationItemList description: List of conversation items with pagination. AddItemsRequest: properties: items: items: 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 - $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' title: OpenAIResponseOutputMessageReasoningItem - $ref: '#/components/schemas/OpenAIResponseCompaction' title: OpenAIResponseCompaction discriminator: propertyName: type mapping: compaction: '#/components/schemas/OpenAIResponseCompaction' 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' reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseMessage | ... (11 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: description: Response for deleted conversation item. properties: id: description: The deleted item identifier title: Id type: string object: description: Object type title: Object type: string enum: - conversation.item.deleted deleted: default: true description: Whether the object was deleted title: Deleted type: boolean required: - id title: ConversationItemDeletedResource type: object 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 title: Object description: The object type. enum: - 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 title: Object description: The object type. enum: - 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 - assistants_output - batch - batch_output - evals - fine-tune - fine-tune-results - vision - user_data title: OpenAIFilePurpose description: Valid purpose values on the OpenAI File response object. 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 title: Object description: The object type, which is always 'list'. enum: - 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 title: Object description: The object type, which is always 'file'. enum: - 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 will expire. filename: type: string title: Filename description: The name of the file. purpose: $ref: '#/components/schemas/OpenAIFilePurpose' description: The intended purpose of the file. status: type: string enum: - uploaded - processed - error title: Status description: Deprecated. The current status of the file. deprecated: true status_details: type: string title: Status Details description: Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job. deprecated: true required: - id - bytes - created_at - filename - purpose - status title: OpenAIFileObject description: OpenAI File object as defined in the OpenAI Files API. ExpiresAfter: description: Control expiration of uploaded files. properties: anchor: description: The anchor point for expiration, must be 'created_at'. title: Anchor type: string enum: - created_at seconds: description: Seconds until expiration, between 3600 (1 hour) and 2592000 (30 days). maximum: 2592000 minimum: 3600 title: Seconds type: integer required: - anchor - seconds title: ExpiresAfter type: object OpenAIFileDeleteResponse: properties: id: type: string title: Id description: The file identifier that was deleted. object: type: string title: Object description: The object type, which is always 'file'. enum: - 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. 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 title: Object enum: - model created: type: integer title: Created owned_by: type: string title: Owned By custom_metadata: anyOf: - additionalProperties: true type: object - type: 'null' 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: OGX-specific metadata including model_type, provider info, and additional metadata OpenAIListModelsResponse: properties: object: type: string title: Object enum: - list 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 ogx 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 title: Type enum: - model metadata: additionalProperties: true type: object title: Metadata description: Any additional metadata for this model created: type: integer title: Created description: The Unix timestamp in seconds when the model was created. owned_by: type: string title: Owned By description: The owner of the model. default: ogx model_type: $ref: '#/components/schemas/ModelType' default: llm model_validation: anyOf: - type: boolean - type: 'null' description: Enable model availability check during registration. When false (default), validation is deferred to runtime and model is preserved during provider refresh. id: type: string title: Id description: The model identifier (OpenAI-compatible alias for identifier). readOnly: true object: type: string title: Object description: The object type, always 'model'. readOnly: true enum: - model required: - identifier - provider_id - id - object title: Model description: A model resource representing an AI model registered in OGX. ModelType: type: string enum: - llm - embedding - rerank - systemone title: ModelType description: Enumeration of supported model types in OGX. 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 OGX. 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 title: Object enum: - 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' reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' 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 - $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' title: OpenAIResponseOutputMessageReasoningItem title: OpenAIResponseMessage | ... (8 variants) - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseCompaction' title: OpenAIResponseCompaction - $ref: '#/components/schemas/OpenAIResponseMessage' title: OpenAIResponseMessage title: OpenAIResponseInputFunctionToolCallOutput | ... (4 variants) OpenAIResponseInputToolFileSearch: properties: type: type: string title: Type enum: - 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 title: Type enum: - 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: anyOf: - type: string enum: - web_search - type: string enum: - web_search_preview - type: string enum: - web_search_preview_2025_03_11 - type: string enum: - web_search_2025_08_26 title: string default: web_search search_context_size: anyOf: - type: string enum: - low - medium - high - type: 'null' filters: anyOf: - $ref: '#/components/schemas/WebSearchFilters' title: WebSearchFilters - type: 'null' title: WebSearchFilters user_location: anyOf: - $ref: '#/components/schemas/WebSearchUserLocation' title: WebSearchUserLocation - type: 'null' title: WebSearchUserLocation type: object title: OpenAIResponseInputToolWebSearch description: Web search tool configuration for OpenAI response inputs. OpenAIResponseObjectWithInput: properties: background: type: boolean title: Background 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 frequency_penalty: type: number title: Frequency Penalty id: type: string title: Id incomplete_details: anyOf: - $ref: '#/components/schemas/OpenAIResponseIncompleteDetails' title: OpenAIResponseIncompleteDetails - type: 'null' title: OpenAIResponseIncompleteDetails model: type: string title: Model object: type: string title: Object enum: - response default: response output: items: $ref: '#/components/schemas/OpenAIResponseOutputItem' type: array title: Output parallel_tool_calls: type: boolean title: Parallel Tool Calls previous_response_id: anyOf: - type: string - type: 'null' prompt_cache_key: anyOf: - type: string - type: 'null' prompt: anyOf: - $ref: '#/components/schemas/OpenAIResponsePrompt' title: OpenAIResponsePrompt - type: 'null' title: OpenAIResponsePrompt status: type: string title: Status temperature: type: number title: Temperature text: $ref: '#/components/schemas/OpenAIResponseText' top_p: type: number title: Top P top_logprobs: type: integer title: Top Logprobs tools: 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 title: Tools 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: - $ref: '#/components/schemas/ResponseTruncation' title: ResponseTruncation - type: 'null' title: ResponseTruncation usage: anyOf: - $ref: '#/components/schemas/OpenAIResponseUsage' title: OpenAIResponseUsage - type: 'null' title: OpenAIResponseUsage instructions: anyOf: - type: string - type: 'null' skills: anyOf: - items: type: string type: array - 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' service_tier: type: string title: Service Tier metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' presence_penalty: type: number title: Presence Penalty store: type: boolean title: Store safety_identifier: anyOf: - type: string - type: 'null' input: items: $ref: '#/components/schemas/OpenAIResponseMessageOutputUnion' 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' reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' 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 - $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' title: OpenAIResponseOutputMessageReasoningItem title: OpenAIResponseMessage | ... (8 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 verbosity: anyOf: - type: string enum: - low - medium - high - type: 'null' default: medium 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 title: Type enum: - 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. OpenAIResponseInputTool: discriminator: mapping: file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' function: '#/components/schemas/OpenAIResponseInputToolFunction' mcp: '#/components/schemas/OpenAIResponseInputToolMCP' namespace: '#/components/schemas/OpenAIResponseInputToolNamespace' 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 - $ref: '#/components/schemas/OpenAIResponseInputToolNamespace' title: OpenAIResponseInputToolNamespace title: OpenAIResponseInputToolWebSearch | ... (5 variants) OpenAIResponseInputToolMCP: properties: type: type: string title: Type enum: - 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 enum: - always - type: string enum: - 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: background: type: boolean title: Background created_at: type: integer title: Created At completed_at: anyOf: - type: integer - type: 'null' error: anyOf: - allOf: - $ref: '#/components/schemas/OpenAIResponseError' - type: 'null' title: ErrorUnion frequency_penalty: type: number title: Frequency Penalty id: type: string title: Id incomplete_details: anyOf: - allOf: - $ref: '#/components/schemas/OpenAIResponseIncompleteDetails' - type: 'null' title: Incomplete_DetailsUnion model: type: string title: Model object: type: string title: Object enum: - response default: response output: items: $ref: '#/components/schemas/OpenAIResponseOutputItem' type: array title: Output parallel_tool_calls: type: boolean title: Parallel Tool Calls previous_response_id: anyOf: - type: string - type: 'null' prompt_cache_key: anyOf: - type: string - type: 'null' prompt: anyOf: - $ref: '#/components/schemas/OpenAIResponsePrompt' title: OpenAIResponsePrompt - type: 'null' title: OpenAIResponsePrompt status: type: string title: Status temperature: type: number title: Temperature text: allOf: - $ref: '#/components/schemas/OpenAIResponseText' - description: Text response configuration for OpenAI responses. top_p: type: number title: Top P top_logprobs: type: integer title: Top Logprobs tools: 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 title: Tools 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: allOf: - $ref: '#/components/schemas/ResponseTruncation' usage: anyOf: - allOf: - $ref: '#/components/schemas/OpenAIResponseUsage' - type: 'null' title: UsageUnion instructions: anyOf: - type: string - type: 'null' skills: anyOf: - items: type: string type: array - type: 'null' max_tool_calls: anyOf: - type: integer - type: 'null' reasoning: anyOf: - allOf: - $ref: '#/components/schemas/OpenAIResponseReasoning' - type: 'null' title: ReasoningUnion max_output_tokens: anyOf: - type: integer - type: 'null' service_tier: type: string title: Service Tier metadata: {} presence_penalty: type: number title: Presence Penalty store: type: boolean title: Store safety_identifier: anyOf: - type: string - type: 'null' 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: title: Type type: string enum: - output_text 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: title: Type type: string enum: - summary_text text: title: Text type: string required: - text title: OpenAIResponseContentPartReasoningSummary type: object OpenAIResponseContentPartReasoningText: description: Reasoning text emitted as part of a streamed response. properties: type: title: Type type: string enum: - reasoning_text text: title: Text type: string required: - text title: OpenAIResponseContentPartReasoningText type: object OpenAIResponseObjectStream: discriminator: mapping: error: '#/components/schemas/OpenAIResponseObjectStreamError' 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 - $ref: '#/components/schemas/OpenAIResponseObjectStreamError' title: OpenAIResponseObjectStreamError title: OpenAIResponseObjectStreamResponseCreated | ... (37 variants) OpenAIResponseObjectStreamResponseCompleted: description: Streaming event indicating a response has been completed. properties: response: $ref: '#/components/schemas/OpenAIResponseObject' sequence_number: title: Sequence Number type: integer type: title: Type type: string enum: - response.completed required: - response - sequence_number 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: title: Type type: string enum: - response.content_part.added 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: title: Type type: string enum: - response.content_part.done 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' sequence_number: title: Sequence Number type: integer type: title: Type type: string enum: - response.created required: - response - sequence_number 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: title: Type type: string enum: - response.failed 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: title: Type type: string enum: - response.file_search_call.completed 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: title: Type type: string enum: - response.file_search_call.in_progress 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: title: Type type: string enum: - response.file_search_call.searching 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: title: Type type: string enum: - response.function_call_arguments.delta 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: title: Type type: string enum: - response.function_call_arguments.done 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: title: Type type: string enum: - response.in_progress 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: title: Type type: string enum: - response.incomplete required: - response - sequence_number title: OpenAIResponseObjectStreamResponseIncomplete type: object OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta: description: Streaming event for incremental MCP 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: title: Type type: string enum: - response.mcp_call.arguments.delta required: - delta - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta type: object OpenAIResponseObjectStreamResponseMcpCallArgumentsDone: description: Streaming event for completed MCP call arguments. 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: title: Type type: string enum: - response.mcp_call.arguments.done 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: title: Type type: string enum: - response.mcp_call.completed required: - sequence_number title: OpenAIResponseObjectStreamResponseMcpCallCompleted type: object OpenAIResponseObjectStreamResponseMcpCallFailed: description: Streaming event for failed MCP calls. properties: sequence_number: title: Sequence Number type: integer type: title: Type type: string enum: - response.mcp_call.failed 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: title: Type type: string enum: - response.mcp_call.in_progress required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseMcpCallInProgress type: object OpenAIResponseObjectStreamResponseMcpListToolsCompleted: description: Streaming event for a completed MCP list tools operation. properties: sequence_number: title: Sequence Number type: integer type: title: Type type: string enum: - response.mcp_list_tools.completed required: - sequence_number title: OpenAIResponseObjectStreamResponseMcpListToolsCompleted type: object OpenAIResponseObjectStreamResponseMcpListToolsFailed: description: Streaming event for a failed MCP list tools operation. properties: sequence_number: title: Sequence Number type: integer type: title: Type type: string enum: - response.mcp_list_tools.failed required: - sequence_number title: OpenAIResponseObjectStreamResponseMcpListToolsFailed type: object OpenAIResponseObjectStreamResponseMcpListToolsInProgress: description: Streaming event for MCP list tools operation in progress. properties: sequence_number: title: Sequence Number type: integer type: title: Type type: string enum: - response.mcp_list_tools.in_progress 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' reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' 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 - $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' title: OpenAIResponseOutputMessageReasoningItem title: OpenAIResponseMessage | ... (8 variants) output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: title: Type type: string enum: - response.output_item.added 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' reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' 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 - $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' title: OpenAIResponseOutputMessageReasoningItem title: OpenAIResponseMessage | ... (8 variants) output_index: title: Output Index type: integer sequence_number: title: Sequence Number type: integer type: title: Type type: string enum: - response.output_item.done 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: title: Type type: string enum: - response.output_text.annotation.added 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: title: Type type: string enum: - response.output_text.delta 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: title: Type type: string enum: - response.output_text.done 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: title: Type type: string enum: - response.reasoning_summary_part.added 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: title: Type type: string enum: - response.reasoning_summary_part.done 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: title: Type type: string enum: - response.reasoning_summary_text.delta 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: title: Type type: string enum: - response.reasoning_summary_text.done 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: title: Type type: string enum: - response.reasoning_text.delta 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: title: Type type: string enum: - response.reasoning_text.done 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: title: Type type: string enum: - response.refusal.delta 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: title: Type type: string enum: - response.refusal.done 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: title: Type type: string enum: - response.web_search_call.completed 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: title: Type type: string enum: - response.web_search_call.in_progress required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseWebSearchCallInProgress type: object OpenAIResponseObjectStreamResponseWebSearchCallSearching: description: Streaming event for web search calls 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: title: Type type: string enum: - response.web_search_call.searching required: - item_id - output_index - sequence_number title: OpenAIResponseObjectStreamResponseWebSearchCallSearching type: object OpenAIDeleteResponseObject: properties: id: type: string title: Id object: type: string title: Object enum: - 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: $ref: '#/components/schemas/OpenAIResponseMessageOutputUnion' type: array title: Data object: type: string title: Object enum: - list type: object required: - data title: ListOpenAIResponseInputItem description: List container for OpenAI response input items. ArrayType: description: Parameter type for array values. properties: type: title: Type type: string enum: - array title: ArrayType type: object BooleanType: description: Parameter type for boolean values. properties: type: title: Type type: string enum: - boolean title: BooleanType type: object ChatCompletionInputType: description: Parameter type for chat completion input. properties: type: title: Type type: string enum: - chat_completion_input title: ChatCompletionInputType type: object CompletionInputType: description: Parameter type for completion input. properties: type: title: Type type: string enum: - completion_input title: CompletionInputType type: object JsonType: description: Parameter type for JSON values. properties: type: title: Type type: string enum: - json title: JsonType type: object NumberType: description: Parameter type for numeric values. properties: type: title: Type type: string enum: - number title: NumberType type: object ObjectType: description: Parameter type for object values. properties: type: title: Type type: string enum: - object title: ObjectType type: object StringType: description: Parameter type for string values. properties: type: title: Type type: string enum: - string title: StringType type: object UnionType: description: Parameter type for union values. properties: type: title: Type type: string enum: - union title: UnionType type: object ImageContentItem: properties: type: type: string title: Type enum: - image image: $ref: '#/components/schemas/_URLOrData' type: object required: - image title: ImageContentItem description: A image content item 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 title: Type enum: - text text: type: string title: Text type: object required: - text title: TextContentItem description: A text content item ToolInvocationResult: description: Result of a tool invocation. 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] - type: 'null' description: The content returned by the tool. title: string | list[ImageContentItem | TextContentItem] nullable: true error_message: anyOf: - type: string - type: 'null' description: Error message if the tool invocation failed. nullable: true error_code: anyOf: - type: integer - type: 'null' description: Error code if the tool invocation failed. nullable: true metadata: anyOf: - additionalProperties: true type: object - type: 'null' description: Additional metadata returned by the tool invocation. nullable: true title: ToolInvocationResult type: object 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' description: The ID of the tool group this tool belongs to. name: type: string title: Name description: The name of the tool. description: anyOf: - type: string - type: 'null' description: A human-readable description of what the tool does. input_schema: anyOf: - additionalProperties: true type: object - type: 'null' description: JSON Schema describing the tool's input parameters. output_schema: anyOf: - additionalProperties: true type: object - type: 'null' description: JSON Schema describing the tool's output format. metadata: anyOf: - additionalProperties: true type: object - type: 'null' description: Additional metadata associated with the tool. 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 description: List of tool definitions. type: object required: - data title: ListToolDefsResponse description: Response containing a list of tool definitions. ToolGroup: description: A group of related tools managed together. properties: identifier: description: Unique identifier for this resource in ogx title: Identifier type: string provider_resource_id: anyOf: - type: string - type: 'null' description: Unique identifier for this resource in the provider nullable: true provider_id: description: ID of the provider that owns this resource title: Provider Id type: string type: title: Type type: string enum: - tool_group mcp_endpoint: anyOf: - $ref: '#/components/schemas/URL' title: URL - type: 'null' description: Model Context Protocol endpoint URL for remote tool groups. nullable: true title: URL args: anyOf: - additionalProperties: true type: object - type: 'null' description: Additional arguments for the tool group. nullable: true required: - identifier - provider_id title: ToolGroup type: object ListToolGroupsResponse: description: Response containing a list of tool groups. properties: data: description: List of tool groups. items: $ref: '#/components/schemas/ToolGroup' title: Data type: array required: - data title: ListToolGroupsResponse type: object Chunk: properties: content: anyOf: - type: string - oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' title: ImageContentItem | TextContentItem - items: oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' title: ImageContentItem | TextContentItem type: array title: list[ImageContentItem | TextContentItem] title: string | list[ImageContentItem | TextContentItem] chunk_id: type: string title: Chunk Id metadata: additionalProperties: true type: object title: Metadata chunk_metadata: $ref: '#/components/schemas/ChunkMetadata' type: object required: - content - chunk_id - chunk_metadata title: Chunk description: A chunk of content from file processing. 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 `make_overlapped_chunks()` 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' 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' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' title: ImageContentItem | TextContentItem - items: oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' title: ImageContentItem | TextContentItem type: array title: list[ImageContentItem | TextContentItem] title: string | list[ImageContentItem | 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' 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 enum: - list data: items: $ref: '#/components/schemas/VectorStoreObject' type: array title: Data first_id: type: string title: First Id last_id: type: string title: Last Id has_more: type: boolean title: Has More type: object required: - data - first_id - last_id - has_more title: VectorStoreListResponse description: Response from listing vector stores. VectorStoreObject: properties: id: type: string title: Id object: type: string title: Object enum: - vector_store created_at: type: integer title: Created At name: type: string title: Name default: '' usage_bytes: type: integer title: Usage Bytes default: 0 file_counts: $ref: '#/components/schemas/VectorStoreFileCounts' status: type: string enum: - expired - in_progress - completed title: Status expires_after: anyOf: - $ref: '#/components/schemas/VectorStoreExpirationAfter' title: VectorStoreExpirationAfter - type: 'null' title: VectorStoreExpirationAfter expires_at: anyOf: - type: integer - type: 'null' last_active_at: anyOf: - type: integer - type: 'null' metadata: anyOf: - additionalProperties: true type: object - type: 'null' type: object required: - id - created_at - file_counts - status title: VectorStoreObject description: OpenAI Vector Store object. VectorStoreChunkingStrategy: discriminator: mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' contextual: '#/components/schemas/VectorStoreChunkingStrategyContextual' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' propertyName: type oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic - $ref: '#/components/schemas/VectorStoreChunkingStrategyContextual' title: VectorStoreChunkingStrategyContextual title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic | VectorStoreChunkingStrategyContextual VectorStoreChunkingStrategyAuto: properties: type: type: string title: Type enum: - auto type: object title: VectorStoreChunkingStrategyAuto description: Automatic chunking strategy for vector store files. VectorStoreChunkingStrategyStatic: properties: type: type: string title: Type enum: - 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' description: anyOf: - type: string - type: 'null' file_ids: anyOf: - items: type: string type: array - type: 'null' expires_after: anyOf: - $ref: '#/components/schemas/VectorStoreExpirationAfter' title: VectorStoreExpirationAfter - type: 'null' title: VectorStoreExpirationAfter chunking_strategy: anyOf: - oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic - $ref: '#/components/schemas/VectorStoreChunkingStrategyContextual' title: VectorStoreChunkingStrategyContextual discriminator: propertyName: type mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' contextual: '#/components/schemas/VectorStoreChunkingStrategyContextual' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic | VectorStoreChunkingStrategyContextual - 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 enum: - vector_store.deleted deleted: type: boolean title: Deleted type: object required: - id - deleted title: VectorStoreDeleteResponse description: Response from deleting a vector store. OpenAICreateVectorStoreFileBatchRequestWithExtraBody: properties: file_ids: items: type: string type: array title: File Ids files: anyOf: - items: $ref: '#/components/schemas/VectorStoreFileBatchFileEntry' type: array - type: 'null' attributes: anyOf: - additionalProperties: anyOf: - type: string maxLength: 512 - type: number - type: boolean title: string | number | boolean propertyNames: type: string maxLength: 64 type: object maxProperties: 16 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 - type: 'null' chunking_strategy: anyOf: - oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic - $ref: '#/components/schemas/VectorStoreChunkingStrategyContextual' title: VectorStoreChunkingStrategyContextual discriminator: propertyName: type mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' contextual: '#/components/schemas/VectorStoreChunkingStrategyContextual' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic | VectorStoreChunkingStrategyContextual - type: 'null' title: Chunking Strategy additionalProperties: true type: object 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 enum: - vector_store.files_batch created_at: type: integer title: Created At vector_store_id: type: string title: Vector Store Id status: type: string enum: - in_progress - completed - cancelled - failed title: Status 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: enum: - in_progress - completed - cancelled - failed type: string VectorStoreFileLastError: properties: code: type: string enum: - server_error - unsupported_file - invalid_file title: Code 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 enum: - vector_store.file attributes: anyOf: - additionalProperties: anyOf: - type: string maxLength: 512 - type: number - type: boolean title: string | number | boolean propertyNames: type: string maxLength: 64 type: object maxProperties: 16 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 - type: 'null' chunking_strategy: oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic - $ref: '#/components/schemas/VectorStoreChunkingStrategyContextual' title: VectorStoreChunkingStrategyContextual title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic | VectorStoreChunkingStrategyContextual discriminator: propertyName: type mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' contextual: '#/components/schemas/VectorStoreChunkingStrategyContextual' 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: type: string enum: - in_progress - completed - cancelled - failed title: Status 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 enum: - list data: items: $ref: '#/components/schemas/VectorStoreFileObject' type: array title: Data first_id: type: string title: First Id last_id: type: string title: Last Id has_more: type: boolean title: Has More type: object required: - data - first_id - last_id - has_more title: VectorStoreFilesListInBatchResponse description: Response from listing files in a vector store file batch. VectorStoreListFilesResponse: properties: object: type: string title: Object enum: - list data: items: $ref: '#/components/schemas/VectorStoreFileObject' type: array title: Data first_id: type: string title: First Id last_id: type: string title: Last Id has_more: type: boolean title: Has More type: object required: - data - first_id - last_id - has_more title: VectorStoreListFilesResponse description: Response from listing files in a vector store. VectorStoreFileDeleteResponse: properties: id: type: string title: Id object: type: string title: Object enum: - vector_store.file.deleted deleted: type: boolean title: Deleted type: object required: - id - deleted title: VectorStoreFileDeleteResponse description: Response from deleting a vector store file. VectorStoreContent: properties: type: type: string title: Type enum: - text 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 title: Object enum: - vector_store.file_content.page data: items: $ref: '#/components/schemas/VectorStoreContent' type: array title: Data has_more: type: boolean title: Has More next_page: anyOf: - type: string - type: 'null' type: object required: - data - has_more 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 enum: - 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 next_page: anyOf: - type: string - type: 'null' type: object required: - search_query - data - has_more 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. 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. RegisterModelRequest: description: Request model for registering a model. properties: model_id: description: The identifier of the model to register. title: Model Id type: string provider_model_id: anyOf: - type: string - type: 'null' description: The identifier of the model in the provider. nullable: true provider_id: anyOf: - type: string - type: 'null' description: The identifier of the provider. nullable: true metadata: anyOf: - additionalProperties: true type: object - type: 'null' description: Any additional metadata for this model. nullable: true model_type: anyOf: - $ref: '#/components/schemas/ModelType' title: ModelType - type: 'null' description: The type of model to register. nullable: true title: ModelType model_validation: anyOf: - type: boolean - type: 'null' description: Enable model availability check during registration. When false (default), validation is deferred to runtime and model is preserved during provider refresh. nullable: true required: - model_id title: RegisterModelRequest type: object 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) 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. AnthropicBase64ImageSource: properties: type: type: string title: Type enum: - base64 media_type: type: string enum: - image/jpeg - image/png - image/gif - image/webp title: Media Type description: MIME type of the image. data: type: string title: Data description: Base64-encoded image data. type: object required: - media_type - data title: AnthropicBase64ImageSource description: Base64-encoded image source. AnthropicBashTool: properties: type: type: string title: Type enum: - bash_20250124 name: type: string title: Name enum: - bash cache_control: anyOf: - $ref: '#/components/schemas/AnthropicCacheControl' title: AnthropicCacheControl - type: 'null' title: AnthropicCacheControl type: object title: AnthropicBashTool description: Built-in bash tool (bash_20250124). AnthropicCacheControl: properties: type: type: string title: Type enum: - ephemeral type: object title: AnthropicCacheControl description: Prompt-cache breakpoint marker. AnthropicCountTokensRequest: properties: model: type: string title: Model description: The model to use for token counting. messages: items: $ref: '#/components/schemas/AnthropicMessage' type: array title: Messages description: The messages to count tokens for. system: anyOf: - type: string - items: $ref: '#/components/schemas/AnthropicTextBlock' type: array title: list[AnthropicTextBlock] - type: 'null' title: string | list[AnthropicTextBlock] description: System prompt. tools: anyOf: - items: oneOf: - $ref: '#/components/schemas/AnthropicCustomToolDef' title: AnthropicCustomToolDef - $ref: '#/components/schemas/AnthropicWebSearchTool' title: AnthropicWebSearchTool - $ref: '#/components/schemas/AnthropicBashTool' title: AnthropicBashTool - $ref: '#/components/schemas/AnthropicTextEditorTool' title: AnthropicTextEditorTool discriminator: propertyName: type mapping: bash_20250124: '#/components/schemas/AnthropicBashTool' custom: '#/components/schemas/AnthropicCustomToolDef' text_editor_20250124: '#/components/schemas/AnthropicTextEditorTool' text_editor_20250429: '#/components/schemas/AnthropicTextEditorTool' text_editor_20250728: '#/components/schemas/AnthropicTextEditorTool' web_search_20250305: '#/components/schemas/AnthropicWebSearchTool' title: AnthropicCustomToolDef | ... (4 variants) type: array - type: 'null' description: Tools to include in token count. type: object required: - model - messages title: AnthropicCountTokensRequest description: Request body for POST /v1/messages/count_tokens. AnthropicCountTokensResponse: properties: input_tokens: type: integer title: Input Tokens type: object required: - input_tokens title: AnthropicCountTokensResponse description: Response from POST /v1/messages/count_tokens. AnthropicCreateMessageRequest: properties: model: type: string title: Model description: The model to use for generation. messages: items: $ref: '#/components/schemas/AnthropicMessage' type: array title: Messages description: The messages in the conversation. max_tokens: type: integer minimum: 1.0 title: Max Tokens description: The maximum number of tokens to generate. system: anyOf: - type: string - items: $ref: '#/components/schemas/AnthropicTextBlock' type: array title: list[AnthropicTextBlock] - type: 'null' title: string | list[AnthropicTextBlock] description: System prompt. A string or list of text blocks. tools: items: oneOf: - $ref: '#/components/schemas/AnthropicCustomToolDef' title: AnthropicCustomToolDef - $ref: '#/components/schemas/AnthropicWebSearchTool' title: AnthropicWebSearchTool - $ref: '#/components/schemas/AnthropicBashTool' title: AnthropicBashTool - $ref: '#/components/schemas/AnthropicTextEditorTool' title: AnthropicTextEditorTool discriminator: propertyName: type mapping: bash_20250124: '#/components/schemas/AnthropicBashTool' custom: '#/components/schemas/AnthropicCustomToolDef' text_editor_20250124: '#/components/schemas/AnthropicTextEditorTool' text_editor_20250429: '#/components/schemas/AnthropicTextEditorTool' text_editor_20250728: '#/components/schemas/AnthropicTextEditorTool' web_search_20250305: '#/components/schemas/AnthropicWebSearchTool' title: AnthropicCustomToolDef | ... (4 variants) type: array title: Tools description: Tools available to the model. tool_choice: oneOf: - $ref: '#/components/schemas/_ToolChoiceAuto' title: _ToolChoiceAuto - $ref: '#/components/schemas/_ToolChoiceAny' title: _ToolChoiceAny - $ref: '#/components/schemas/_ToolChoiceNone' title: _ToolChoiceNone - $ref: '#/components/schemas/_ToolChoiceTool' title: _ToolChoiceTool title: _ToolChoiceAuto | ... (4 variants) description: "How the model should select tools. One of: 'auto', 'any', 'none', or {type: 'tool', name: '...'}." discriminator: propertyName: type mapping: any: '#/components/schemas/_ToolChoiceAny' auto: '#/components/schemas/_ToolChoiceAuto' none: '#/components/schemas/_ToolChoiceNone' tool: '#/components/schemas/_ToolChoiceTool' stream: type: boolean title: Stream description: Whether to stream the response. default: false temperature: type: number maximum: 1.0 minimum: 0.0 title: Temperature description: Sampling temperature. top_p: type: number maximum: 1.0 minimum: 0.0 title: Top P description: Nucleus sampling parameter. top_k: type: integer minimum: 1.0 title: Top K description: Top-k sampling parameter. stop_sequences: items: type: string type: array title: Stop Sequences description: Custom stop sequences. metadata: additionalProperties: type: string type: object title: Metadata description: Request metadata. thinking: $ref: '#/components/schemas/AnthropicThinkingConfig' description: Extended thinking configuration. service_tier: type: string title: Service Tier description: Service tier to use. additionalProperties: true type: object required: - model - messages - max_tokens title: AnthropicCreateMessageRequest description: Request body for POST /v1/messages. AnthropicCustomToolDef: properties: type: type: string title: Type enum: - custom name: type: string title: Name description: anyOf: - type: string - type: 'null' input_schema: additionalProperties: true type: object title: Input Schema description: JSON Schema for the tool's input. cache_control: anyOf: - $ref: '#/components/schemas/AnthropicCacheControl' title: AnthropicCacheControl - type: 'null' title: AnthropicCacheControl type: object required: - name - input_schema title: AnthropicCustomToolDef description: Definition of a custom (function-calling) tool. AnthropicImageBlock: properties: type: type: string title: Type enum: - image source: oneOf: - $ref: '#/components/schemas/AnthropicBase64ImageSource' title: AnthropicBase64ImageSource - $ref: '#/components/schemas/AnthropicURLImageSource' title: AnthropicURLImageSource title: AnthropicBase64ImageSource | AnthropicURLImageSource discriminator: propertyName: type mapping: base64: '#/components/schemas/AnthropicBase64ImageSource' url: '#/components/schemas/AnthropicURLImageSource' cache_control: anyOf: - $ref: '#/components/schemas/AnthropicCacheControl' title: AnthropicCacheControl - type: 'null' title: AnthropicCacheControl type: object required: - source title: AnthropicImageBlock description: An image content block. AnthropicMessage: properties: role: type: string enum: - user - assistant - system title: Role content: anyOf: - type: string - items: oneOf: - $ref: '#/components/schemas/AnthropicTextBlock' title: AnthropicTextBlock - $ref: '#/components/schemas/AnthropicImageBlock' title: AnthropicImageBlock - $ref: '#/components/schemas/AnthropicToolUseBlock' title: AnthropicToolUseBlock - $ref: '#/components/schemas/AnthropicToolResultBlock' title: AnthropicToolResultBlock - $ref: '#/components/schemas/AnthropicThinkingBlock' title: AnthropicThinkingBlock - $ref: '#/components/schemas/AnthropicRedactedThinkingBlock' title: AnthropicRedactedThinkingBlock discriminator: propertyName: type mapping: image: '#/components/schemas/AnthropicImageBlock' redacted_thinking: '#/components/schemas/AnthropicRedactedThinkingBlock' text: '#/components/schemas/AnthropicTextBlock' thinking: '#/components/schemas/AnthropicThinkingBlock' tool_result: '#/components/schemas/AnthropicToolResultBlock' tool_use: '#/components/schemas/AnthropicToolUseBlock' title: AnthropicTextBlock | ... (6 variants) type: array title: list[AnthropicTextBlock | AnthropicImageBlock | ...] title: string | list[AnthropicTextBlock | AnthropicImageBlock | ...] description: 'Message content: a string for simple text, or a list of content blocks.' type: object required: - role - content title: AnthropicMessage description: A message in the conversation. AnthropicMessageResponse: properties: id: type: string title: Id description: Unique message ID (msg_ prefix). type: type: string title: Type enum: - message role: type: string title: Role enum: - assistant content: items: oneOf: - $ref: '#/components/schemas/AnthropicTextBlock' title: AnthropicTextBlock - $ref: '#/components/schemas/AnthropicImageBlock' title: AnthropicImageBlock - $ref: '#/components/schemas/AnthropicToolUseBlock' title: AnthropicToolUseBlock - $ref: '#/components/schemas/AnthropicToolResultBlock' title: AnthropicToolResultBlock - $ref: '#/components/schemas/AnthropicThinkingBlock' title: AnthropicThinkingBlock - $ref: '#/components/schemas/AnthropicRedactedThinkingBlock' title: AnthropicRedactedThinkingBlock discriminator: propertyName: type mapping: image: '#/components/schemas/AnthropicImageBlock' redacted_thinking: '#/components/schemas/AnthropicRedactedThinkingBlock' text: '#/components/schemas/AnthropicTextBlock' thinking: '#/components/schemas/AnthropicThinkingBlock' tool_result: '#/components/schemas/AnthropicToolResultBlock' tool_use: '#/components/schemas/AnthropicToolUseBlock' title: AnthropicTextBlock | ... (6 variants) type: array title: Content description: Response content blocks. model: type: string title: Model stop_reason: anyOf: - type: string - type: 'null' description: 'Why the model stopped: end_turn, stop_sequence, tool_use, or max_tokens.' stop_sequence: anyOf: - type: string - type: 'null' usage: $ref: '#/components/schemas/AnthropicUsage' type: object required: - id - content - model title: AnthropicMessageResponse description: Response from POST /v1/messages (non-streaming). AnthropicRedactedThinkingBlock: properties: type: type: string title: Type enum: - redacted_thinking data: type: string title: Data description: Opaque redacted thinking data. type: object required: - data title: AnthropicRedactedThinkingBlock description: A redacted thinking content block. Must be echoed back as-is in multi-turn. AnthropicTextBlock: properties: type: type: string title: Type enum: - text text: type: string title: Text cache_control: anyOf: - $ref: '#/components/schemas/AnthropicCacheControl' title: AnthropicCacheControl - type: 'null' title: AnthropicCacheControl type: object required: - text title: AnthropicTextBlock description: A text content block. AnthropicTextEditorTool: properties: type: type: string enum: - text_editor_20250124 - text_editor_20250429 - text_editor_20250728 title: Type name: type: string title: Name max_characters: anyOf: - type: integer - type: 'null' cache_control: anyOf: - $ref: '#/components/schemas/AnthropicCacheControl' title: AnthropicCacheControl - type: 'null' title: AnthropicCacheControl type: object required: - type - name title: AnthropicTextEditorTool description: Built-in text editor tool (all versions). AnthropicThinkingBlock: properties: type: type: string title: Type enum: - thinking thinking: type: string title: Thinking description: The model's thinking text. signature: anyOf: - type: string - type: 'null' description: Signature for the thinking block. cache_control: anyOf: - $ref: '#/components/schemas/AnthropicCacheControl' title: AnthropicCacheControl - type: 'null' title: AnthropicCacheControl type: object required: - thinking title: AnthropicThinkingBlock description: A thinking content block (extended thinking). AnthropicThinkingConfig: properties: type: type: string enum: - enabled - disabled - adaptive title: Type default: enabled budget_tokens: anyOf: - type: integer minimum: 1024.0 - type: 'null' description: Maximum tokens for thinking. type: object title: AnthropicThinkingConfig description: Configuration for extended thinking. AnthropicToolResultBlock: properties: type: type: string title: Type enum: - tool_result tool_use_id: type: string title: Tool Use Id description: The ID of the tool_use block this result corresponds to. content: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/AnthropicTextBlock' title: AnthropicTextBlock - $ref: '#/components/schemas/AnthropicImageBlock' title: AnthropicImageBlock title: AnthropicTextBlock | AnthropicImageBlock type: array title: list[AnthropicTextBlock | AnthropicImageBlock] title: string | list[AnthropicTextBlock | AnthropicImageBlock] description: The result content. default: '' is_error: anyOf: - type: boolean - type: 'null' description: Whether the tool call resulted in an error. cache_control: anyOf: - $ref: '#/components/schemas/AnthropicCacheControl' title: AnthropicCacheControl - type: 'null' title: AnthropicCacheControl type: object required: - tool_use_id title: AnthropicToolResultBlock description: A tool result content block in a user message. AnthropicToolUseBlock: properties: type: type: string title: Type enum: - tool_use id: type: string title: Id description: Unique ID for this tool invocation. name: type: string title: Name description: Name of the tool being called. input: additionalProperties: true type: object title: Input description: Tool input arguments. cache_control: anyOf: - $ref: '#/components/schemas/AnthropicCacheControl' title: AnthropicCacheControl - type: 'null' title: AnthropicCacheControl type: object required: - id - name - input title: AnthropicToolUseBlock description: A tool use content block in an assistant message. AnthropicURLImageSource: properties: type: type: string title: Type enum: - url url: type: string title: Url description: URL of the image. type: object required: - url title: AnthropicURLImageSource description: URL image source. AnthropicUsage: properties: input_tokens: type: integer title: Input Tokens default: 0 output_tokens: type: integer title: Output Tokens default: 0 cache_creation_input_tokens: anyOf: - type: integer - type: 'null' cache_read_input_tokens: anyOf: - type: integer - type: 'null' type: object title: AnthropicUsage description: Token usage statistics. AnthropicWebSearchTool: properties: type: type: string title: Type enum: - web_search_20250305 name: type: string title: Name enum: - web_search max_uses: anyOf: - type: integer - type: 'null' allowed_domains: anyOf: - items: type: string type: array - type: 'null' blocked_domains: anyOf: - items: type: string type: array - type: 'null' user_location: anyOf: - $ref: '#/components/schemas/_WebSearchUserLocation' title: _WebSearchUserLocation - type: 'null' title: _WebSearchUserLocation cache_control: anyOf: - $ref: '#/components/schemas/AnthropicCacheControl' title: AnthropicCacheControl - type: 'null' title: AnthropicCacheControl type: object title: AnthropicWebSearchTool description: Built-in web search tool (web_search_20250305). 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 description: The request counts for different statuses within the batch. 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 description: |- Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. Only populated on batches created after September 7, 2025. Body_create_process_file_job_v1alpha_file_processors_jobs_post: properties: file: anyOf: - type: string contentMediaType: application/octet-stream - type: 'null' description: The File object to be uploaded and processed. Mutually exclusive with file_id. file_id: anyOf: - type: string - type: 'null' description: ID of file already uploaded to file storage. Mutually exclusive with file. options: anyOf: - additionalProperties: true type: object - type: 'null' description: Optional processing options. Provider-specific parameters. chunking_strategy: anyOf: - type: string - type: 'null' description: Optional chunking strategy for splitting content into chunks. Must be valid JSON string. type: object title: Body_create_process_file_job_v1alpha_file_processors_jobs_post Body_create_skill_v1alpha_skills_post: properties: file: type: string title: File description: Zip archive containing the skill bundle. format: binary type: object required: - file title: Body_create_skill_v1alpha_skills_post Body_create_skill_version_v1alpha_skills__skill_id__versions_post: properties: file: type: string title: File description: Zip archive containing the skill bundle. format: binary default: type: boolean title: Default description: Whether to set this version as the default. default: false type: object required: - file title: Body_create_skill_version_v1alpha_skills__skill_id__versions_post Body_process_file_v1alpha_file_processors_process_post: properties: file: anyOf: - type: string contentMediaType: application/octet-stream - type: 'null' description: The File object to be uploaded and processed. Mutually exclusive with file_id. file_id: anyOf: - type: string - type: 'null' description: ID of file already uploaded to file storage. Mutually exclusive with file. options: anyOf: - additionalProperties: true type: object - type: 'null' description: Optional processing options. Provider-specific parameters (e.g., OCR settings, output format). chunking_strategy: anyOf: - type: string - type: 'null' description: Optional chunking strategy for splitting content into chunks. Must be valid JSON string. type: object title: Body_process_file_v1alpha_file_processors_process_post Body_upload_file_v1_files_post: properties: file: type: string title: File description: The file to upload. format: binary purpose: $ref: '#/components/schemas/OpenAIFileUploadPurpose' description: The intended purpose of the uploaded file. expires_after: anyOf: - type: string - type: 'null' description: Optional expiration settings for the file. type: object required: - file - purpose title: Body_upload_file_v1_files_post ChatCompletionMessage: properties: id: type: string title: Id description: The identifier of the chat message. role: type: string enum: - developer - system - user - assistant - tool title: Role description: The role of the message author. content: anyOf: - type: string - type: 'null' description: The text content of the message. content_parts: anyOf: - items: anyOf: - $ref: '#/components/schemas/OpenAIChatCompletionContentPartTextParam' title: OpenAIChatCompletionContentPartTextParam - $ref: '#/components/schemas/OpenAIChatCompletionContentPartImageParam' title: OpenAIChatCompletionContentPartImageParam title: OpenAIChatCompletionContentPartTextParam | OpenAIChatCompletionContentPartImageParam type: array - type: 'null' description: Multipart content parts when the original message used content parts. Only text and image_url parts. name: anyOf: - type: string - type: 'null' description: The name of the message participant. tool_calls: items: anyOf: - $ref: '#/components/schemas/ChatCompletionMessageToolCall' title: ChatCompletionMessageToolCall - $ref: '#/components/schemas/ChatCompletionMessageCustomToolCall' title: ChatCompletionMessageCustomToolCall title: ChatCompletionMessageToolCall | ChatCompletionMessageCustomToolCall type: array title: Tool Calls description: The tool calls generated by the message, when applicable. tool_call_id: anyOf: - type: string - type: 'null' description: For tool messages, the identifier of the tool call this message responds to. refusal: anyOf: - type: string - type: 'null' description: The refusal message generated by the model, when applicable. function_call: properties: name: type: string title: Name description: Name of the function to call. arguments: type: string title: Arguments description: Arguments to pass to the function as a JSON string. type: object required: - name - arguments description: 'Deprecated: the name and arguments of a function that should be called.' annotations: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' description: Annotations for the message, when applicable. audio: anyOf: - additionalProperties: true type: object - type: 'null' description: Audio response data when using audio output modality. type: object required: - id - role title: ChatCompletionMessage description: A message from a stored chat completion. ChatCompletionMessageList: properties: data: items: $ref: '#/components/schemas/ChatCompletionMessage' type: array title: Data description: List of messages. has_more: type: boolean title: Has More description: Whether more messages are available. first_id: type: string title: First Id description: ID of the first message in this page. last_id: type: string title: Last Id description: ID of the last message in this page. object: type: string title: Object description: The object type. enum: - list default: list type: object required: - data - has_more - first_id - last_id title: ChatCompletionMessageList description: Paginated list of messages from a stored chat completion. CompactResponseRequest: properties: model: anyOf: - $ref: '#/components/schemas/ModelIdsResponses' - type: string - type: 'null' description: The model to use for generating the compacted summary. input: anyOf: - oneOf: - type: string - items: anyOf: - 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 - $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' title: OpenAIResponseOutputMessageReasoningItem 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' reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseMessage | ... (8 variants) - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseCompaction' title: OpenAIResponseCompaction title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseCompaction type: array title: list[OpenAIResponseMessageUnion | OpenAIResponseInputFunctionToolCallOutput | ...] - type: 'null' title: string | list[OpenAIResponseMessageUnion | OpenAIResponseInputFunctionToolCallOutput | ...] description: Input message(s) to compact. instructions: anyOf: - type: string - type: 'null' description: Instructions to guide the compaction. previous_response_id: anyOf: - type: string - type: 'null' description: ID of a previous response whose history to compact. prompt_cache_key: anyOf: - type: string maxLength: 64 - type: 'null' description: A key to use when reading from or writing to the prompt cache. 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 - $ref: '#/components/schemas/OpenAIResponseInputToolNamespace' title: OpenAIResponseInputToolNamespace discriminator: propertyName: type mapping: file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' function: '#/components/schemas/OpenAIResponseInputToolFunction' mcp: '#/components/schemas/OpenAIResponseInputToolMCP' namespace: '#/components/schemas/OpenAIResponseInputToolNamespace' 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 | ... (5 variants) type: array - type: 'null' description: List of tools available to the model. Accepted for compatibility but not used during compaction. parallel_tool_calls: anyOf: - type: boolean - type: 'null' description: Whether to enable parallel tool calls. Accepted for compatibility but not used during compaction. reasoning: anyOf: - $ref: '#/components/schemas/OpenAIResponseReasoning' title: OpenAIResponseReasoning - type: 'null' description: Configuration for reasoning effort. Accepted for compatibility but not used during compaction. title: OpenAIResponseReasoning text: anyOf: - $ref: '#/components/schemas/OpenAIResponseText' title: OpenAIResponseText - type: 'null' description: Configuration for text response generation. Accepted for compatibility but not used during compaction. title: OpenAIResponseText additionalProperties: true type: object required: - model title: CompactResponseRequest description: Request model for compacting a conversation. 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 OGX ConnectorType: type: string enum: - mcp title: ConnectorType description: Type of connector. ContextManagement: properties: type: type: string title: Type description: The context management entry type. Currently only 'compaction' is supported. enum: - compaction compact_threshold: anyOf: - type: integer - type: 'null' description: Token threshold at which compaction should be triggered. additionalProperties: false type: object required: - type title: ContextManagement description: Configuration for automatic context management during response generation. 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. CreateMessageBatchRequest: properties: requests: items: $ref: '#/components/schemas/MessageBatchRequestParams' type: array maxItems: 1000 minItems: 1 title: Requests description: List of requests for prompt completion. type: object required: - requests title: CreateMessageBatchRequest description: Request body for POST /v1/messages/batches. CreateResponseRequest: properties: input: anyOf: - type: string - items: anyOf: - 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 - $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' title: OpenAIResponseOutputMessageReasoningItem 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' reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' title: OpenAIResponseMessage | ... (8 variants) - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseCompaction' title: OpenAIResponseCompaction title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseCompaction 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. background: type: boolean title: Background description: Whether to run the model response in the background. When true, returns immediately with status 'queued'. 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. skills: anyOf: - items: type: string type: array - type: 'null' description: List of skill IDs whose SKILL.md instructions are injected into the model's context. parallel_tool_calls: anyOf: - type: boolean - type: 'null' description: Whether to enable parallel tool calls. previous_response_id: anyOf: - type: string - type: 'null' description: Optional ID of a previous response to continue from. prompt_cache_key: anyOf: - type: string maxLength: 64 - type: 'null' description: A key to use when reading from or writing to the prompt cache. conversation: anyOf: - type: string - type: 'null' description: Optional ID of a conversation to add the response to. store: type: boolean title: Store description: Whether to store the response in the database. stream: type: boolean title: Stream description: Whether to stream the response. temperature: anyOf: - type: number maximum: 2.0 minimum: 0.0 - type: 'null' description: Sampling temperature. top_p: anyOf: - type: number maximum: 1.0 minimum: 0.0 - type: 'null' description: Nucleus sampling parameter that controls response diversity (lower values increase focus). frequency_penalty: anyOf: - type: number maximum: 2.0 minimum: -2.0 - type: 'null' description: Penalizes new tokens based on their frequency in the text so far. text: anyOf: - allOf: - $ref: '#/components/schemas/OpenAIResponseText' - description: Configuration for text response generation. - type: 'null' title: TextUnion 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 - $ref: '#/components/schemas/OpenAIResponseInputToolNamespace' title: OpenAIResponseInputToolNamespace discriminator: propertyName: type mapping: file_search: '#/components/schemas/OpenAIResponseInputToolFileSearch' function: '#/components/schemas/OpenAIResponseInputToolFunction' mcp: '#/components/schemas/OpenAIResponseInputToolMCP' namespace: '#/components/schemas/OpenAIResponseInputToolNamespace' 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 | ... (5 variants) type: array - type: 'null' description: List of tools available to the model. include: items: $ref: '#/components/schemas/ResponseItemInclude' type: array title: Include 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 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: - allOf: - $ref: '#/components/schemas/OpenAIResponseReasoning' - description: Configuration for reasoning effort in responses. - type: 'null' title: ReasoningUnion service_tier: anyOf: - $ref: '#/components/schemas/ServiceTier' title: ServiceTier - type: 'null' description: The service tier to use for this request. title: ServiceTier metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' description: Dictionary of metadata key-value pairs to attach to the response. safety_identifier: anyOf: - type: string - type: 'null' description: A stable identifier used to associate the request with an end user, for safety monitoring. Echoed back on the response. truncation: allOf: - $ref: '#/components/schemas/ResponseTruncation' - description: Controls how the service truncates input when it exceeds the model context window. top_logprobs: anyOf: - type: integer maximum: 20.0 minimum: 0.0 - type: 'null' description: The number of most likely tokens to return at each position, along with their log probabilities. presence_penalty: anyOf: - type: number maximum: 2.0 minimum: -2.0 - type: 'null' description: Penalizes new tokens based on whether they appear in the text so far. stream_options: anyOf: - allOf: - $ref: '#/components/schemas/ResponseStreamOptions' - description: Options that control streamed response behavior. - type: 'null' title: Stream_OptionsUnion context_management: anyOf: - items: $ref: '#/components/schemas/ContextManagement' type: array - type: 'null' description: Context management configuration. When set with type 'compaction', automatically compacts conversation history when token count exceeds the compact_threshold. memory: anyOf: - $ref: '#/components/schemas/MemoryToolConfig' title: MemoryToolConfig - type: 'null' description: Controls owner-scoped memory retrieval for this response. title: MemoryToolConfig additionalProperties: true type: object required: - input - model title: CreateResponseRequest description: Request model for creating a response. EmbeddedChunk: properties: content: anyOf: - type: string - oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' title: ImageContentItem | TextContentItem - items: oneOf: - $ref: '#/components/schemas/ImageContentItem' title: ImageContentItem - $ref: '#/components/schemas/TextContentItem' title: TextContentItem discriminator: propertyName: type mapping: image: '#/components/schemas/ImageContentItem' text: '#/components/schemas/TextContentItem' title: ImageContentItem | TextContentItem type: array title: list[ImageContentItem | TextContentItem] title: string | list[ImageContentItem | 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 GoogleCreateInteractionRequest: properties: model: type: string title: Model description: The model to use for generation. input: anyOf: - type: string - items: $ref: '#/components/schemas/GoogleInputTurn' description: A conversation turn. type: array title: list[GoogleInputTurn] title: string | list[GoogleInputTurn] description: Prompt string or list of conversation turns. system_instruction: anyOf: - type: string - type: 'null' description: System prompt. generation_config: anyOf: - $ref: '#/components/schemas/GoogleGenerationConfig' title: GoogleGenerationConfig - type: 'null' description: Generation parameters. title: GoogleGenerationConfig tools: anyOf: - items: $ref: '#/components/schemas/GoogleTool' type: array - type: 'null' description: Tools (function declarations) available to the model. previous_interaction_id: anyOf: - type: string - type: 'null' description: ID of a previous interaction to continue the conversation from. stream: anyOf: - type: boolean - type: 'null' description: Whether to stream the response via SSE. default: false response_modalities: anyOf: - items: type: string type: array - type: 'null' description: Accepted response modalities (e.g. ['TEXT']). Accepted for compatibility, ignored in v1. additionalProperties: true type: object required: - model - input title: GoogleCreateInteractionRequest description: Request body for POST /v1alpha/interactions. GoogleFunctionCallContent: properties: type: type: string title: Type enum: - function_call id: anyOf: - type: string - type: 'null' description: Unique identifier for this function call. name: type: string title: Name description: Name of the function to call. arguments: additionalProperties: true type: object title: Arguments description: Arguments for the function call. additionalProperties: true type: object required: - name title: GoogleFunctionCallContent description: A function call content item (model requesting a tool invocation). GoogleFunctionCallOutput: properties: type: type: string title: Type enum: - function_call id: anyOf: - type: string - type: 'null' description: Unique identifier for this function call. name: type: string title: Name description: Name of the function to call. arguments: additionalProperties: true type: object title: Arguments description: Arguments for the function call. additionalProperties: true type: object required: - name title: GoogleFunctionCallOutput description: A function call output item (model requesting a tool invocation). GoogleFunctionDeclaration: properties: name: type: string title: Name description: The name of the function. description: anyOf: - type: string - type: 'null' description: Description of the function. parameters: anyOf: - additionalProperties: true type: object - type: 'null' description: JSON Schema for the function's input parameters. additionalProperties: true type: object required: - name title: GoogleFunctionDeclaration description: A function declaration for tool calling. GoogleFunctionResponseContent: properties: type: type: string enum: - function_response - function_result title: Type default: function_result call_id: anyOf: - type: string - type: 'null' description: ID of the function call this responds to. id: anyOf: - type: string - type: 'null' description: Deprecated alias for call_id. name: type: string title: Name description: Name of the function that was called. result: additionalProperties: true type: object title: Result description: The function's return value. additionalProperties: true type: object required: - name title: GoogleFunctionResponseContent description: |- A function response/result content item (user providing tool results). Accepts both 'function_response' (generateContent API) and 'function_result' (Interactions API) type values, and both 'response' and 'result' field names. GoogleGenerationConfig: properties: temperature: anyOf: - type: number maximum: 2.0 minimum: 0.0 - type: 'null' description: Sampling temperature. top_k: anyOf: - type: integer minimum: 1.0 - type: 'null' description: Top-k sampling parameter. top_p: anyOf: - type: number maximum: 1.0 minimum: 0.0 - type: 'null' description: Nucleus sampling parameter. max_output_tokens: anyOf: - type: integer minimum: 1.0 - type: 'null' description: Maximum number of tokens to generate. type: object title: GoogleGenerationConfig description: Generation parameters for the Interactions API. GoogleInputTurn: properties: role: type: string enum: - user - model title: Role content: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/GoogleTextContent' title: GoogleTextContent - $ref: '#/components/schemas/GoogleFunctionCallContent' title: GoogleFunctionCallContent - $ref: '#/components/schemas/GoogleFunctionResponseContent' title: GoogleFunctionResponseContent title: GoogleTextContent | GoogleFunctionCallContent | GoogleFunctionResponseContent type: array title: list[GoogleTextContent | GoogleFunctionCallContent | GoogleFunctionResponseContent] title: string | list[GoogleTextContent | GoogleFunctionCallContent | GoogleFunctionResponseContent] description: Content items for this turn. Can be a plain string or a list of content items. type: object required: - role - content title: GoogleInputTurn description: A conversation turn in the input. GoogleInteractionResponse: properties: id: type: string title: Id description: Unique interaction ID. created: anyOf: - type: string - type: 'null' description: Creation timestamp. status: type: string title: Status enum: - completed updated: anyOf: - type: string - type: 'null' description: Last update timestamp. model: type: string title: Model description: Model used for generation. outputs: items: oneOf: - $ref: '#/components/schemas/GoogleTextOutput' title: GoogleTextOutput - $ref: '#/components/schemas/GoogleFunctionCallOutput' title: GoogleFunctionCallOutput - $ref: '#/components/schemas/GoogleThoughtOutput' title: GoogleThoughtOutput discriminator: propertyName: type mapping: function_call: '#/components/schemas/GoogleFunctionCallOutput' text: '#/components/schemas/GoogleTextOutput' thought: '#/components/schemas/GoogleThoughtOutput' title: GoogleTextOutput | GoogleFunctionCallOutput | GoogleThoughtOutput type: array title: Outputs description: Response output items. role: type: string title: Role enum: - model usage: $ref: '#/components/schemas/GoogleUsage' object: type: string title: Object enum: - interaction type: object required: - id - model - outputs title: GoogleInteractionResponse description: Response from POST /v1alpha/interactions (non-streaming). GoogleTextContent: properties: type: type: string title: Type enum: - text text: type: string title: Text type: object required: - text title: GoogleTextContent description: A text content item. GoogleTextOutput: properties: type: type: string title: Type enum: - text text: type: string title: Text type: object required: - text title: GoogleTextOutput description: A text output item. GoogleThoughtOutput: properties: type: type: string title: Type enum: - thought signature: anyOf: - type: string - type: 'null' description: Signature for the thought block. additionalProperties: true type: object title: GoogleThoughtOutput description: A thought/reasoning output item (model's internal reasoning). GoogleTool: properties: type: type: string title: Type description: Tool type. default: function function_declarations: items: $ref: '#/components/schemas/GoogleFunctionDeclaration' type: array title: Function Declarations description: List of function declarations. additionalProperties: true type: object required: - function_declarations title: GoogleTool description: A tool containing function declarations. GoogleUsage: properties: total_input_tokens: type: integer title: Total Input Tokens default: 0 total_output_tokens: type: integer title: Total Output Tokens default: 0 total_tokens: type: integer title: Total Tokens default: 0 additionalProperties: true type: object title: GoogleUsage description: Token usage statistics. HealthStatus: type: string enum: - OK - Error - Not Implemented title: HealthStatus description: Health check status values for provider readiness. HybridSearchOptions: properties: embedding_weight: type: number minimum: 0.0 title: Embedding Weight description: The weight of the embedding in the reciprocal ranking fusion. text_weight: type: number minimum: 0.0 title: Text Weight description: The weight of the text in the reciprocal ranking fusion. type: object required: - embedding_weight - text_weight title: HybridSearchOptions description: |- Weights that balance embedding and keyword matches in hybrid search. Matches OpenAI's file_search `ranking_options.hybrid_search`. The weights are relative: they are normalized to sum to 1 and applied as weighted Reciprocal Rank Fusion. Vector stores whose provider cannot apply the weights reject the search with a 400 error. InputTokensDetails: properties: cached_tokens: type: integer title: Cached Tokens additionalProperties: true type: object required: - cached_tokens title: InputTokensDetails description: A detailed breakdown of the input tokens. 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 ListMessageBatchesResponse: properties: data: items: $ref: '#/components/schemas/MessageBatch' type: array title: Data description: List of MessageBatch objects. has_more: type: boolean title: Has More description: Whether there are more results available. 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. type: object required: - data - has_more title: ListMessageBatchesResponse description: Response from GET /v1/messages/batches. ListProcessFileJobsResponse: properties: data: items: $ref: '#/components/schemas/ProcessFileJob' type: array title: Data description: The list of file-processing jobs. has_more: type: boolean title: Has More description: Whether more jobs are available after this page. default: false type: object required: - data title: ListProcessFileJobsResponse description: Response model listing file-processing jobs. ListSkillVersionsResponse: properties: object: type: string title: Object enum: - list data: items: $ref: '#/components/schemas/SkillVersion' type: array title: Data description: List of skill version objects has_more: type: boolean title: Has More description: Whether there are more results default: false first_id: anyOf: - type: string - type: 'null' description: ID of the first item in the list last_id: anyOf: - type: string - type: 'null' description: ID of the last item in the list type: object required: - data title: ListSkillVersionsResponse description: Response from listing skill versions. ListSkillsResponse: properties: object: type: string title: Object enum: - list data: items: $ref: '#/components/schemas/Skill' type: array title: Data description: List of skill objects has_more: type: boolean title: Has More description: Whether there are more results default: false first_id: anyOf: - type: string - type: 'null' description: ID of the first item in the list last_id: anyOf: - type: string - type: 'null' description: ID of the last item in the list type: object required: - data title: ListSkillsResponse description: Response from listing skills. 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. MemoryToolConfig: properties: enabled: type: boolean title: Enabled description: Whether to retrieve memory context for this response. default: true owner_id: anyOf: - type: string - type: 'null' description: Fallback owner identifier used to scope memory retrieval when no authenticated user principal is available. vector_store_id: anyOf: - type: string - type: 'null' description: Memory vector store override. Defaults to the server memory vector store. max_num_results: anyOf: - type: integer maximum: 50.0 minimum: 1.0 - type: 'null' description: Maximum memory chunks to retrieve. max_context_tokens: anyOf: - type: integer minimum: 1.0 - type: 'null' description: Approximate token budget for injected memory context. filters: anyOf: - additionalProperties: true type: object - type: 'null' description: "Additional vector-store filters combined with the required owner filter. Use the vector store filter shape, such as {'type': 'eq', 'key': ..., 'value': ...} or {'type': 'and', 'filters': [...]}." ranking_options: anyOf: - $ref: '#/components/schemas/SearchRankingOptions' title: SearchRankingOptions - type: 'null' description: Ranking options for memory vector-store search. title: SearchRankingOptions additionalProperties: false type: object title: MemoryToolConfig description: Configuration for Responses memory retrieval. MessageBatch: properties: id: type: string title: Id description: Unique object identifier (msgbatch_ prefix). type: type: string title: Type enum: - message_batch processing_status: type: string enum: - in_progress - canceling - ended title: Processing Status description: Processing status of the Message Batch. request_counts: $ref: '#/components/schemas/MessageBatchRequestCounts' created_at: type: string title: Created At description: RFC 3339 datetime when the batch was created. expires_at: type: string title: Expires At description: RFC 3339 datetime when processing will expire. cancel_initiated_at: anyOf: - type: string - type: 'null' description: RFC 3339 datetime when cancellation was initiated. ended_at: anyOf: - type: string - type: 'null' description: RFC 3339 datetime when all processing ended. archived_at: anyOf: - type: string - type: 'null' description: RFC 3339 datetime when the batch was archived. results_url: anyOf: - type: string - type: 'null' description: URL to a .jsonl file containing the results. type: object required: - id - processing_status - created_at - expires_at title: MessageBatch description: A Message Batch object. MessageBatchRequestCounts: properties: processing: type: integer title: Processing description: Number of requests currently processing. default: 0 succeeded: type: integer title: Succeeded description: Number of successfully completed requests. default: 0 errored: type: integer title: Errored description: Number of requests that encountered an error. default: 0 canceled: type: integer title: Canceled description: Number of canceled requests. default: 0 expired: type: integer title: Expired description: Number of expired requests. default: 0 type: object title: MessageBatchRequestCounts description: Tallies of requests by their status within a batch. MessageBatchRequestParams: properties: custom_id: type: string maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_-]{1,64}$ title: Custom Id description: Developer-provided ID for matching results to requests. Must be unique within the batch. params: $ref: '#/components/schemas/AnthropicCreateMessageRequest' description: Messages API creation parameters for the individual request. type: object required: - custom_id - params title: MessageBatchRequestParams description: An individual request within a message batch. OpenAIAttachFileRequest: properties: file_id: type: string title: File Id description: The ID of the file to attach. options: anyOf: - additionalProperties: true type: object - type: 'null' description: Optional provider-specific file processing parameters. attributes: anyOf: - additionalProperties: anyOf: - type: string maxLength: 512 - type: number - type: boolean title: string | number | boolean propertyNames: type: string maxLength: 64 type: object maxProperties: 16 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 - 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 - $ref: '#/components/schemas/VectorStoreChunkingStrategyContextual' title: VectorStoreChunkingStrategyContextual discriminator: propertyName: type mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' contextual: '#/components/schemas/VectorStoreChunkingStrategyContextual' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic | VectorStoreChunkingStrategyContextual - 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. OpenAIChatCompletionCustomToolCallFunction: properties: name: type: string title: Name description: The name of the custom tool to call. input: type: string title: Input description: The input for the custom tool call generated by the model. type: object required: - name - input title: OpenAIChatCompletionCustomToolCallFunction description: Custom tool call details for OpenAI-compatible tool calls. OpenAIChatCompletionResponseMessage: properties: role: type: string title: Role description: The role of the message author, always 'assistant' in responses. enum: - assistant content: anyOf: - type: string - type: 'null' description: The content of the message. tool_calls: items: anyOf: - $ref: '#/components/schemas/ChatCompletionMessageToolCall' title: ChatCompletionMessageToolCall - $ref: '#/components/schemas/ChatCompletionMessageCustomToolCall' title: ChatCompletionMessageCustomToolCall discriminator: propertyName: type title: ChatCompletionMessageToolCall | ChatCompletionMessageCustomToolCall type: array title: Tool Calls description: The tool calls generated by the model. refusal: anyOf: - type: string - type: 'null' description: The refusal message generated by the model. function_call: properties: name: type: string title: Name description: Name of the function to call. arguments: type: string title: Arguments description: Arguments to pass to the function as a JSON string. type: object required: - name - arguments description: 'Deprecated: the name and arguments of a function that should be called.' annotations: items: additionalProperties: true type: object type: array title: Annotations description: Annotations for the message, when applicable. audio: anyOf: - additionalProperties: true type: object - type: 'null' description: Audio response data when using audio output modality. type: object title: OpenAIChatCompletionResponseMessage description: An assistant message returned in a chat completion response. OpenAIChatCompletionUsageCompletionTokensDetails: properties: reasoning_tokens: type: integer minimum: 0.0 title: Reasoning Tokens description: Number of tokens used for reasoning (o1/o3 models). default: 0 type: object title: OpenAIChatCompletionUsageCompletionTokensDetails description: Token details for output tokens in OpenAI chat completion usage. OpenAIChatCompletionUsagePromptTokensDetails: properties: cached_tokens: type: integer minimum: 0.0 title: Cached Tokens description: Number of tokens retrieved from cache. default: 0 type: object title: OpenAIChatCompletionUsagePromptTokensDetails description: Token details for prompt tokens in OpenAI chat completion usage. OpenAICompactedResponse: properties: id: type: string title: Id created_at: type: integer title: Created At object: type: string title: Object enum: - response.compaction default: response.compaction output: items: $ref: '#/components/schemas/OpenAIResponseMessageOutputUnion' type: array title: Output usage: $ref: '#/components/schemas/OpenAIResponseUsage' type: object required: - id - created_at - output - usage title: OpenAICompactedResponse description: Response from compacting a conversation. OpenAIFileUploadPurpose: type: string enum: - assistants - batch - fine-tune - vision - user_data - evals title: OpenAIFileUploadPurpose description: Valid purpose values for the OpenAI Files upload endpoint. OpenAIResponseCompaction: properties: type: type: string title: Type enum: - compaction encrypted_content: type: string title: Encrypted Content id: anyOf: - type: string - type: 'null' type: object required: - encrypted_content title: OpenAIResponseCompaction description: A compaction item that summarizes prior conversation context. OpenAIResponseIncompleteDetails: properties: reason: type: string title: Reason type: object required: - reason title: OpenAIResponseIncompleteDetails description: Details explaining why a response was incomplete. 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 title: Type enum: - 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 title: Type enum: - 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 title: Type enum: - 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 title: Type enum: - 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 title: Type enum: - 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 description: Enumeration of simple tool choice modes for response generation. OpenAIResponseInputToolChoiceWebSearch: properties: type: anyOf: - type: string enum: - web_search - type: string enum: - web_search_preview - type: string enum: - web_search_preview_2025_03_11 - type: string enum: - web_search_2025_08_26 title: string default: web_search type: object title: OpenAIResponseInputToolChoiceWebSearch description: Indicates that the model should use web search to generate a response OpenAIResponseInputToolNamespace: properties: type: type: string title: Type enum: - namespace name: type: string minLength: 1 title: Name description: type: string title: Description tools: items: $ref: '#/components/schemas/OpenAIResponseInputToolFunction' type: array minItems: 1 title: Tools type: object required: - name - description - tools title: OpenAIResponseInputToolNamespace description: Namespace tool configuration grouping function tools under a shared name. 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. OpenAIResponseOutputMessageReasoningContent: properties: text: type: string title: Text description: The reasoning text content from the model. type: type: string title: Type description: The type identifier, always 'reasoning_text'. enum: - reasoning_text type: object required: - text title: OpenAIResponseOutputMessageReasoningContent description: Reasoning text from the model. OpenAIResponseOutputMessageReasoningItem: properties: id: type: string title: Id description: Unique identifier for the reasoning output item. summary: items: $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningSummary' type: array title: Summary description: Summary of the reasoning output. type: type: string title: Type description: The type identifier, always 'reasoning'. enum: - reasoning content: anyOf: - items: $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningContent' type: array - type: 'null' description: The reasoning content from the model. status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' description: The status of the reasoning output. type: object required: - id - summary title: OpenAIResponseOutputMessageReasoningItem description: Reasoning output from the model, representing the model's thinking process. OpenAIResponseOutputMessageReasoningSummary: properties: text: type: string title: Text description: The summary text of the reasoning output. type: type: string title: Type description: The type identifier, always 'summary_text'. enum: - summary_text type: object required: - text title: OpenAIResponseOutputMessageReasoningSummary description: A summary of reasoning output from the model. OpenAIResponseReasoning: properties: effort: anyOf: - type: string enum: - none - minimal - low - medium - high - xhigh - type: 'null' generate_summary: anyOf: - type: string enum: - auto - concise - detailed - type: 'null' description: "Deprecated: use 'summary' instead." deprecated: true summary: anyOf: - type: string enum: - auto - concise - detailed - type: 'null' description: Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'. 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: anyOf: - type: string enum: - text - type: string enum: - json_schema - type: string enum: - json_object title: string 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: type: integer maximum: 50.0 minimum: 1.0 title: Max Num Results 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: type: boolean title: Rewrite Query 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: - $ref: '#/components/schemas/VectorStoreExpirationAfter' title: VectorStoreExpirationAfter - type: 'null' description: Expiration policy for the vector store. title: VectorStoreExpirationAfter 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. OutputTokensDetails: properties: reasoning_tokens: type: integer title: Reasoning Tokens additionalProperties: true type: object required: - reasoning_tokens title: OutputTokensDetails description: A detailed breakdown of the output tokens. ProcessFileJob: properties: job_id: type: string title: Job Id description: Unique identifier for the job. status: $ref: '#/components/schemas/JobStatus' description: Current execution status of the job. created_at: type: integer title: Created At description: Unix timestamp (seconds) for when the job was created. result: anyOf: - $ref: '#/components/schemas/ProcessFileResponse' title: ProcessFileResponse - type: 'null' description: The processed file result. Present only once the job has completed successfully. title: ProcessFileResponse error: anyOf: - type: string - type: 'null' description: Error message. Present only if the job failed. type: object required: - job_id - status - created_at title: ProcessFileJob description: |- An asynchronous file-processing job. Returned when a file is submitted for processing via the job-based API. Poll by job_id until ``status`` is terminal (completed/failed/cancelled). When completed, ``result`` holds the processed chunks; when failed, ``error`` explains why. ProcessFileResponse: properties: chunks: items: $ref: '#/components/schemas/Chunk' type: array title: Chunks description: Processed chunks from the file. Always returns at least one chunk. metadata: additionalProperties: true type: object title: Metadata 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. type: object required: - chunks - metadata title: 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. 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. ResponseStreamOptions: properties: include_obfuscation: type: boolean title: Include Obfuscation description: Whether to obfuscate sensitive information in streamed output. type: object title: ResponseStreamOptions description: Options that control streamed response behavior. ResponseTruncation: type: string enum: - auto - disabled title: ResponseTruncation description: Controls how the service truncates input when it exceeds the model context window. SearchRankingOptions: properties: ranker: anyOf: - type: string - type: 'null' description: Name of the ranking algorithm. Supported values are "weighted", "rrf", "neural", and "classifier". Other string values are accepted for OpenAI API compatibility but are not supported. 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 hybrid_search: anyOf: - $ref: '#/components/schemas/HybridSearchOptions' title: HybridSearchOptions - type: 'null' description: Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches. Setting it selects hybrid search, and score_threshold then applies to the fused reciprocal rank fusion scores. Vector stores whose provider cannot apply the weights reject the search with a 400 error, which fails the whole request when the search is a Responses file_search or memory retrieval. title: HybridSearchOptions 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) ServiceTier: type: string enum: - auto - default - flex - priority title: ServiceTier description: The service tier for the request. 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. Skill: properties: id: type: string title: Id description: Unique identifier for the skill created_at: type: integer title: Created At description: Unix timestamp when the skill was created default_version: type: string title: Default Version description: Version used when no version is specified default: '1' description: type: string title: Description description: Description of what the skill does latest_version: type: string title: Latest Version description: Most recently uploaded version number default: '1' name: type: string title: Name description: Human-readable name from SKILL.md frontmatter object: type: string title: Object enum: - skill type: object required: - id - created_at - description - name title: Skill description: A skill resource. Matches OpenAI Skill wire format. SkillDeleteResponse: properties: id: type: string title: Id description: ID of the deleted skill deleted: type: boolean title: Deleted description: Whether the skill was successfully deleted default: true object: type: string title: Object enum: - skill.deleted type: object required: - id title: SkillDeleteResponse description: Response from deleting a skill. Matches OpenAI DeletedSkill wire format. SkillUpdateRequest: properties: default_version: type: string title: Default Version description: Version number to set as the default type: object required: - default_version title: SkillUpdateRequest description: Request to update a skill's default version. SkillVersion: properties: id: type: string title: Id description: Unique identifier for this version created_at: type: integer title: Created At description: Unix timestamp when this version was created description: type: string title: Description description: Description of the skill version name: type: string title: Name description: Name of the skill version object: type: string title: Object enum: - skill.version skill_id: type: string title: Skill Id description: ID of the parent skill version: type: string title: Version description: Version number as a string type: object required: - id - created_at - description - name - skill_id - version title: SkillVersion description: A specific version of a skill. Matches OpenAI SkillVersion wire format. SkillVersionDeleteResponse: properties: id: type: string title: Id description: ID of the deleted skill deleted: type: boolean title: Deleted description: Whether the version was successfully deleted default: true object: type: string title: Object enum: - skill.version.deleted version: type: string title: Version description: Version that was deleted type: object required: - id - version title: SkillVersionDeleteResponse description: Response from deleting a skill version. Matches OpenAI DeletedSkillVersion wire format. SystemOneChoiceAnswer: properties: type: type: string title: Type enum: - choice choice: type: string title: Choice description: The selected option name, one of the question's `criteria` keys. probabilities: additionalProperties: type: number type: object title: Probabilities description: Probability assigned to each option. confidence: type: number maximum: 1.0 minimum: 0.0 title: Confidence description: Overall confidence in `choice`. additionalProperties: false type: object required: - choice - probabilities - confidence title: SystemOneChoiceAnswer description: Answer to a `choice` question. SystemOneChoiceQuestion: properties: type: type: string title: Type enum: - choice instructions: anyOf: - type: string - additionalProperties: true type: object - items: {} type: array title: array - type: 'null' title: string | object | array description: The question to answer about `state`. criteria: additionalProperties: anyOf: - type: string - additionalProperties: true type: object - items: {} type: array title: array - type: 'null' title: string | object | array type: object maxProperties: 255 title: Criteria description: Option name -> description (string, object, array, or null). Up to 255 options. additionalProperties: false type: object required: - criteria title: SystemOneChoiceQuestion description: A question answered by picking one of up to 255 named options. SystemOneNoulAnswer: properties: type: type: string title: Type enum: - noul noul: type: number maximum: 1.0 minimum: 0.0 title: Noul description: Calibrated probability that the answer is true. additionalProperties: false type: object required: - noul title: SystemOneNoulAnswer description: Answer to a `noul` question. SystemOneNoulCriteria: properties: 'true': anyOf: - type: string - additionalProperties: true type: object - items: {} type: array title: array - type: 'null' title: string | object | array description: What a yes (value near 1) means. 'false': anyOf: - type: string - additionalProperties: true type: object - items: {} type: array title: array - type: 'null' title: string | object | array description: What a no (value near 0) means. additionalProperties: false type: object title: SystemOneNoulCriteria description: Optional descriptions of the yes and no outcomes of a `noul` question. SystemOneNoulQuestion: properties: type: type: string title: Type enum: - noul instructions: anyOf: - type: string - additionalProperties: true type: object - items: {} type: array title: array - type: 'null' title: string | object | array description: The question to answer about `state`. criteria: anyOf: - $ref: '#/components/schemas/SystemOneNoulCriteria' title: SystemOneNoulCriteria - type: 'null' description: Optional descriptions of the true/false outcomes. title: SystemOneNoulCriteria additionalProperties: false type: object title: SystemOneNoulQuestion description: A yes/no question, answered with a calibrated probability. SystemOneRequest: properties: model: type: string title: Model description: The decision model to use for judgment. state: anyOf: - type: string - additionalProperties: true type: object - items: {} type: array title: array title: string | object | array description: The context the questions are evaluated against. questions: additionalProperties: oneOf: - $ref: '#/components/schemas/SystemOneNoulQuestion' title: SystemOneNoulQuestion - $ref: '#/components/schemas/SystemOneChoiceQuestion' title: SystemOneChoiceQuestion - $ref: '#/components/schemas/SystemOneScoreQuestion' title: SystemOneScoreQuestion discriminator: propertyName: type mapping: choice: '#/components/schemas/SystemOneChoiceQuestion' noul: '#/components/schemas/SystemOneNoulQuestion' score: '#/components/schemas/SystemOneScoreQuestion' title: SystemOneNoulQuestion | SystemOneChoiceQuestion | SystemOneScoreQuestion type: object minProperties: 1 title: Questions description: Questions to answer about `state`, keyed by caller-chosen name. additionalProperties: false type: object required: - model - state - questions title: SystemOneRequest description: Request body for POST /v1/systemone. SystemOneResponse: properties: model: type: string title: Model description: The decision model that produced the answers. answers: additionalProperties: oneOf: - $ref: '#/components/schemas/SystemOneNoulAnswer' title: SystemOneNoulAnswer - $ref: '#/components/schemas/SystemOneChoiceAnswer' title: SystemOneChoiceAnswer - $ref: '#/components/schemas/SystemOneScoreAnswer' title: SystemOneScoreAnswer discriminator: propertyName: type mapping: choice: '#/components/schemas/SystemOneChoiceAnswer' noul: '#/components/schemas/SystemOneNoulAnswer' score: '#/components/schemas/SystemOneScoreAnswer' title: SystemOneNoulAnswer | SystemOneChoiceAnswer | SystemOneScoreAnswer type: object title: Answers description: Answers to the request's questions, keyed by the same names. usage: $ref: '#/components/schemas/SystemOneUsage' description: Token usage for this call. additionalProperties: false type: object required: - model - answers title: SystemOneResponse description: Response body for POST /v1/systemone. SystemOneScoreAnswer: properties: type: type: string title: Type enum: - score score: type: number title: Score description: Probability-weighted score across the rubric's ordered levels; can land between levels. legend: additionalProperties: anyOf: - type: string - additionalProperties: true type: object - items: {} type: array title: array title: string | object | array type: object title: Legend description: Each level (string key) mapped back to its description. probabilities: additionalProperties: type: number type: object title: Probabilities description: Probability assigned to each rubric level. confidence: type: number maximum: 1.0 minimum: 0.0 title: Confidence description: Overall confidence in `score`. additionalProperties: false type: object required: - score - legend - probabilities - confidence title: SystemOneScoreAnswer description: Answer to a `score` question. SystemOneScoreQuestion: properties: type: type: string title: Type enum: - score instructions: anyOf: - type: string - additionalProperties: true type: object - items: {} type: array title: array - type: 'null' title: string | object | array description: The question to answer about `state`. criteria: items: anyOf: - type: string - additionalProperties: true type: object - items: {} type: array title: array title: string | object | array type: array maxItems: 10 minItems: 1 title: Criteria description: Ordered list of level descriptions, one per score from zero. additionalProperties: false type: object required: - criteria title: SystemOneScoreQuestion description: A question answered against an ordered rubric of 1-10 levels. SystemOneUsage: properties: input_tokens: type: integer minimum: 0.0 title: Input Tokens description: Number of tokens in `state` and the questions. default: 0 output_tokens: type: integer minimum: 0.0 title: Output Tokens description: Number of tokens used to produce the answers. default: 0 additionalProperties: false type: object title: SystemOneUsage description: Token usage for a SystemOne judgment call. 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. VectorStoreChunkingStrategyContextual: properties: type: type: string title: Type description: Strategy type identifier. enum: - contextual contextual: $ref: '#/components/schemas/VectorStoreChunkingStrategyContextualConfig' description: Configuration for contextual chunking. type: object required: - contextual title: VectorStoreChunkingStrategyContextual description: Contextual chunking strategy that uses an LLM to situate chunks within the document. VectorStoreChunkingStrategyContextualConfig: properties: model_id: anyOf: - type: string minLength: 1 - type: 'null' description: LLM model for generating context. Falls back to VectorStoresConfig.contextual_retrieval_params.model if not provided. context_prompt: type: string title: Context Prompt description: Prompt template for contextual retrieval. Uses WHOLE_DOCUMENT and CHUNK_CONTENT placeholders wrapped in double curly braces. max_chunk_size_tokens: type: integer maximum: 4096.0 minimum: 100.0 title: Max Chunk Size Tokens description: Maximum tokens per chunk. Suggested ~700 to allow room for prepended context. default: 700 chunk_overlap_tokens: type: integer minimum: 0.0 title: Chunk Overlap Tokens description: Tokens to overlap between adjacent chunks. Must be less than max_chunk_size_tokens. default: 400 timeout_seconds: anyOf: - type: integer minimum: 1.0 - type: 'null' description: Timeout per LLM call in seconds. Falls back to config default if not provided. max_concurrency: anyOf: - type: integer minimum: 1.0 - type: 'null' description: Maximum concurrent LLM calls. Falls back to config default if not provided. type: object title: VectorStoreChunkingStrategyContextualConfig description: Configuration for contextual chunking that uses an LLM to situate chunks within the document. VectorStoreExpirationAfter: properties: anchor: type: string title: Anchor description: Anchor timestamp after which the expiration policy applies. enum: - last_active_at days: type: integer maximum: 365.0 minimum: 1.0 title: Days description: The number of days after the anchor time that the vector store will expire. type: object required: - anchor - days title: VectorStoreExpirationAfter description: Expiration policy for a vector store. VectorStoreFileBatchFileEntry: properties: file_id: type: string title: File Id chunking_strategy: anyOf: - oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic - $ref: '#/components/schemas/VectorStoreChunkingStrategyContextual' title: VectorStoreChunkingStrategyContextual discriminator: propertyName: type mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' contextual: '#/components/schemas/VectorStoreChunkingStrategyContextual' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic | VectorStoreChunkingStrategyContextual - type: 'null' title: Chunking Strategy attributes: anyOf: - additionalProperties: anyOf: - type: string maxLength: 512 - type: number - type: boolean title: string | number | boolean propertyNames: type: string maxLength: 64 type: object maxProperties: 16 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 - type: 'null' type: object required: - file_id title: VectorStoreFileBatchFileEntry description: A file entry for creating a vector store file batch with per-file options. WebSearchActionFind: properties: type: type: string title: Type enum: - find_in_page url: type: string title: Url pattern: type: string title: Pattern type: object required: - url - pattern title: WebSearchActionFind description: 'Web search action: searches for a pattern within a loaded page.' WebSearchActionOpenPage: properties: type: type: string title: Type enum: - open_page url: anyOf: - type: string - type: 'null' type: object title: WebSearchActionOpenPage description: 'Web search action: opens a specific URL from search results.' WebSearchActionSearch: properties: type: type: string title: Type enum: - search query: type: string title: Query queries: anyOf: - items: type: string type: array - type: 'null' sources: anyOf: - items: $ref: '#/components/schemas/WebSearchSource' type: array - type: 'null' type: object required: - query title: WebSearchActionSearch description: 'Web search action: performs a search query.' WebSearchFilters: properties: allowed_domains: anyOf: - items: type: string type: array - type: 'null' type: object title: WebSearchFilters description: Domain filters for web search results. WebSearchSource: properties: type: type: string title: Type enum: - url url: type: string title: Url type: object required: - url title: WebSearchSource description: A source URL returned by a web search action. WebSearchUserLocation: properties: type: type: string title: Type enum: - approximate city: anyOf: - type: string - type: 'null' country: anyOf: - type: string - type: 'null' region: anyOf: - type: string - type: 'null' timezone: anyOf: - type: string - type: 'null' type: object title: WebSearchUserLocation description: Approximate user location to refine web search results. _ToolChoiceAny: properties: type: type: string title: Type enum: - any disable_parallel_tool_use: anyOf: - type: boolean - type: 'null' type: object title: _ToolChoiceAny _ToolChoiceAuto: properties: type: type: string title: Type enum: - auto disable_parallel_tool_use: anyOf: - type: boolean - type: 'null' type: object title: _ToolChoiceAuto _ToolChoiceNone: properties: type: type: string title: Type enum: - none type: object title: _ToolChoiceNone _ToolChoiceTool: properties: type: type: string title: Type enum: - tool name: type: string title: Name disable_parallel_tool_use: anyOf: - type: boolean - type: 'null' type: object required: - name title: _ToolChoiceTool _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 _WebSearchUserLocation: properties: type: type: string title: Type enum: - approximate city: anyOf: - type: string - type: 'null' country: anyOf: - type: string - type: 'null' region: anyOf: - type: string - type: 'null' timezone: anyOf: - type: string - type: 'null' type: object title: _WebSearchUserLocation GreedySamplingStrategy: description: Greedy sampling strategy that selects the highest probability token at each step. properties: type: description: Must be 'greedy' to identify this sampling strategy. title: Type type: string enum: - greedy title: GreedySamplingStrategy type: object TopKSamplingStrategy: description: Top-k sampling strategy that restricts sampling to the k most likely tokens. properties: type: description: Must be 'top_k' to identify this sampling strategy. title: Type type: string enum: - top_k top_k: description: Number of top tokens to consider for sampling. Must be at least 1. minimum: 1 title: Top K type: integer required: - top_k title: TopKSamplingStrategy type: object TopPSamplingStrategy: description: Top-p (nucleus) sampling strategy that samples from the smallest set of tokens with cumulative probability >= p. properties: type: description: Must be 'top_p' to identify this sampling strategy. title: Type type: string enum: - top_p temperature: description: Controls randomness in sampling. Higher values increase randomness. maximum: 2.0 title: Temperature type: number minimum: 0.0 top_p: default: 0.95 description: Cumulative probability threshold for nucleus sampling. maximum: 1.0 minimum: 0.0 title: Top P type: number required: - temperature title: TopPSamplingStrategy type: object 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: description: Must be 'grammar' to identify this format type. title: Type type: string enum: - grammar 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: description: Must be 'json_schema' to identify this format type. title: Type type: string enum: - json_schema 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: description: Configuration specifying which tools are allowed and their selection mode. 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: description: Configuration for a function tool specifying the function name. 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: description: Must be 'allowed_tools' to indicate allowed tools response format. title: Type type: string enum: - allowed_tools 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: description: Must be 'custom' to indicate custom tool choice. title: Type type: string enum: - custom 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: description: Must be 'function' to indicate function tool choice. title: Type type: string enum: - function 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 VectorStoreStatus: enum: - expired - in_progress - completed 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 OpenAIResponseObjectStreamError: description: |- Standalone error event emitted during streaming when an error occurs. This is distinct from response.failed which is a response lifecycle event. The error event signals transport/infrastructure-level errors to the client. properties: code: anyOf: - type: string - type: 'null' nullable: true message: title: Message type: string param: anyOf: - type: string - type: 'null' nullable: true sequence_number: title: Sequence Number type: integer type: title: Type type: string enum: - error required: - message - sequence_number title: OpenAIResponseObjectStreamError type: object TextDelta: description: A text content delta for streaming responses. properties: type: title: Type type: string enum: - text text: title: Text type: string required: - text title: TextDelta type: object ImageDelta: description: An image content delta for streaming responses. properties: type: title: Type type: string enum: - image 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: description: The unique identifier for the tool group. title: Toolgroup Id type: string provider_id: description: The ID of the provider that serves this tool group. title: Provider Id type: string args: anyOf: - additionalProperties: true type: object - type: 'null' description: Additional arguments to pass to the provider. nullable: true mcp_endpoint: anyOf: - $ref: '#/components/schemas/URL' title: URL - type: 'null' description: Model Context Protocol endpoint URL for remote tool groups. nullable: true title: URL required: - toolgroup_id - provider_id title: ToolGroupInput type: object ListToolsRequest: description: Request model for listing tools. properties: toolgroup_id: anyOf: - type: string - type: 'null' description: The ID of the tool group to filter tools by. nullable: true title: ListToolsRequest 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 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 AnthropicModelInfo: description: |- Anthropic model info response object. :id: Unique model identifier properties: id: description: Unique model identifier. title: Id type: string type: description: Object type, always 'model'. title: Type type: string enum: - model display_name: description: A human-readable name for the model. title: Display Name type: string created_at: description: RFC 3339 datetime string representing when the model was released. title: Created At type: string max_input_tokens: anyOf: - type: integer - type: 'null' description: Maximum input context window size in tokens. nullable: true max_tokens: anyOf: - type: integer - type: 'null' description: Maximum value for the max_tokens parameter when using this model. nullable: true required: - id - display_name - created_at title: AnthropicModelInfo type: object AnthropicListModelsResponse: description: Response containing a list of Anthropic model objects. properties: data: description: List of Anthropic model objects. items: $ref: '#/components/schemas/AnthropicModelInfo' title: Data type: array has_more: default: false description: Whether there are more results in the requested page direction. title: Has More type: boolean first_id: anyOf: - type: string - type: 'null' description: First ID in the data list, usable as before_id for the previous page. nullable: true last_id: anyOf: - type: string - type: 'null' description: Last ID in the data list, usable as after_id for the next page. nullable: true required: - data title: AnthropicListModelsResponse type: object GoogleModelInfo: description: |- Google model info response object. :name: Model resource name, e.g. 'models/gemini-pro' :display_name: A human-readable name for the model :description: A description of the model properties: name: description: Model resource name, e.g. 'models/gemini-pro'. title: Name type: string display_name: description: A human-readable name for the model. title: Display Name type: string description: default: '' description: A description of the model. title: Description type: string required: - name - display_name title: GoogleModelInfo type: object GoogleListModelsResponse: description: Response containing a list of Google model objects. properties: models: description: List of Google model objects. items: $ref: '#/components/schemas/GoogleModelInfo' title: Models type: array required: - models title: GoogleListModelsResponse type: object TypeSafeModelInfo: description: |- A model in TypeSafe's ``GET /v1/models`` response shape. :name: Model name or alias accepted by the ``model`` field of a SystemOne request :description: Human-readable description of the model and its capabilities :release_date: Model release date, formatted as YYYY-MM-DD properties: name: description: Model name or alias accepted by a SystemOne request's model field. title: Name type: string description: default: '' description: Human-readable description of the model and its capabilities. title: Description type: string release_date: default: '' description: Model release date, formatted as YYYY-MM-DD. title: Release Date type: string required: - name title: TypeSafeModelInfo type: object TypeSafeListModelsResponse: description: Response containing a list of TypeSafe model objects (SystemOne judgment models). properties: models: description: List of SystemOne (judgment) model objects. items: $ref: '#/components/schemas/TypeSafeModelInfo' title: Models type: array required: - models title: TypeSafeListModelsResponse 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 Api: description: Enumeration of all available APIs in the OGX system. enum: - providers - inference - responses - batches - vector_io - tool_runtime - container_runtime - models - vector_stores - tool_groups - files - file_processors - prompts - conversations - connectors - containers - messages - interactions - skills - inspect - admin title: Api type: string ProviderSpec: description: Base specification for a OGX provider including its config and dependencies. 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 toolgroup_id: anyOf: - type: string - type: 'null' description: For tool_runtime providers, the built-in tool group ID this provider serves (e.g. 'builtin::websearch'). nullable: true deps__: items: type: string title: Deps type: array required: - api - provider_type - config_class title: ProviderSpec type: object InlineProviderSpec: description: Provider specification for inline (built-in) providers with optional container support. 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 toolgroup_id: anyOf: - type: string - type: 'null' description: For tool_runtime providers, the built-in tool group ID this provider serves (e.g. 'builtin::websearch'). nullable: true 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 execution_mode: default: inline description: |2 How this provider's work is executed. 'inline' runs the implementation in the server process (default, unchanged behavior). 'worker' runs the implementation in a separate worker process via the job queue, so long or large operations do not block the server. enum: - inline - worker title: Execution Mode 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 title: InlineProviderSpec type: object RemoteProviderSpec: description: Provider specification for remote providers accessed via an adapter. 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 toolgroup_id: anyOf: - type: string - type: 'null' description: For tool_runtime providers, the built-in tool group ID this provider serves (e.g. 'builtin::websearch'). nullable: true 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 PaginatedResponse: description: A generic paginated response that follows a simple format. properties: data: items: additionalProperties: true type: object title: Data type: array has_more: title: Has More type: boolean url: anyOf: - type: string - type: 'null' nullable: true required: - data - has_more title: PaginatedResponse 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 SamplingParams: description: Sampling parameters for text generation. properties: strategy: description: The sampling strategy to use. 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 max_tokens: anyOf: - minimum: 1 type: integer - 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. nullable: true repetition_penalty: anyOf: - maximum: 2.0 minimum: -2.0 type: number - type: 'null' default: 1.0 description: Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far. stop: anyOf: - items: type: string maxItems: 4 type: array - type: 'null' description: Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence. nullable: true title: SamplingParams type: object Fp8QuantizationConfig: description: Configuration for 8-bit floating point quantization. properties: type: description: Must be 'fp8_mixed' to identify this quantization type. title: Type type: string enum: - fp8_mixed title: Fp8QuantizationConfig type: object Bf16QuantizationConfig: description: Configuration for BFloat16 precision (typically no quantization). properties: type: description: Must be 'bf16' to identify this quantization type. title: Type type: string enum: - bf16 title: Bf16QuantizationConfig type: object Int4QuantizationConfig: description: Configuration for 4-bit integer quantization. properties: type: description: Must be 'int4' to identify this quantization type. title: Type type: string enum: - int4_mixed 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: description: Must be 'user' to identify this as a user message. title: Role type: string enum: - user 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 OGX 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 SystemMessage: description: A system message providing instructions or context to the model. properties: role: description: Must be 'system' to identify this as a system message. title: Role type: string enum: - system 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 'system prompt'. If multiple system messages are provided, they are concatenated. The underlying OGX code may also add other system messages. title: string | list[ImageContentItem | TextContentItem] required: - content title: SystemMessage type: object ToolResponseMessage: description: A message representing the result of a tool invocation. properties: role: description: Must be 'tool' to identify this as a tool response. title: Role type: string enum: - tool 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 ListChatCompletionMessagesRequest: description: Request model for listing messages in a stored chat completion. properties: completion_id: description: The ID of the chat completion to retrieve messages from. title: Completion Id type: string after: anyOf: - type: string - type: 'null' description: Identifier for the last message from the previous pagination request. nullable: true limit: anyOf: - minimum: 1 type: integer - type: 'null' default: 20 description: Number of messages to retrieve. order: anyOf: - $ref: '#/components/schemas/Order' title: Order - type: 'null' default: asc description: Sort order for messages by timestamp. Use "asc" or "desc". Defaults to "asc". title: Order required: - completion_id title: ListChatCompletionMessagesRequest type: object VectorStoreCreateRequest: description: Request to create a vector store. properties: name: anyOf: - type: string - type: 'null' nullable: true description: anyOf: - type: string - type: 'null' nullable: true file_ids: items: type: string title: File Ids type: array expires_after: anyOf: - $ref: '#/components/schemas/VectorStoreExpirationAfter' title: VectorStoreExpirationAfter - type: 'null' nullable: true title: VectorStoreExpirationAfter chunking_strategy: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true metadata: anyOf: - additionalProperties: true type: object - type: 'null' nullable: true title: VectorStoreCreateRequest type: object VectorStoreModifyRequest: description: Request to modify a vector store. properties: name: anyOf: - type: string - type: 'null' nullable: true expires_after: anyOf: - $ref: '#/components/schemas/VectorStoreExpirationAfter' title: VectorStoreExpirationAfter - type: 'null' nullable: true title: VectorStoreExpirationAfter 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 maximum: 50 minimum: 1 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 ChunkForDeletion: description: Information needed to delete a chunk from a vector store. properties: chunk_id: title: Chunk Id type: string document_id: title: Document Id type: string required: - chunk_id - document_id title: ChunkForDeletion type: object DeleteChunksRequest: description: Request body for deleting chunks from a vector store. properties: vector_store_id: description: The ID of the vector store to delete chunks from. title: Vector Store Id type: string chunks: description: The list of chunks to delete. items: $ref: '#/components/schemas/ChunkForDeletion' title: Chunks type: array required: - vector_store_id - chunks title: DeleteChunksRequest 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 Job: description: A job execution instance with status tracking. properties: job_id: title: Job Id type: string status: $ref: '#/components/schemas/JobStatus' required: - job_id - status title: Job type: object DialogType: description: Parameter type for dialog data with semantic output labels. properties: type: title: Type type: string enum: - dialog title: DialogType type: object ContainerExpiresAfter: description: |- Control expiration of a container. Anchored on ``last_active_at`` (each shell execution or file operation refreshes the anchor). Operator-set bounds protect the host from long-lived sandboxes. properties: anchor: description: The anchor point for expiration. Must be 'last_active_at'. title: Anchor type: string enum: - last_active_at minutes: description: Minutes of inactivity after the anchor before the container expires. maximum: 1440 minimum: 1 title: Minutes type: integer required: - minutes title: ContainerExpiresAfter type: object NetworkCredential: description: |- A named credential available to outbound network calls. The ``value`` should be a secret reference (e.g. ``${env.MY_SECRET}``) in operator-supplied configuration, never a raw secret in a request body. properties: name: description: Logical name used by the container to look up the credential. title: Name type: string value: description: Secret reference or literal value to be injected into the container. format: password title: Value type: string writeOnly: true required: - name - value title: NetworkCredential type: object NetworkDomainCredential: description: Bind a ``NetworkCredential`` to a specific outbound domain. properties: domain: description: Fully-qualified domain name to which the credential applies. title: Domain type: string credential: $ref: '#/components/schemas/NetworkCredential' description: Credential injected on outbound calls to this domain. required: - domain - credential title: NetworkDomainCredential type: object NetworkPolicyMode: description: Egress policy mode applied to a container's outbound network. enum: - deny - allow_list - allow_all title: NetworkPolicyMode type: string NetworkPolicy: description: |- Operator-set egress policy for a container. A NetworkPolicy is the *upper bound* — request-supplied ``NetworkPolicyExtended`` values may only narrow this policy. properties: mode: $ref: '#/components/schemas/NetworkPolicyMode' default: deny description: Default egress disposition. 'deny' blocks all egress except entries in 'allow_domains'. allow_domains: description: Domains permitted for outbound traffic. Used when mode is 'allow_list'. items: type: string title: Allow Domains type: array deny_domains: description: Domains explicitly blocked. Takes precedence over 'allow_domains'. items: type: string title: Deny Domains type: array title: NetworkPolicy type: object NetworkPolicyExtended: description: |- Request-layer extension of an operator NetworkPolicy. The request may add domain credentials and narrow allow/deny lists, but cannot expand the operator default — enforcement is performed at the API layer; see issue #5892 task 8. properties: mode: $ref: '#/components/schemas/NetworkPolicyMode' default: deny description: Default egress disposition. 'deny' blocks all egress except entries in 'allow_domains'. allow_domains: description: Domains permitted for outbound traffic. Used when mode is 'allow_list'. items: type: string title: Allow Domains type: array deny_domains: description: Domains explicitly blocked. Takes precedence over 'allow_domains'. items: type: string title: Deny Domains type: array domain_credentials: description: Per-domain credentials injected on outbound calls from this container. items: $ref: '#/components/schemas/NetworkDomainCredential' title: Domain Credentials type: array title: NetworkPolicyExtended type: object ContainerStatus: description: Lifecycle status of a container. enum: - active - expired title: ContainerStatus type: string Container: description: |- A sandboxed execution environment. Mirrors the OpenAI Containers API resource with OGX-specific extensions for network policy and image selection. properties: id: description: Identifier for the container. title: Id type: string object: description: The object type, which is always 'container'. title: Object type: string enum: - container created_at: description: Unix timestamp (in seconds) for when the container was created. title: Created At type: integer status: $ref: '#/components/schemas/ContainerStatus' description: Current lifecycle status. last_active_at: description: Unix timestamp (in seconds) of the last operation performed against this container. title: Last Active At type: integer name: anyOf: - type: string - type: 'null' description: Human-readable name for the container. nullable: true expires_after: anyOf: - $ref: '#/components/schemas/ContainerExpiresAfter' title: ContainerExpiresAfter - type: 'null' description: Inactivity-based expiration settings. nullable: true title: ContainerExpiresAfter image: anyOf: - type: string - type: 'null' description: Container image used to run the sandbox. May be operator-locked. nullable: true network_policy: anyOf: - $ref: '#/components/schemas/NetworkPolicy' title: NetworkPolicy - type: 'null' description: Effective network policy after layering operator defaults with request extensions. nullable: true title: NetworkPolicy required: - id - created_at - status - last_active_at title: Container type: object ContainerCreateRequest: description: Request body for ``POST /containers``. properties: name: anyOf: - type: string - type: 'null' description: Human-readable name for the container. nullable: true file_ids: description: Files (from the Files API) to seed into the container at /mnt/data/. items: type: string title: File Ids type: array expires_after: anyOf: - $ref: '#/components/schemas/ContainerExpiresAfter' title: ContainerExpiresAfter - type: 'null' description: Inactivity-based expiration settings. nullable: true title: ContainerExpiresAfter image: anyOf: - type: string - type: 'null' description: Requested container image. The operator policy may pin or reject this value. nullable: true network_policy: anyOf: - $ref: '#/components/schemas/NetworkPolicyExtended' title: NetworkPolicyExtended - type: 'null' description: Request-supplied network policy extension. Must be a subset of the operator default. nullable: true title: NetworkPolicyExtended title: ContainerCreateRequest type: object ListContainersRequest: description: Query parameters for ``GET /containers``. properties: after: anyOf: - type: string - type: 'null' description: Cursor for pagination. Returns containers after this ID. nullable: true limit: anyOf: - maximum: 100 minimum: 1 type: integer - type: 'null' default: 20 description: Maximum number of containers to return (1-100). order: anyOf: - $ref: '#/components/schemas/Order' title: Order - type: 'null' default: desc description: Sort order by created_at timestamp ('asc' or 'desc'). title: Order title: ListContainersRequest type: object ListContainersResponse: description: Response for ``GET /containers``. properties: object: description: The object type, which is always 'list'. title: Object type: string enum: - list data: description: The list of containers. items: $ref: '#/components/schemas/Container' title: Data type: array first_id: anyOf: - type: string - type: 'null' description: ID of the first container in the page. nullable: true last_id: anyOf: - type: string - type: 'null' description: ID of the last container in the page. nullable: true has_more: description: Whether more containers exist beyond this page. title: Has More type: boolean required: - data - has_more title: ListContainersResponse type: object GetContainerRequest: properties: container_id: description: The ID of the container to retrieve. title: Container Id type: string required: - container_id title: GetContainerRequest type: object DeleteContainerRequest: properties: container_id: description: The ID of the container to delete. title: Container Id type: string required: - container_id title: DeleteContainerRequest type: object ContainerDeleteResponse: description: Response for ``DELETE /containers/{container_id}``. properties: id: description: The container identifier that was deleted. title: Id type: string object: description: The object type, which is always 'container'. title: Object type: string enum: - container deleted: description: Whether the container was successfully deleted. title: Deleted type: boolean required: - id - deleted title: ContainerDeleteResponse type: object ContainerFileSource: description: Origin of a file inside a container. enum: - user - assistant title: ContainerFileSource type: string ContainerFile: description: A file present inside a container's filesystem. properties: id: description: Identifier of the container file. title: Id type: string object: description: The object type, which is always 'container.file'. title: Object type: string enum: - container.file container_id: description: ID of the container holding the file. title: Container Id type: string created_at: description: Unix timestamp (in seconds) when the file was created. title: Created At type: integer bytes: description: Size of the file in bytes. title: Bytes type: integer path: description: Absolute path to the file inside the container. title: Path type: string source: $ref: '#/components/schemas/ContainerFileSource' description: Whether the file was supplied by the user or written by the model. required: - id - container_id - created_at - bytes - path - source title: ContainerFile type: object UploadContainerFileRequest: description: |- Path parameters for ``POST /containers/{container_id}/files``. The file content itself is supplied as a multipart upload and not part of this Pydantic body; see ``fastapi_routes.py``. properties: container_id: description: The ID of the container to upload into. title: Container Id type: string required: - container_id title: UploadContainerFileRequest type: object ListContainerFilesRequest: properties: container_id: description: The ID of the container whose files should be listed. title: Container Id type: string after: anyOf: - type: string - type: 'null' description: Cursor for pagination. nullable: true limit: anyOf: - maximum: 100 minimum: 1 type: integer - type: 'null' default: 20 description: Maximum number of files to return (1-100). order: anyOf: - $ref: '#/components/schemas/Order' title: Order - type: 'null' default: desc description: Sort order by created_at timestamp. title: Order required: - container_id title: ListContainerFilesRequest type: object ListContainerFilesResponse: properties: object: description: The object type, which is always 'list'. title: Object type: string enum: - list data: description: The list of files in the container. items: $ref: '#/components/schemas/ContainerFile' title: Data type: array first_id: anyOf: - type: string - type: 'null' description: ID of the first file in the page. nullable: true last_id: anyOf: - type: string - type: 'null' description: ID of the last file in the page. nullable: true has_more: description: Whether more files exist beyond this page. title: Has More type: boolean required: - data - has_more title: ListContainerFilesResponse type: object GetContainerFileRequest: properties: container_id: description: The ID of the container holding the file. title: Container Id type: string file_id: description: The ID of the container file to retrieve. title: File Id type: string required: - container_id - file_id title: GetContainerFileRequest type: object GetContainerFileContentRequest: properties: container_id: description: The ID of the container holding the file. title: Container Id type: string file_id: description: The ID of the container file to download. title: File Id type: string required: - container_id - file_id title: GetContainerFileContentRequest type: object DeleteContainerFileRequest: properties: container_id: description: The ID of the container holding the file. title: Container Id type: string file_id: description: The ID of the container file to delete. title: File Id type: string required: - container_id - file_id title: DeleteContainerFileRequest type: object ContainerFileDeleteResponse: properties: id: description: The container file identifier that was deleted. title: Id type: string object: description: The object type, which is always 'container.file'. title: Object type: string enum: - container.file deleted: description: Whether the file was successfully deleted. title: Deleted type: boolean required: - id - deleted title: ContainerFileDeleteResponse type: object ShellEnvironmentContainerAuto: description: |- Provider-managed container environment. The provider lazily creates and reuses a container for the calling response chain. Useful when the caller does not need to persist or reference the container across responses. properties: type: description: Discriminator. title: Type type: string enum: - container_auto image: anyOf: - type: string - type: 'null' description: Optional preferred container image. nullable: true expires_after: anyOf: - $ref: '#/components/schemas/ContainerExpiresAfter' title: ContainerExpiresAfter - type: 'null' description: Inactivity-based expiration for the auto-created container. nullable: true title: ContainerExpiresAfter title: ShellEnvironmentContainerAuto type: object ShellEnvironmentContainerReference: description: Reference an existing container by ID. properties: type: description: Discriminator. title: Type type: string enum: - container_reference container_id: description: The ID of an existing container to execute inside. title: Container Id type: string required: - container_id title: ShellEnvironmentContainerReference type: object ShellEnvironmentLocal: description: |- Local (non-container) execution mode. Only available when the operator has explicitly enabled local mode in the ContainerRuntime provider configuration. properties: type: description: Discriminator. title: Type type: string enum: - local working_directory: anyOf: - type: string - type: 'null' description: Optional working directory for local execution. nullable: true title: ShellEnvironmentLocal type: object ShellOutcomeSuccess: description: Process exited cleanly with status 0. properties: type: description: Discriminator. title: Type type: string enum: - success exit_code: description: Process exit code (always 0 for success). title: Exit Code type: integer enum: - 0 title: ShellOutcomeSuccess type: object ShellOutcomeFailure: description: Process exited with a non-zero status. properties: type: description: Discriminator. title: Type type: string enum: - failure exit_code: description: Process exit code. title: Exit Code type: integer reason: anyOf: - type: string - type: 'null' description: Human-readable failure reason, if known. nullable: true required: - exit_code title: ShellOutcomeFailure type: object ShellOutcomeTimeout: description: Process was terminated for exceeding its time budget. properties: type: description: Discriminator. title: Type type: string enum: - timeout elapsed_seconds: description: Wall-clock seconds elapsed before termination. title: Elapsed Seconds type: number required: - elapsed_seconds title: ShellOutcomeTimeout type: object ShellCallOutput: description: |- Captured output of a single shell execution. Consumed by the Responses provider to construct ``ShellCallOutputItem`` entries on the output stream. properties: stdout: description: UTF-8 decoded standard output (truncated by the runtime if oversized). title: Stdout type: string stderr: description: UTF-8 decoded standard error (truncated by the runtime if oversized). title: Stderr type: string outcome: description: How the shell process terminated. discriminator: mapping: failure: '#/components/schemas/ShellOutcomeFailure' success: '#/components/schemas/ShellOutcomeSuccess' timeout: '#/components/schemas/ShellOutcomeTimeout' propertyName: type oneOf: - $ref: '#/components/schemas/ShellOutcomeSuccess' title: ShellOutcomeSuccess - $ref: '#/components/schemas/ShellOutcomeFailure' title: ShellOutcomeFailure - $ref: '#/components/schemas/ShellOutcomeTimeout' title: ShellOutcomeTimeout title: ShellOutcomeSuccess | ShellOutcomeFailure | ShellOutcomeTimeout duration_ms: description: Wall-clock duration of the shell call in milliseconds. minimum: 0 title: Duration Ms type: integer container_id: anyOf: - type: string - type: 'null' description: ID of the container the call executed in, when applicable. Null for local mode. nullable: true required: - stdout - stderr - outcome - duration_ms title: ShellCallOutput 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: title: Type type: string enum: - message object: title: Object type: string enum: - message 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: compaction: '#/components/schemas/OpenAIResponseCompaction' 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' reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' 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 - $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' title: OpenAIResponseOutputMessageReasoningItem - $ref: '#/components/schemas/OpenAIResponseCompaction' title: OpenAIResponseCompaction title: OpenAIResponseMessage | ... (11 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 ProcessFileRequest: description: |- Request model for file processing operation. Wraps the serializable parameters for process_file. The UploadFile parameter is kept separate (not serializable), following the same pattern as UploadFileRequest in the Files API. properties: file_id: anyOf: - type: string - type: 'null' description: ID of file already uploaded to file storage. Mutually exclusive with file. nullable: true options: anyOf: - additionalProperties: true type: object - type: 'null' description: Optional processing options. Provider-specific parameters (e.g., OCR settings, output format). nullable: true chunking_strategy: anyOf: - discriminator: mapping: auto: '#/components/schemas/VectorStoreChunkingStrategyAuto' contextual: '#/components/schemas/VectorStoreChunkingStrategyContextual' static: '#/components/schemas/VectorStoreChunkingStrategyStatic' propertyName: type oneOf: - $ref: '#/components/schemas/VectorStoreChunkingStrategyAuto' title: VectorStoreChunkingStrategyAuto - $ref: '#/components/schemas/VectorStoreChunkingStrategyStatic' title: VectorStoreChunkingStrategyStatic - $ref: '#/components/schemas/VectorStoreChunkingStrategyContextual' title: VectorStoreChunkingStrategyContextual title: VectorStoreChunkingStrategyAuto | VectorStoreChunkingStrategyStatic | VectorStoreChunkingStrategyContextual - type: 'null' description: Optional chunking strategy for splitting content into chunks. title: Chunking Strategy nullable: true title: ProcessFileRequest type: object ComparisonFilter: description: A filter that compares a metadata field against a value. properties: type: enum: - eq - ne - gt - gte - lt - lte - in - nin title: Type type: string key: title: Key type: string value: title: Value required: - type - key - value title: ComparisonFilter type: object CompoundFilter: description: A filter that combines multiple filters with a logical operator. properties: type: enum: - and - or title: Type type: string filters: items: {} title: Filters type: array required: - type - filters title: CompoundFilter 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/OpenAIFileUploadPurpose' 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 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 SkillVersionCreateRequest: description: Request to create a new skill version. Matches OpenAI VersionCreateParams. properties: default: type: boolean default: false description: Whether to set this version as the default title: Default title: SkillVersionCreateRequest type: object ListSkillsRequest: description: Request parameters for listing skills. properties: after: anyOf: - type: string - type: 'null' description: Cursor for pagination nullable: true limit: default: 20 description: Maximum number of results maximum: 100 minimum: 1 title: Limit type: integer order: default: desc description: Sort order by created_at enum: - asc - desc title: Order type: string title: ListSkillsRequest type: object ListSkillVersionsRequest: description: Request parameters for listing skill versions. properties: after: anyOf: - type: string - type: 'null' description: Cursor for pagination nullable: true limit: default: 20 description: Maximum number of results maximum: 100 minimum: 1 title: Limit type: integer order: default: desc description: Sort order by version enum: - asc - desc title: Order type: string title: ListSkillVersionsRequest type: object OpenAIResponseMessageOutputUnion: anyOf: - 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 - $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' title: OpenAIResponseOutputMessageReasoningItem 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' reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' x-stainless-naming: OpenAIResponseMessageOutputOneOf title: OpenAIResponseMessage | ... (8 variants) - $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput' title: OpenAIResponseInputFunctionToolCallOutput - $ref: '#/components/schemas/OpenAIResponseMCPApprovalResponse' title: OpenAIResponseMCPApprovalResponse - $ref: '#/components/schemas/OpenAIResponseCompaction' title: OpenAIResponseCompaction title: OpenAIResponseInputFunctionToolCallOutput | OpenAIResponseMCPApprovalResponse | OpenAIResponseCompaction x-stainless-naming: OpenAIResponseMessageOutputUnion OpenAIResponseOutputItem: 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 - $ref: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' title: OpenAIResponseOutputMessageReasoningItem 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' reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem' web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall' x-stainless-naming: OpenAIResponseOutputItem title: OpenAIResponseMessage | ... (8 variants) ChatCompletionMessageToolCall: properties: id: type: string description: Unique identifier for the tool call. type: type: string description: Must be 'function' to identify this as a function call. enum: - function function: properties: name: type: string title: Name description: Name of the function to call. arguments: type: string title: Arguments description: Arguments to pass to the function as a JSON string. type: object required: - name - arguments description: Function call details. type: object description: Tool call specification for OpenAI-compatible chat completion responses. required: - id - type - function ChatCompletionMessageCustomToolCall: properties: id: type: string description: The ID of the tool call. type: type: string description: The type of the tool. Always 'custom'. enum: - custom custom: properties: name: type: string title: Name description: The name of the custom tool to call. input: type: string title: Input description: The input for the custom tool call generated by the model. type: object required: - name - input description: The custom tool that the model called. type: object required: - id - type - custom description: A call to a custom tool created by the model. ChoiceDeltaToolCall: properties: id: anyOf: - type: string description: Unique identifier for the tool call. - type: 'null' description: Unique identifier for the tool call. type: anyOf: - type: string description: Must be 'function' to identify this as a function call. enum: - function - type: 'null' description: Must be 'function' to identify this as a function call. function: anyOf: - properties: name: type: string title: Name description: Name of the function to call. arguments: type: string title: Arguments description: Arguments to pass to the function as a JSON string. type: object - type: 'null' description: Function call details. index: type: integer description: The index of the tool call being streamed. type: object description: A tool call delta in a streaming chat completion chunk. required: - index ModelIdsResponses: type: string description: Model identifier. 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: Administrative APIs for inspecting providers, routes, health, and version. name: Admin x-displayName: Admin - 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: Batches - description: External tool and service connectors. name: Connectors x-displayName: Connectors - description: Protocol for conversation management operations. name: Conversations x-displayName: Conversations - description: Document ingestion and chunking. name: File Processors x-displayName: File Processors - description: This API is used to upload documents that can be used with other OGX APIs. name: Files x-displayName: Files - description: |- OGX 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 OGX service, including health status, available API routes with methods and implementing providers. name: Inspect x-displayName: Inspect - description: Google Interactions API compatibility layer. name: Interactions x-displayName: Interactions - description: Anthropic Messages API compatibility layer for creating messages and counting tokens. name: Messages x-displayName: Messages - description: '' name: Models - 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: '' name: ToolGroups - description: '' name: ToolRuntime - description: Tool listing and management. name: Tools x-displayName: Tools - description: OpenAI-compatible vector store management and search. name: Vector Stores - description: '' name: VectorIO - description: OpenAI Responses API for agent orchestration with tool use, multi-turn conversations, and background processing. name: Responses x-displayName: Responses x-tagGroups: - name: Operations tags: - Admin - Agents - Batches - Connectors - Conversations - File Processors - Files - Inference - Inspect - Interactions - Messages - Models - Prompts - Providers - Responses - ToolGroups - ToolRuntime - Tools - Vector Stores - VectorIO security: - Default: []