openapi: 3.1.0 info: title: stdapi.ai description: AWS standardized AI API contact: name: stdapi.ai url: https://stdapi.ai/ license: name: GNU Affero General Public License v3.0 or later (Commercial license available) identifier: AGPL-3.0-or-later version: 1.13.0 paths: /anthropic/v1/files: post: tags: - Files - Anthropic summary: Upload a file for use in other API endpoints (Anthropic format) description: 'Uploads a file and returns `FileMetadata` with the assigned file ID (Anthropic Files API). The returned `id` (format: `file_<32 hex chars>`) can be referenced in `anthropic_message` requests to supply documents or images without re-uploading them. **Providing the file:** Two request formats are accepted: - `multipart/form-data`: standard binary file upload via the `file` field. - `application/json`: pass `file` as a base64 string, data URI (`data:;base64,`), HTTPS URL, or S3 URI — preferred for **MCP tools** and AI agents that cannot construct multipart requests. **MCP / AI agent usage:** Call this tool with a JSON body. To upload inline content use a data URI: `{"file": "data:text/plain;base64,SGVsbG8h"}`. To ingest a remote file pass its URL: `{"file": "https://example.com/document.pdf"}`. **File expiry:** Files persist until manually deleted unless an expiry is configured.' operationId: anthropic_file security: - HTTPBearer: [] - APIKeyHeader: [] requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_anthropic_file' application/json: examples: data_uri: summary: Inline content via data URI (MCP / AI agent) value: file: data:text/plain;base64,SGVsbG8gV29ybGQ= url: summary: Fetch from URL value: file: https://example.com/document.pdf responses: '200': description: The file metadata. content: application/json: schema: $ref: '#/components/schemas/FileMetadata' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - Files - Anthropic summary: List uploaded files (Anthropic format) description: Returns a paginated list of uploaded files with metadata (Anthropic Files API). operationId: anthropic_file_list security: - HTTPBearer: [] - APIKeyHeader: [] parameters: - name: after_id in: query required: false schema: anyOf: - type: string pattern: ^file[-_][a-z2-7]{32}$ - type: 'null' description: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. title: After Id description: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - name: before_id in: query required: false schema: anyOf: - type: string pattern: ^file[-_][a-z2-7]{32}$ - type: 'null' description: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. title: Before Id description: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - name: limit in: query required: false schema: type: integer maximum: 1000 minimum: 1 description: Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20 title: Limit description: Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. responses: '200': description: A list of file metadata objects. content: application/json: schema: $ref: '#/components/schemas/FileListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /anthropic/v1/files/{file_id}: get: tags: - Files - Anthropic summary: Retrieve metadata for an uploaded file (Anthropic format) description: Returns metadata (name, size, MIME type, creation date) for a specific file by ID (Anthropic Files API). operationId: anthropic_files_get security: - HTTPBearer: [] - APIKeyHeader: [] parameters: - name: file_id in: path required: true schema: type: string pattern: ^file[-_][a-z2-7]{32}$ description: ID of the File. title: File Id description: ID of the File. responses: '200': description: The file metadata. content: application/json: schema: $ref: '#/components/schemas/FileMetadata' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - Files - Anthropic summary: Delete an uploaded file (Anthropic format) description: Permanently deletes a file by ID and returns a deletion confirmation (Anthropic Files API). operationId: anthropic_files_delete security: - HTTPBearer: [] - APIKeyHeader: [] parameters: - name: file_id in: path required: true schema: type: string pattern: ^file[-_][a-z2-7]{32}$ description: ID of the File. title: File Id description: ID of the File. responses: '200': description: Deletion status. content: application/json: schema: $ref: '#/components/schemas/DeletedFile' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /anthropic/v1/files/{file_id}/content: get: tags: - Files - Anthropic summary: Download the raw content of an uploaded file (Anthropic format) description: Returns the raw binary content of a file as a streaming download (Anthropic Files API). operationId: anthropic_file_content security: - HTTPBearer: [] - APIKeyHeader: [] parameters: - name: file_id in: path required: true schema: type: string pattern: ^file[-_][a-z2-7]{32}$ description: ID of the File. title: File Id description: ID of the File. responses: '200': description: The raw file content. content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /anthropic/v1/messages: post: tags: - Chat - Anthropic summary: Generate a message response (Anthropic format) description: 'Creates a message response (Anthropic Messages API). Accepts a structured list of input messages and generates the next message in the conversation. Returns a `Message` object, or a stream of `MessageStreamEvent` objects when `stream=true`. **Extended multimodal inputs (beyond original Anthropic API):** - **Images:** Supply images inline (base64/URL) or by Files API `file_id` obtained from `anthropic_file`. - **Documents:** Supply PDFs (base64/URL), plain text, or files by `file_id`. Citation extraction is supported. **Extended capabilities:** - **Extended thinking:** Control reasoning depth via `thinking` or `output_config.effort` (`low`, `medium`, `high`, `xhigh`, `max`). - **Server tools:** Built-in tools such as `web_search` can be enabled without custom implementations. **When to use:** Use this endpoint for Anthropic SDK compatibility or when you need extended thinking, citations, or Anthropic-specific features. For OpenAI SDK compatibility, use `openai_chat_completion` or `openai_response` instead. **Find compatible models:** Call `search_models` with `mcp_tool=anthropic_message` to discover model IDs that support this endpoint. When supplying images or documents, also add `input_modalities=IMAGE` to the filter so only models that support both the route and image input are returned.' operationId: anthropic_message requestBody: content: application/json: schema: $ref: '#/components/schemas/MessageCreateParams' examples: basic: summary: Basic message value: model: amazon.nova-micro-v1:0 messages: - role: user content: Hello, how are you? max_tokens: 1024 streaming: summary: Streaming response value: model: amazon.nova-micro-v1:0 messages: - role: user content: Tell me a story max_tokens: 1024 stream: true with_system: summary: With system prompt value: model: amazon.nova-micro-v1:0 system: You are a helpful assistant. messages: - role: user content: Explain quantum computing max_tokens: 2048 temperature: 0.7 required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Message' example: id: msg-f6ed35b89b77488f8c481eb0a26ac1bf type: message role: assistant content: - type: text text: I'm an AI assistant. model: amazon.nova-micro-v1:0 stop_reason: end_turn usage: input_tokens: 11 output_tokens: 16 '400': description: Invalid request or unsupported parameters. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] - APIKeyHeader: [] /anthropic/v1/messages/count_tokens: post: tags: - Chat - Anthropic summary: Count input tokens for a message without generating a response (Anthropic format) description: 'Counts the number of tokens a given request would consume, without creating a message. Accounts for all inputs — messages, system prompt, tools, images, and documents. Useful for estimating costs or checking whether a prompt fits within a model''s context window before making a full `anthropic_message` call. **Find compatible models:** Call `search_models` with `mcp_tool=anthropic_message_count_tokens` to discover model IDs that support this endpoint.' operationId: anthropic_message_count_tokens requestBody: content: application/json: schema: $ref: '#/components/schemas/MessageCountTokensParams' examples: basic: summary: Basic count tokens value: model: amazon.nova-micro-v1:0 messages: - role: user content: Hello, how are you? with_system: summary: With system prompt value: model: amazon.nova-micro-v1:0 system: You are a helpful assistant. messages: - role: user content: Explain quantum computing required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageTokensCount' example: input_tokens: 2095 '400': description: Invalid request or unsupported parameters. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] - APIKeyHeader: [] /anthropic/v1/models: get: tags: - Models - Anthropic summary: List available text generation models (Anthropic format) description: 'Lists all available text generation models with display name and creation date (Anthropic Models API). Only models that support text input and output are included. **Agent note:** For richer filtering — by modality, route, MCP tool, region, or legacy status — use `search_models` instead.' operationId: anthropic_model_list security: - HTTPBearer: [] - APIKeyHeader: [] parameters: - name: limit in: query required: false schema: type: integer maximum: 1000 minimum: 1 description: Number of items to return per page. default: 1000 title: Limit description: Number of items to return per page. - name: after_id in: query required: false schema: anyOf: - type: string - type: 'null' description: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. title: After Id description: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - name: before_id in: query required: false schema: anyOf: - type: string - type: 'null' description: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. title: Before Id description: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. responses: '200': description: List of available models. content: application/json: schema: $ref: '#/components/schemas/ModelListResponse' examples: list: summary: Example list value: data: - id: amazon.nova-micro-v1:0 type: model display_name: Amazon Nova Micro created_at: '2025-01-01T00:00:00Z' has_more: false first_id: amazon.nova-micro-v1:0 last_id: amazon.nova-micro-v1:0 '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /anthropic/v1/models/{model_id}: get: tags: - Models - Anthropic summary: Retrieve details for a specific model by ID (Anthropic format) description: 'Retrieves metadata (display name, creation date) for a single model by ID (Anthropic Models API). **Agent note:** Use `search_models` to look up modalities, supported routes, regions, and other extended metadata not available here.' operationId: anthropic_model_get security: - HTTPBearer: [] - APIKeyHeader: [] parameters: - name: model_id in: path required: true schema: type: string minLength: 1 maxLength: 255 description: The ID of the model to retrieve. examples: - amazon.nova-micro-v1:0 str_strip_whitespace: true title: Model Id description: The ID of the model to retrieve. responses: '200': description: Model retrieved successfully content: application/json: schema: $ref: '#/components/schemas/ModelInfo' examples: model: summary: Example model value: id: amazon.nova-micro-v1:0 type: model display_name: Amazon Nova Micro created_at: '2025-01-01T00:00:00Z' '404': description: Model not found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /search_models: get: tags: - Models summary: Search available models with optional filters description: 'Search the catalogue of currently available models and return extended metadata (modalities, supported API routes, MCP tool names, AWS regions, streaming support, legacy status). Supplements the standard `/v1/models` list. All filters are optional and combined with **AND** logic — only models matching every supplied filter are returned, sorted by ID. **Agent workflow:** 1. Call this tool first to find the right model ID, then pass it to the target endpoint. 2. Use `route` with either a route path **or** an MCP tool name — both are accepted transparently (e.g. `route=/v1/images/generations` and `route=openai_image_generation` return the same models). 3. **Combine filters for multimodal tasks:** when a tool supports extended input modalities (e.g. images in `openai_chat_completion`), add `input_modalities=IMAGE` alongside `route` — this ensures the model supports *both* the route and the required modality. A model that only handles text would otherwise appear in a route-only search and then fail at request time. 4. **Exclude legacy models:** Add `legacy=false` to skip deprecated models unless you specifically need one. **Examples:** - Text generation: `route=openai_chat_completion&legacy=false` - Vision (image input): `route=openai_chat_completion&input_modalities=IMAGE&legacy=false` - Audio understanding: `route=openai_chat_completion&input_modalities=SPEECH&legacy=false` - Embeddings: `route=openai_embedding&legacy=false` - Image generation: `route=openai_image_generation&legacy=false` **Note:** Audio *output* from `openai_chat_completion` (via `modalities=["text","audio"]`) is a model-specific capability not separately tracked — use a `route` search and verify audio output support in the model documentation.' operationId: search_models parameters: - name: input_modalities in: query required: false schema: anyOf: - type: array uniqueItems: true items: type: string - type: 'null' description: Filter by expected input modalities (e.g., TEXT, IMAGE, SPEECH). title: Input Modalities description: Filter by expected input modalities (e.g., TEXT, IMAGE, SPEECH). - name: output_modalities in: query required: false schema: anyOf: - type: array uniqueItems: true items: type: string - type: 'null' description: Filter by expected output modalities (e.g., TEXT, IMAGE, AUDIO). title: Output Modalities description: Filter by expected output modalities (e.g., TEXT, IMAGE, AUDIO). - name: route in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter to models that support a specific route path (e.g. /v1/chat/completions) or MCP tool name (e.g. openai_chat_completion). Both formats are accepted transparently. title: Route description: Filter to models that support a specific route path (e.g. /v1/chat/completions) or MCP tool name (e.g. openai_chat_completion). Both formats are accepted transparently. - name: region in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter to models available in a specific AWS region (e.g. us-east-1). title: Region description: Filter to models available in a specific AWS region (e.g. us-east-1). - name: streaming in: query required: false schema: anyOf: - type: boolean - type: 'null' description: Filter by streaming support (true = streaming only, false = non-streaming only). title: Streaming description: Filter by streaming support (true = streaming only, false = non-streaming only). - name: legacy in: query required: false schema: anyOf: - type: boolean - type: 'null' description: Filter by legacy status (true = deprecated models only, false = non-deprecated models only). title: Legacy description: Filter by legacy status (true = deprecated models only, false = non-deprecated models only). responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/ModelDetails' title: Response Search Models '400': description: Invalid modality, route, or MCP tool filter. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/audio/speech: post: tags: - Audio - OpenAI summary: Convert text to speech audio (OpenAI format) description: 'Generates audio from the input text (OpenAI Audio Speech API). Returns the audio file as a streaming download in the requested format, or a stream of SSE audio events when `stream_format=sse`. **Find compatible models:** Call `search_models` with `mcp_tool=openai_audio_speech` to discover model IDs that support text-to-speech.' operationId: openai_audio_speech requestBody: content: application/json: schema: $ref: '#/components/schemas/SpeechCreateParams' examples: file: summary: Generate MP3 file value: model: amazon.polly-standard voice: Amy input: Hello, I'am Amy response_format: mp3 sse: summary: Stream using SSE value: model: amazon.polly-standard voice: Amy input: Hello, I'am Amy response_format: mp3 stream_format: sse required: true responses: '200': description: Audio generated (or streaming). content: application/json: schema: {} '400': description: Invalid request or unsupported parameters. '404': description: Model not found. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] - APIKeyHeader: [] /v1/audio/transcriptions: post: tags: - Audio - OpenAI summary: Transcribe audio to text (OpenAI format) description: 'Transcribes audio into the input language (OpenAI Audio Transcriptions API). **Providing the audio file:** Two request formats are accepted: - `multipart/form-data`: standard binary file upload via the `file` field. - `application/json`: pass `file` as a base64 string, data URI (`data:audio/;base64,`), HTTPS URL, or S3 URI — preferred for **MCP tools** and AI agents that cannot construct multipart requests. **MCP / AI agent usage:** Call this tool with a JSON body containing the audio as a data URI or URL, along with `model` and any other parameters. Example: `{"file": "data:audio/mp3;base64,", "model": "amazon.transcribe", "response_format": "json"}`. Returns the transcription as plain text, JSON with metadata, subtitle formats (SRT/VTT), or a stream of SSE events. **Extended output format (beyond original OpenAI API):** - **`diarized_json`**: Speaker diarization — returns labelled segments identifying which speaker said what, with timestamps. **Find compatible models:** Call `search_models` with `mcp_tool=openai_audio_transcription` to discover model IDs that support speech-to-text.' operationId: openai_audio_transcription requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_openai_audio_transcription' examples: json: summary: JSON response value: model: amazon.transcribe response_format: json vtt: summary: Subtitle (VTT) value: response_format: vtt stream: summary: Streaming SSE value: stream: true application/json: examples: data_uri: summary: Audio via data URI (MCP / AI agent) value: file: data:audio/mp3;base64, model: amazon.transcribe response_format: json url: summary: Audio from URL value: file: https://example.com/audio.mp3 model: amazon.transcribe responses: '200': description: Transcription completed (or streaming). content: application/json: schema: {} '400': description: Invalid request or unsupported parameters. '404': description: Model not found. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] - APIKeyHeader: [] /v1/audio/translations: post: tags: - Audio - OpenAI summary: Transcribe and translate audio to English text (OpenAI format) description: 'Transcribes audio from any supported language and translates the result into English (OpenAI Audio Translations API). **Output is always English** — regardless of the source language. If you want the transcription in the original language, use `openai_audio_transcription` instead. **Providing the audio file:** Two request formats are accepted: - `multipart/form-data`: standard binary file upload via the `file` field. - `application/json`: pass `file` as a base64 string, data URI (`data:audio/;base64,`), HTTPS URL, or S3 URI — preferred for **MCP tools** and AI agents that cannot construct multipart requests. **MCP / AI agent usage:** Call this tool with a JSON body containing the audio as a data URI or URL, along with `model`. Example: `{"file": "data:audio/mp3;base64,", "model": "amazon.transcribe"}`. **Find compatible models:** Call `search_models` with `mcp_tool=openai_audio_translation` to discover model IDs that support speech-to-text translation.' operationId: openai_audio_translation requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_openai_audio_translation' examples: json: summary: JSON response value: model: amazon.transcribe response_format: json srt: summary: Subtitle (SRT) value: response_format: srt application/json: examples: data_uri: summary: Audio via data URI (MCP / AI agent) value: file: data:audio/mp3;base64, model: amazon.transcribe url: summary: Audio from URL value: file: https://example.com/audio.mp3 model: amazon.transcribe responses: '200': description: Translation completed. content: application/json: schema: {} '400': description: Invalid request or unsupported parameters. '404': description: Model not found. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] - APIKeyHeader: [] /v1/chat/completions: post: tags: - Chat - OpenAI summary: Generate a text response for a chat conversation (OpenAI format) description: 'Creates a model response for the given chat conversation (OpenAI Chat Completions API). Supports streaming, tool/function calling, and reasoning models. Returns a `ChatCompletion` object, or a stream of `ChatCompletionChunk` objects when `stream=true`. **Extended multimodal inputs (beyond original OpenAI API):** - **Text, images, and vision:** Pass images via URL, data URI, base64, or Files API `file_id` in the `content` array. - **Audio input:** Include audio content parts (`type: input_audio`) with `wav`/`mp3` data. - **File references:** Reference uploaded files directly via `type: file` with a `file_id` obtained from `openai_file`. - **Audio output:** Request spoken audio alongside text by setting `modalities: ["text", "audio"]` and an `audio` config with the desired voice and format. **When to use:** Prefer this endpoint for OpenAI SDK compatibility or when using the `messages` array format. For the newer stateless Responses API, use `openai_response` instead. For Anthropic SDK compatibility, use `anthropic_message`. **Find compatible models:** Call `search_models` with `mcp_tool=openai_chat_completion` to discover model IDs that support this endpoint. When using extended multimodal inputs, also filter by the required modality — for example, add `input_modalities=IMAGE` for vision requests or `input_modalities=SPEECH` for audio input, so only models that support both the route and the modality are returned.' operationId: openai_chat_completion requestBody: content: application/json: schema: $ref: '#/components/schemas/stdapi__types__openai_chat_completions__CompletionCreateParams' examples: basic: summary: Basic chat completion value: model: amazon.nova-micro-v1:0 messages: - role: user content: Hello, how are you? streaming: summary: Streaming response value: model: amazon.nova-micro-v1:0 messages: - role: user content: Tell me a story stream: true with_params: summary: With parameters value: model: amazon.nova-micro-v1:0 messages: - role: system content: You are a helpful assistant. - role: user content: Explain quantum computing temperature: 0.7 max_tokens: 1000 required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ChatCompletion' example: id: chatcmpl-f6ed35b89b77488f8c481eb0a26ac1bf choices: - finish_reason: stop index: 0 message: content: I'm an AI assistant. role: assistant created: 1740134957 model: amazon.nova-micro-v1:0 object: chat.completion usage: completion_tokens: 16 prompt_tokens: 11 total_tokens: 27 '400': description: Invalid request or unsupported parameters. '404': description: Model not found. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] - APIKeyHeader: [] /v1/completions: post: tags: - Chat - OpenAI summary: Generate a text completion (OpenAI format) description: 'Creates a text completion (OpenAI Completions API). Returns a ``Completion`` object, or a stream of chunks terminated by ``data: [DONE]`` when ``stream=true``. **Prompt shapes — how each ``prompt`` value is handled:** - ``"text"`` → one text completion (one choice). - ``["t1", "t2", …]`` → one choice per prompt (batch). - URL (``https://``, ``s3://``, ``data:``, ``file-id:``) → the file is forwarded to the model using its detected modality (``image``, ``video``, ``audio``, ``document``); the model returns an error if it does not support that modality. - ``["instruction", , , …]`` (exactly one text + ≥1 files) → packed in input order into a single multimodal request, returning one choice. **This is the recommended shape for analysing files with an instruction** (e.g. describing an image, summarising a PDF). - ``[, , …]`` (files only, no text) → one choice per file, each forwarded as its detected modality. **Streaming:** text deltas arrive as SSE chunks carrying ``choices[0].index`` so clients can attribute each delta to its prompt or choice; the terminal chunk per choice has ``finish_reason`` set.' operationId: openai_completion requestBody: content: application/json: schema: $ref: '#/components/schemas/stdapi__types__openai_completions__CompletionCreateParams' examples: basic: summary: Basic completion value: model: amazon.nova-micro-v1:0 prompt: Hello, how are you? max_tokens: 20 streaming: summary: Streaming response value: model: amazon.nova-micro-v1:0 prompt: Tell me a short story stream: true with_params: summary: With parameters value: model: amazon.nova-micro-v1:0 prompt: Explain quantum computing temperature: 0.7 top_p: 0.9 max_tokens: 200 stop: - ' ' batch: summary: Batch prompts value: model: amazon.nova-micro-v1:0 prompt: - One plus one is - Two plus two is max_tokens: 5 file_id: summary: File reference value: model: amazon.nova-micro-v1:0 prompt: file-id:file-abc123 required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Completion' example: id: cmpl-6c6bfcd3b39e4d0f8c481eb0a26ac1bf choices: - finish_reason: stop index: 0 text: The capital of France is Paris. created: 1740134957 model: amazon.nova-micro-v1:0 object: text_completion usage: completion_tokens: 8 prompt_tokens: 6 total_tokens: 14 '400': description: Invalid request or unsupported parameters. '404': description: Model not found. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] - APIKeyHeader: [] /v1/embeddings: post: tags: - Embeddings - OpenAI summary: Generate text embeddings as numeric vectors (OpenAI format) description: 'Creates embedding vector(s) for the input text (OpenAI Embeddings API). Accepts a single string or an array of strings for batch processing. Returns fixed-dimensional float vectors (or base64-encoded when `encoding_format=base64`) suitable for semantic search, clustering, and retrieval-augmented generation. **Extended input support (beyond original OpenAI API):** - **Multimodal inputs:** For models that support it, pass URLs, S3 URIs, or data URIs instead of plain strings to embed images or other media. **Find compatible models:** Call `search_models` with `mcp_tool=openai_embedding` to discover model IDs that support embeddings. For multimodal inputs (URLs, S3 URIs), also add `input_modalities=IMAGE` to find models that accept both the embedding route and image input.' operationId: openai_embedding requestBody: content: application/json: schema: $ref: '#/components/schemas/EmbeddingCreateParams' examples: single: summary: Single input value: model: amazon.titan-embed-text-v2:0 input: Hello world batch: summary: Batch input value: model: amazon.titan-embed-text-v2:0 input: - first - second required: true responses: '200': description: Embeddings successfully created. content: application/json: schema: $ref: '#/components/schemas/CreateEmbeddingResponse' '400': description: Invalid request or unsupported parameters. '404': description: Model not found. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] - APIKeyHeader: [] /v1/files: post: tags: - Files - OpenAI summary: Upload a file for use in other API endpoints (OpenAI format) description: 'Uploads a file and returns a `FileObject` with the assigned file ID (OpenAI Files API). The returned `file_id` (format: `file-<32 hex chars>`) can be referenced in other tools such as `openai_image_edit` and `openai_image_variation` to supply images without re-uploading. **Providing the file:** Two request formats are accepted: - `multipart/form-data`: standard binary file upload via the `file` field. - `application/json`: pass `file` as a base64 string, data URI (`data:;base64,`), HTTPS URL, or S3 URI — preferred for **MCP tools** and AI agents that cannot construct multipart requests. **MCP / AI agent usage:** Call this tool with a JSON body. To upload inline content use a data URI: `{"file": "data:text/plain;base64,SGVsbG8h", "purpose": "user_data"}`. To ingest a remote file pass its URL: `{"file": "https://example.com/document.pdf", "purpose": "assistants"}`. **File expiry:** Files with `purpose=batch` expire after 30 days by default. All other files persist until manually deleted. Use `expires_after[seconds]` (1 hour-30 days) to set a custom TTL. For files larger than a few MB, prefer the multipart upload workflow: create a session with `openai_upload`, add parts with `openai_upload_part`, then finalise with `openai_upload_complete`.' operationId: openai_file security: - HTTPBearer: [] - APIKeyHeader: [] requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_openai_file' examples: assistants: summary: Upload for Assistants API value: purpose: assistants batch: summary: Upload for Batch API (expires after 30 days) value: purpose: batch fine-tune: summary: Upload for fine-tuning value: purpose: fine-tune application/json: examples: data_uri: summary: Inline content via data URI (MCP / AI agent) value: file: data:text/plain;base64,SGVsbG8gV29ybGQ= purpose: user_data url: summary: Fetch from URL value: file: https://example.com/document.pdf purpose: assistants base64: summary: Raw base64 value: file: SGVsbG8gV29ybGQ= purpose: user_data responses: '200': description: The uploaded File object. content: application/json: schema: $ref: '#/components/schemas/FileObject' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - Files - OpenAI summary: List uploaded files (OpenAI format) description: Returns a paginated list of uploaded files, optionally filtered by purpose (OpenAI Files API). operationId: openai_file_list security: - HTTPBearer: [] - APIKeyHeader: [] parameters: - name: purpose in: query required: false schema: anyOf: - type: string - type: 'null' description: Only return files with the given purpose. title: Purpose description: Only return files with the given purpose. - name: after in: query required: false schema: anyOf: - type: string pattern: ^file[-_][a-z2-7]{32}$ - type: 'null' description: 'Cursor for pagination: the object ID to start after (the last ID from a previous page).' title: After description: 'Cursor for pagination: the object ID to start after (the last ID from a previous page).' - name: limit in: query required: false schema: type: integer maximum: 10000 minimum: 1 description: A limit on the number of objects to be returned. default: 10000 title: Limit description: A limit on the number of objects to be returned. - name: order in: query required: false schema: enum: - asc - desc type: string description: Sort order by the `created_at` timestamp of the objects. default: desc title: Order description: Sort order by the `created_at` timestamp of the objects. responses: '200': description: A list of File objects. content: application/json: schema: $ref: '#/components/schemas/ListFilesResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/files/{file_id}: get: tags: - Files - OpenAI summary: Retrieve metadata for an uploaded file (OpenAI format) description: Returns metadata (name, size, purpose, creation time) for a specific file by ID (OpenAI Files API). operationId: openai_files_get security: - HTTPBearer: [] - APIKeyHeader: [] parameters: - name: file_id in: path required: true schema: type: string pattern: ^file[-_][a-z2-7]{32}$ description: The ID of the file to use for this request. title: File Id description: The ID of the file to use for this request. responses: '200': description: The File object. content: application/json: schema: $ref: '#/components/schemas/FileObject' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - Files - OpenAI summary: Delete an uploaded file (OpenAI format) description: Permanently deletes a file by ID and returns a deletion confirmation (OpenAI Files API). operationId: openai_files_delete security: - HTTPBearer: [] - APIKeyHeader: [] parameters: - name: file_id in: path required: true schema: type: string pattern: ^file[-_][a-z2-7]{32}$ description: The ID of the file to use for this request. title: File Id description: The ID of the file to use for this request. responses: '200': description: Deletion status. content: application/json: schema: $ref: '#/components/schemas/FileDeleted' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/files/{file_id}/content: get: tags: - Files - OpenAI summary: Download the raw content of an uploaded file (OpenAI format) description: Returns the raw binary content of a file as a streaming download (OpenAI Files API). operationId: openai_file_content security: - HTTPBearer: [] - APIKeyHeader: [] parameters: - name: file_id in: path required: true schema: type: string pattern: ^file[-_][a-z2-7]{32}$ description: The ID of the file to use for this request. title: File Id description: The ID of the file to use for this request. responses: '200': description: The raw file content. content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/images/edits: post: tags: - Images - OpenAI summary: Edit or extend an image using inpainting (OpenAI format) description: 'Edits or extends an image based on a text prompt and optional mask (OpenAI Images Edits API). Accepts one or more source images with an optional mask for inpainting, then generates an edited version. Supports streaming via SSE for incremental partial-image previews. **Providing images:** Use `multipart/form-data` for direct binary uploads, or `application/json` to reference images by Files API ID (obtained from `openai_file`) or by URL/data URL. **Find compatible models:** Call `search_models` with `mcp_tool=openai_image_edit` to discover model IDs that support image editing.' operationId: openai_image_edit requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_openai_image_edit' examples: inpaint: summary: Inpaint with mask value: model: amazon.nova-canvas-v1:0 prompt: A red apple on a wooden table response_format: url n: 1 size: 1024x1024 stream: summary: Streaming response value: model: amazon.nova-canvas-v1:0 prompt: A sunset over mountains stream: true partial_images: 2 application/json: examples: file_id: summary: Edit image by Files API ID value: model: amazon.nova-canvas-v1:0 prompt: A red apple on a wooden table images: - file_id: file-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx response_format: url n: 1 size: 1024x1024 image_url: summary: Edit image by URL value: model: amazon.nova-canvas-v1:0 prompt: A sunset over mountains images: - image_url: https://example.com/image.png stream: true partial_images: 2 responses: '200': description: Images successfully edited. content: application/json: schema: {} '400': description: Invalid request or unsupported parameters. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] - APIKeyHeader: [] /v1/images/generations: post: tags: - Images - OpenAI summary: Generate images from a text prompt (OpenAI format) description: 'Creates one or more images from a text prompt (OpenAI Images Generations API). Returns image URLs or base64-encoded data (`b64_json`). Supports streaming via SSE for incremental partial-image previews while generation is in progress (`stream=true`). Multiple images can be requested with the `n` parameter. **Find compatible models:** Call `search_models` with `mcp_tool=openai_image_generation` to discover model IDs that support image generation.' operationId: openai_image_generation requestBody: content: application/json: schema: $ref: '#/components/schemas/ImageGenerateParams' examples: url: summary: Return image URL value: prompt: A watercolor of a fox in the woods model: amazon.nova-canvas-v1:0 response_format: url b64: summary: Return base64 data value: prompt: A watercolor of a fox in the woods model: amazon.nova-canvas-v1:0 response_format: b64_json stream: summary: Streaming SSE value: prompt: A watercolor of a fox in the woods model: amazon.nova-canvas-v1:0 stream: true required: true responses: '200': description: Images successfully generated. content: application/json: schema: $ref: '#/components/schemas/ImagesResponse' '400': description: Invalid request or unsupported parameters. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] - APIKeyHeader: [] /v1/images/variations: post: tags: - Images - OpenAI summary: Create variations of an existing image (OpenAI format) description: 'Creates one or more stylistic variations of a given image (OpenAI Images Variations API). **Providing the source image:** Use `multipart/form-data` for a direct binary upload, or `application/json` body to reference the image by Files API ID (obtained from `openai_file`) or by URL/data URL. Returns image URLs or base64-encoded data. Multiple variations can be requested with `n`. **Note:** Streaming is not supported for this endpoint — use `openai_image_generation` or `openai_image_edit` if you need streaming with partial previews. **Find compatible models:** Call `search_models` with `mcp_tool=openai_image_variation` to discover model IDs that support image variation.' operationId: openai_image_variation requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_openai_image_variation' examples: url: summary: Return image URL value: model: amazon.nova-canvas-v1:0 response_format: url n: 1 size: 1024x1024 b64: summary: Return base64 data value: model: amazon.nova-canvas-v1:0 response_format: b64_json n: 2 size: 512x512 application/json: examples: file_id: summary: Variation from Files API ID value: model: amazon.nova-canvas-v1:0 image: file_id: file-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx response_format: url n: 1 size: 1024x1024 image_url: summary: Variation from URL value: model: amazon.nova-canvas-v1:0 image: image_url: https://example.com/image.png response_format: b64_json n: 2 size: 512x512 responses: '200': description: Image variations successfully created. content: application/json: schema: $ref: '#/components/schemas/ImagesResponse' '400': description: Invalid request or unsupported parameters. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] - APIKeyHeader: [] /v1/models: get: tags: - Models - OpenAI summary: List available models (OpenAI format) description: 'Lists all currently available models with basic metadata (owner, creation date) (OpenAI Models API). **Agent note:** For richer filtering — by modality, route, MCP tool, region, or legacy status — use `search_models` instead.' operationId: openai_model_list responses: '200': description: List of available models. content: application/json: schema: $ref: '#/components/schemas/ModelsResponse' examples: list: summary: Example list value: object: list data: - id: amazon.nova-micro-v1:0 object: model created: 1640995200 owned_by: Amazon (AWS Bedrock us-east-1) - id: amazon.titan-embed-text-v2:0 object: model created: 1640995200 owned_by: Amazon (AWS Bedrock eu-west-3) security: - HTTPBearer: [] - APIKeyHeader: [] /v1/models/{model}: get: tags: - Models - OpenAI summary: Retrieve details for a specific model by ID (OpenAI format) description: 'Retrieves basic metadata (owner, creation date) for a single model by ID (OpenAI Models API). **Agent note:** Use `search_models` to look up modalities, supported routes, regions, and other extended metadata not available here.' operationId: openai_model_get security: - HTTPBearer: [] - APIKeyHeader: [] parameters: - name: model in: path required: true schema: type: string minLength: 1 maxLength: 255 description: The ID of the model to use for this request examples: - amazon.nova-micro-v1:0 str_strip_whitespace: true title: Model description: The ID of the model to use for this request responses: '200': description: Model retrieved successfully content: application/json: schema: $ref: '#/components/schemas/Model' examples: model: summary: Example model value: id: amazon.nova-micro-v1:0 object: model created: 1640995200 owned_by: Amazon (AWS Bedrock us-east-1) '404': description: Model not found content: application/json: examples: not_found: summary: Model not found value: error: message: The model `unknown` does not exist or you do not have access to it. type: invalid_request_error code: model_not_found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/responses: post: tags: - Chat - OpenAI summary: Generate a model response using the Responses API (OpenAI format) description: 'Creates a model response (OpenAI Responses API). Supports streaming, tool calling, and structured outputs. Returns a `Response` object, or a stream of `ResponseStreamEvent` objects when `stream=true`. **Supported input modalities:** - **Text:** Plain strings or `input_text` content blocks. - **Images:** `input_image` content blocks with a URL, data URI, base64 image, or Files API `file_id` obtained from `openai_file`. - **Files:** `input_file` content blocks with a URL, base64 data, or Files API `file_id` obtained from `openai_file`. - **Audio input** is not supported — use `openai_chat_completion` for audio input. **When to use:** This is the newer OpenAI API style. For the classic `messages`-array format, use `openai_chat_completion` instead. For Anthropic SDK compatibility, use `anthropic_message`. **Find compatible models:** Call `search_models` with `mcp_tool=openai_response` to discover model IDs that support this endpoint. For image inputs, also add `input_modalities=IMAGE` to the filter.' operationId: openai_response requestBody: content: application/json: schema: $ref: '#/components/schemas/ResponseCreateParams' required: true responses: '200': description: A model response. content: application/json: schema: $ref: '#/components/schemas/Response' '400': description: Invalid request or unsupported parameters. '404': description: Model not found. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] - APIKeyHeader: [] /v1/responses/input_tokens: post: tags: - Chat - OpenAI summary: Count input tokens for a Responses request without generating a response (OpenAI format) description: 'Counts the number of tokens a given request would consume, without creating a response. Accepts the same input as `openai_response` (messages, instructions, tools, images, files) and returns only the token count. Useful for estimating costs or checking context-window fit before making a full `openai_response` call. **Find compatible models:** Call `search_models` with `mcp_tool=openai_response_input_tokens` to discover model IDs that support this endpoint.' operationId: openai_response_input_tokens requestBody: content: application/json: schema: $ref: '#/components/schemas/InputTokenCountParams' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/InputTokenCountResponse' example: object: response.input_tokens input_tokens: 142 '400': description: Invalid request or unsupported parameters. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] - APIKeyHeader: [] /v1/uploads: post: tags: - Files - OpenAI summary: Create a multipart upload session for large files (OpenAI format) description: 'Creates a multipart upload session for uploading large files in chunks (OpenAI Uploads API). **Multipart upload workflow:** 1. Call `openai_upload` to create a session and get an `upload_id`. 2. Upload file chunks with `openai_upload_part` (one call per chunk). 3. Call `openai_upload_complete` with the ordered list of part IDs to assemble the final file. 4. Optionally call `openai_upload_cancel` to abort a pending session. For small files, use `openai_file` instead — it uploads in a single request.' operationId: openai_upload requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUploadBody' required: true responses: '200': description: The Upload object. content: application/json: schema: $ref: '#/components/schemas/Upload' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] - APIKeyHeader: [] /v1/uploads/{upload_id}/parts: post: tags: - Files - OpenAI summary: Upload a chunk in a multipart upload session (OpenAI format) description: 'Adds a binary chunk (Part) to an existing multipart upload session (OpenAI Uploads API). **Prerequisite:** Create an upload session first with `openai_upload`. Call this endpoint once per chunk, then finalise with `openai_upload_complete`. **MCP / AI agent usage:** Pass the chunk as a JSON body with ``data`` set to a base64 string, data URI (``data:;base64,``), HTTPS URL, or S3 URI.' operationId: openai_upload_part security: - HTTPBearer: [] - APIKeyHeader: [] parameters: - name: upload_id in: path required: true schema: type: string pattern: ^upload_[a-z2-7]{32}$ description: The ID of the upload. title: Upload Id description: The ID of the upload. requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_openai_upload_part' responses: '200': description: The upload Part object. content: application/json: schema: $ref: '#/components/schemas/UploadPart' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/uploads/{upload_id}/complete: post: tags: - Files - OpenAI summary: Complete a multipart upload and create the final file (OpenAI format) description: 'Assembles all uploaded parts into a final `File` object and marks the session as completed (OpenAI Uploads API). **Prerequisite:** All parts must have been uploaded via `openai_upload_part`. Provide the ordered list of part IDs returned by those calls. The resulting file behaves like a file uploaded with `openai_file`.' operationId: openai_upload_complete security: - HTTPBearer: [] - APIKeyHeader: [] parameters: - name: upload_id in: path required: true schema: type: string pattern: ^upload_[a-z2-7]{32}$ description: The ID of the upload. title: Upload Id description: The ID of the upload. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CompleteUploadBody' responses: '200': description: The completed Upload object with a nested File object. content: application/json: schema: $ref: '#/components/schemas/Upload' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/uploads/{upload_id}/cancel: post: tags: - Files - OpenAI summary: Cancel a pending multipart upload session (OpenAI format) description: 'Cancels a pending multipart upload session; no further parts can be added (OpenAI Uploads API). **Prerequisite:** The session must have been created with `openai_upload` and not yet completed or cancelled.' operationId: openai_upload_cancel security: - HTTPBearer: [] - APIKeyHeader: [] parameters: - name: upload_id in: path required: true schema: type: string pattern: ^upload_[a-z2-7]{32}$ description: The ID of the upload. title: Upload Id description: The ID of the upload. responses: '200': description: The cancelled Upload object. content: application/json: schema: $ref: '#/components/schemas/Upload' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: AcknowledgedSafetyCheck: properties: id: type: string title: Id description: Safety check ID. code: anyOf: - type: string - type: 'null' title: Code description: Safety check type. message: anyOf: - type: string - type: 'null' title: Message description: Safety check details. additionalProperties: false type: object required: - id title: AcknowledgedSafetyCheck description: An acknowledged safety check for a computer call output. AmazonBedrockGuardrailConfigParams: properties: tagSuffix: anyOf: - type: string - type: 'null' title: Tagsuffix description: Amazon Bedrock Guardrail input tagging. UNSUPPORTED on this implementation. type: object title: AmazonBedrockGuardrailConfigParams description: Amazon Bedrock Guardrail configuration parameters. Annotation: properties: type: type: string const: url_citation title: Type description: Citation type. Always `url_citation`. url_citation: $ref: '#/components/schemas/stdapi__types__openai_chat_completions__AnnotationURLCitation' description: URL citation from web search. additionalProperties: false type: object required: - type - url_citation title: Annotation description: Annotation for the message when using web search. AnnotationContainerFileCitation: properties: container_id: type: string title: Container Id description: Container file ID. end_index: type: integer title: End Index description: Last character index of container file citation. file_id: type: string title: File Id description: File ID. filename: type: string title: Filename description: Container filename. start_index: type: integer title: Start Index description: First character index of container file citation. type: type: string const: container_file_citation title: Type description: Container file citation type. additionalProperties: false type: object required: - container_id - end_index - file_id - filename - start_index - type title: AnnotationContainerFileCitation description: A citation for a container file used to generate a model response. AnnotationFileCitation: properties: file_id: type: string title: File Id description: File ID. filename: type: string title: Filename description: Filename. index: type: integer title: Index description: File index. type: type: string const: file_citation title: Type description: File citation type. additionalProperties: false type: object required: - file_id - filename - index - type title: AnnotationFileCitation description: A citation to a file. AnnotationFilePath: properties: file_id: type: string title: File Id description: File ID. index: type: integer title: Index description: File index. type: type: string const: file_path title: Type description: File path type. additionalProperties: false type: object required: - file_id - index - type title: AnnotationFilePath description: A path to a file. AnnotationURLCitation-Input: properties: end_index: type: integer title: End Index description: Last character index of URL citation. start_index: type: integer title: Start Index description: First character index of URL citation. title: type: string title: Title description: Web resource title. type: type: string const: url_citation title: Type description: URL citation type. url: type: string title: Url description: Web resource URL. additionalProperties: false type: object required: - end_index - start_index - title - type - url title: AnnotationURLCitation description: A citation for a web resource used to generate a model response. ApplyPatchCall: properties: call_id: type: string title: Call Id description: The unique ID of the apply patch tool call generated by the model. operation: oneOf: - $ref: '#/components/schemas/ApplyPatchOperationCreateFile' - $ref: '#/components/schemas/ApplyPatchOperationDeleteFile' - $ref: '#/components/schemas/ApplyPatchOperationUpdateFile' title: Operation description: The specific create, delete, or update instruction for the apply_patch tool call. discriminator: propertyName: type mapping: create_file: '#/components/schemas/ApplyPatchOperationCreateFile' delete_file: '#/components/schemas/ApplyPatchOperationDeleteFile' update_file: '#/components/schemas/ApplyPatchOperationUpdateFile' status: type: string enum: - in_progress - completed title: Status description: The status of the apply patch tool call. One of `in_progress` or `completed`. type: type: string const: apply_patch_call title: Type description: The type of the item. Always `apply_patch_call`. id: anyOf: - type: string - type: 'null' title: Id description: The unique ID of the apply patch tool call. Populated when this item is returned via API. type: object required: - call_id - operation - status - type title: ApplyPatchCall description: A tool call representing a request to create, delete, or update files using diff patches. ApplyPatchCallOutput: properties: call_id: type: string title: Call Id description: The unique ID of the apply patch tool call generated by the model. status: type: string enum: - completed - failed title: Status description: The status of the apply patch tool call output. type: type: string const: apply_patch_call_output title: Type description: The type of the item. Always `apply_patch_call_output`. id: anyOf: - type: string - type: 'null' title: Id description: The unique ID of the apply patch tool call output. Populated when this item is returned via API. output: anyOf: - type: string - type: 'null' title: Output description: Optional human-readable log text from the apply patch tool. type: object required: - call_id - status - type title: ApplyPatchCallOutput description: The streamed output emitted by an apply patch tool call (as input item). ApplyPatchOperationCreateFile: properties: diff: type: string title: Diff description: Diff content for new file. path: type: string title: Path description: Path relative to workspace root. type: type: string const: create_file title: Type description: Create file operation. type: object required: - diff - path - type title: ApplyPatchOperationCreateFile description: Instruction for creating a new file via the apply_patch tool. ApplyPatchOperationDeleteFile: properties: path: type: string title: Path description: Path to delete. type: type: string const: delete_file title: Type description: Delete file operation. type: object required: - path - type title: ApplyPatchOperationDeleteFile description: Instruction for deleting an existing file via the apply_patch tool. ApplyPatchOperationUpdateFile: properties: diff: type: string title: Diff description: Diff content to apply. path: type: string title: Path description: Path to update. type: type: string const: update_file title: Type description: Update file operation. type: object required: - diff - path - type title: ApplyPatchOperationUpdateFile description: Instruction for updating an existing file via the apply_patch tool. ApplyPatchTool: properties: type: type: string const: apply_patch title: Type description: Apply patch tool type. type: object required: - type title: ApplyPatchTool description: 'Allows the assistant to create, delete, or update files using unified diffs. UNSUPPORTED on this implementation.' Audio: properties: id: type: string title: Id description: ID of a previous audio response from the model. type: object required: - id title: Audio description: Data about a previous audio response from the model. Base64ImageSource: properties: type: type: string const: base64 title: Type description: Image source type. media_type: type: string title: Media Type description: Image media type. data: type: string minLength: 1 title: Data description: Base64 encoded image data, data URI, S3 URI, or URL. type: object required: - type - media_type - data title: Base64ImageSource description: Image source for image content block. Base64PDFSource: properties: type: type: string const: base64 title: Type description: Document source type. media_type: type: string const: application/pdf title: Media Type description: Document media type. Only `application/pdf` is supported. data: type: string minLength: 1 title: Data description: Base64 encoded document data, data URI, S3 URI, or URL. type: object required: - type - media_type - data title: Base64PDFSource description: Document source for document content block. BashCodeExecutionOutputBlock: properties: file_id: type: string title: File Id description: File ID. type: type: string const: bash_code_execution_output title: Type description: Type discriminator. additionalProperties: false type: object required: - file_id - type title: BashCodeExecutionOutputBlock description: Bash code execution output block. BashCodeExecutionOutputBlockParam: properties: file_id: type: string title: File Id description: File ID. type: type: string const: bash_code_execution_output title: Type description: Type discriminator. type: object required: - file_id - type title: BashCodeExecutionOutputBlockParam description: Bash code execution output block parameter. BashCodeExecutionResultBlock: properties: content: items: $ref: '#/components/schemas/BashCodeExecutionOutputBlock' type: array title: Content description: Block content. return_code: type: integer title: Return Code description: Return code. stderr: type: string title: Stderr description: Stderr. stdout: type: string title: Stdout description: Stdout. type: type: string const: bash_code_execution_result title: Type description: Type discriminator. additionalProperties: false type: object required: - content - return_code - stderr - stdout - type title: BashCodeExecutionResultBlock description: Bash code execution result block. BashCodeExecutionResultBlockParam: properties: content: items: $ref: '#/components/schemas/BashCodeExecutionOutputBlockParam' type: array title: Content description: Block content. return_code: type: integer title: Return Code description: Return code. stderr: type: string title: Stderr description: Stderr. stdout: type: string title: Stdout description: Stdout. type: type: string const: bash_code_execution_result title: Type description: Type discriminator. type: object required: - content - return_code - stderr - stdout - type title: BashCodeExecutionResultBlockParam description: Bash code execution result block parameter. BashCodeExecutionToolResultBlock: properties: content: anyOf: - $ref: '#/components/schemas/BashCodeExecutionToolResultError' - $ref: '#/components/schemas/BashCodeExecutionResultBlock' title: Content description: Block content. tool_use_id: type: string title: Tool Use Id description: Tool use ID. type: type: string const: bash_code_execution_tool_result title: Type description: Type discriminator. additionalProperties: false type: object required: - content - tool_use_id - type title: BashCodeExecutionToolResultBlock description: Bash code execution tool result block. BashCodeExecutionToolResultBlockParam: properties: content: anyOf: - $ref: '#/components/schemas/BashCodeExecutionToolResultErrorParam' - $ref: '#/components/schemas/BashCodeExecutionResultBlockParam' title: Content tool_use_id: type: string title: Tool Use Id description: Tool use ID. type: type: string const: bash_code_execution_tool_result title: Type description: Type discriminator. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. type: object required: - content - tool_use_id - type title: BashCodeExecutionToolResultBlockParam description: Bash code execution tool result block parameter. BashCodeExecutionToolResultError: properties: error_code: type: string enum: - invalid_tool_input - unavailable - too_many_requests - execution_time_exceeded - output_file_too_large title: Error Code description: Error code. type: type: string const: bash_code_execution_tool_result_error title: Type description: Type discriminator. additionalProperties: false type: object required: - error_code - type title: BashCodeExecutionToolResultError description: Bash code execution tool result error. BashCodeExecutionToolResultErrorParam: properties: error_code: type: string enum: - invalid_tool_input - unavailable - too_many_requests - execution_time_exceeded - output_file_too_large title: Error Code description: Error code. type: type: string const: bash_code_execution_tool_result_error title: Type description: Type discriminator. type: object required: - error_code - type title: BashCodeExecutionToolResultErrorParam description: Bash code execution tool result error parameter. Body_anthropic_file: properties: file: anyOf: - type: string contentMediaType: application/octet-stream - type: 'null' title: File description: The file to upload. Use an ``application/json`` body to pass a base64 string, data URI, or URL instead. type: object title: Body_anthropic_file Body_openai_audio_transcription: properties: file: anyOf: - type: string contentMediaType: application/octet-stream - type: 'null' title: File description: 'The audio file to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. Use an ``application/json`` body to pass a base64 string, data URI, or URL instead.' model: type: string title: Model description: 'The transcription model to use. Available models: amazon.transcribe' default: amazon.transcribe language: anyOf: - type: string - type: 'null' title: Language description: 'The language of the input audio. Supplying it in ISO-639-1 format (e.g. `en`) improves accuracy and latency.' prompt: anyOf: - type: string - type: 'null' title: Prompt description: 'An optional text to guide the model''s style or continue a previous audio segment. The prompt should match the audio language.' chunking_strategy: anyOf: - type: string const: auto - $ref: '#/components/schemas/ChunkingStrategyVadConfig' title: Chunking Strategy description: 'Controls how the audio is cut into chunks. `auto` normalizes loudness then uses voice activity detection (VAD) to choose boundaries; a `server_vad` object tunes VAD parameters manually. server_vad is UNSUPPORTED on this implementation.' default: auto response_format: type: string enum: - json - text - srt - verbose_json - vtt - diarized_json title: Response Format description: Transcript output format. default: json timestamp_granularities: type: string title: Timestamp Granularities description: 'Comma-separated timestamp granularities to populate (e.g. `word,segment`): `word` and/or `segment`. Requires `response_format=verbose_json`.' default: '' include: anyOf: - type: string const: logprobs - type: 'null' title: Include description: 'Additional information to include in the transcription response. `logprobs` returns token log probabilities (confidence) and only works with `response_format=json`.' temperature: anyOf: - type: number - type: 'null' title: Temperature description: 'The sampling temperature, between `0` and `1`. Higher values like `0.8` will make the output more random, while lower values like `0.2` will make it more focused and deterministic.' stream: anyOf: - type: boolean - type: 'null' title: Stream description: If set to true, the model response data will be streamed to the client as it is generated using server-sent events. default: false known_speaker_names: anyOf: - items: type: string type: array - type: 'null' title: Known Speaker Names description: 'Speaker names corresponding to the samples in `known_speaker_references[]` (e.g. `customer`, `agent`). UNSUPPORTED on this implementation.' known_speaker_references: anyOf: - items: type: string type: array - type: 'null' title: Known Speaker References description: 'Audio samples (as data URLs, 2-10 seconds each, same formats as `file`) for known-speaker diarization, matching `known_speaker_names[]`. UNSUPPORTED on this implementation.' type: object title: Body_openai_audio_transcription Body_openai_audio_translation: properties: file: anyOf: - type: string contentMediaType: application/octet-stream - type: 'null' title: File description: 'The audio file to translate, in one of these formats: flac, m4a, mp3, mp4, mpeg, mpga, oga, ogg, wav, webm. Use an ``application/json`` body to pass a base64 string, data URI, or URL instead.' model: type: string title: Model description: 'The transcription model to use. Available models: amazon.transcribe' default: amazon.transcribe prompt: anyOf: - type: string - type: 'null' title: Prompt description: 'An optional text to guide the model''s style or continue a previous audio segment. The prompt should be in English. UNSUPPORTED on this implementation.' response_format: type: string enum: - json - text - srt - verbose_json - vtt title: Response Format description: Transcript output format. default: json temperature: anyOf: - type: number - type: 'null' title: Temperature description: 'The sampling temperature, between `0` and `1`. Higher values like `0.8` will make the output more random, while lower values like `0.2` will make it more focused and deterministic.' type: object title: Body_openai_audio_translation Body_openai_file: properties: file: anyOf: - type: string contentMediaType: application/octet-stream - type: 'null' title: File description: The File object (not file name) to be uploaded. Use an ``application/json`` body to pass a base64 string, data URI, or URL instead. purpose: type: string enum: - assistants - batch - fine-tune - vision - user_data - evals title: Purpose description: 'Intended purpose of the file: `assistants` (Assistants API), `batch` (Batch API), `fine-tune` (fine-tuning), `vision` (vision fine-tuning images), `user_data` (any purpose), or `evals` (eval datasets).' default: assistants expires_after_anchor: anyOf: - type: string const: created_at - type: 'null' title: Expires After Anchor description: 'Anchor timestamp after which the expiration policy applies. Supported anchors: `created_at`.' expires_after_seconds: anyOf: - type: integer maximum: 2592000.0 minimum: 3600.0 - type: 'null' title: Expires After Seconds description: Seconds after the anchor time until the file expires (1 hour to 30 days). By default, `purpose=batch` files expire after 30 days; all other files persist until manually deleted. type: object title: Body_openai_file Body_openai_image_edit: properties: image: anyOf: - items: type: string contentMediaType: application/octet-stream type: array - type: 'null' title: Image description: The image(s) to edit. Accepts binary file uploads. For Files API identifiers or URLs, use ``application/json`` body instead. prompt: type: string title: Prompt description: A text description of the desired image(s). Required for a majority of models. default: '' model: type: string maxLength: 255 minLength: 1 title: Model description: The model to use for image generation. default: '' mask: anyOf: - type: string contentMediaType: application/octet-stream - type: 'null' title: Mask description: An additional image indicating where the image should be edited. The mask format is model-specific and may be a black/white image or an image with transparency (e.g. where alpha is zero indicates areas to edit). response_format: type: string title: Response Format description: 'The format for returned images: url or b64_json. URLs expire after 60 minutes. Streaming always returns base64-encoded images, regardless of this setting.' default: url n: type: integer maximum: 10.0 minimum: 1.0 title: N description: The number of images to generate. default: 1 size: type: string pattern: ^(\d+)x(\d+)$ title: Size description: The size of the generated images. Supported values depend on the model; output size may differ for some models. default: 1024x1024 user: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: User description: A unique identifier representing your end-user, which can help to monitor and detect abuse. background: anyOf: - type: string const: auto - type: string enum: - transparent - opaque title: Background description: 'Background transparency setting. If `transparent`, `output_format` must be `png` or `webp`. transparent is UNSUPPORTED on this implementation.' default: auto input_fidelity: type: string enum: - low - high title: Input Fidelity description: 'Effort level for matching the style and features (especially facial features) of input images. UNSUPPORTED on this implementation.' default: low output_compression: type: integer maximum: 100.0 minimum: 1.0 title: Output Compression description: The compression level (0-100%) for the generated images. default: 100 output_format: anyOf: - type: string enum: - png - jpeg - webp - type: 'null' title: Output Format description: 'The output image format: `png`, `jpeg`, or `webp`.' partial_images: anyOf: - type: integer maximum: 3.0 minimum: 0.0 - type: 'null' title: Partial Images description: Number of partial images to generate during streaming (0-3; requires `stream=true`). 0 sends the final image as a single event. The final image may arrive before all partial images if generation finishes early, and partial images are only sent if the model supports them. quality: type: string maxLength: 255 minLength: 1 title: Quality description: Image quality. `auto` selects the best quality for the model; supported values depend on the model. default: auto stream: type: boolean title: Stream description: Generate the image in streaming mode. default: false type: object title: Body_openai_image_edit Body_openai_image_variation: properties: image: anyOf: - type: string contentMediaType: application/octet-stream - type: 'null' title: Image description: The image to use as the basis for the variation(s). Accepts a binary file upload. For Files API identifiers or URLs, use ``application/json`` body instead. model: type: string maxLength: 255 minLength: 1 title: Model description: The model to use for image generation. default: '' response_format: type: string title: Response Format description: 'The format for returned images: url or b64_json. URLs expire after 60 minutes.' default: url n: type: integer maximum: 10.0 minimum: 1.0 title: N description: The number of images to generate. default: 1 size: type: string pattern: ^(\d+)x(\d+)$ title: Size description: The size of the generated images. Supported values depend on the model; output size may differ for some models. default: 1024x1024 user: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: User description: A unique identifier representing your end-user, which can help to monitor and detect abuse. type: object title: Body_openai_image_variation Body_openai_upload_part: properties: data: anyOf: - type: string contentMediaType: application/octet-stream - type: 'null' title: Data description: The chunk of bytes for this Part. type: object title: Body_openai_upload_part CacheControlEphemeralParam: properties: type: type: string const: ephemeral title: Type description: Cache control type. default: ephemeral ttl: anyOf: - type: string enum: - 5m - 1h - type: 'null' title: Ttl description: Cache TTL. type: object title: CacheControlEphemeralParam description: Cache control configuration for prompt caching. CacheCreation: properties: ephemeral_1h_input_tokens: type: integer title: Ephemeral 1H Input Tokens description: The number of input tokens used to create the 1 hour cache entry. ephemeral_5m_input_tokens: type: integer title: Ephemeral 5M Input Tokens description: The number of input tokens used to create the 5 minute cache entry. additionalProperties: false type: object required: - ephemeral_1h_input_tokens - ephemeral_5m_input_tokens title: CacheCreation description: Cache creation token usage breakdown. ChatCompletion: properties: id: type: string title: Id description: Unique ID for the chat completion. created: type: integer title: Created description: Unix timestamp (seconds) when the chat completion was created. model: type: string title: Model description: Model used for the chat completion. usage: anyOf: - $ref: '#/components/schemas/CompletionUsage' - type: 'null' description: Usage statistics for the completion request. service_tier: anyOf: - type: string enum: - auto - default - flex - scale - priority - reserved - type: 'null' title: Service Tier description: 'Processing type: ''auto'', ''priority'', ''flex'', ''default'', ''scale'', or ''reserved''.' system_fingerprint: anyOf: - type: string - type: 'null' title: System Fingerprint description: Backend configuration fingerprint. Use with `seed` to check for determinism changes. choices: items: $ref: '#/components/schemas/Choice' type: array title: Choices description: List of chat completion choices. Can be multiple if `n > 1`. object: type: string const: chat.completion title: Object description: Object type. Always `chat.completion`. additionalProperties: false type: object required: - id - created - model - choices - object title: ChatCompletion description: OpenAI-compatible chat completion object (non-streaming). ChatCompletionAllowedToolChoiceParam: properties: type: type: string const: allowed_tools title: Type description: Allowed tools choice type. Always `allowed_tools`. allowed_tools: $ref: '#/components/schemas/ChatCompletionAllowedToolsParam' description: Constrains the tools available to the model to a pre-defined set. type: object required: - type - allowed_tools title: ChatCompletionAllowedToolChoiceParam description: Allowed tools list choice. Used by OpenAI; mapped to auto in this project. ChatCompletionAllowedToolsParam: properties: mode: type: string enum: - auto - required title: Mode description: 'Tool selection mode: `auto` lets model pick, `required` forces a tool call.' tools: items: oneOf: - $ref: '#/components/schemas/ChatCompletionNamedToolChoiceParam' - $ref: '#/components/schemas/ChatCompletionNamedToolChoiceCustomParam' discriminator: propertyName: type mapping: custom: '#/components/schemas/ChatCompletionNamedToolChoiceCustomParam' function: '#/components/schemas/ChatCompletionNamedToolChoiceParam' type: array title: Tools description: List of tool definitions the model can call. type: object required: - mode - tools title: ChatCompletionAllowedToolsParam description: Allowed tools for function tools. ChatCompletionAssistantMessageParam: properties: name: anyOf: - type: string - type: 'null' title: Name description: Optional participant name to differentiate same-role participants. role: type: string const: assistant title: Role description: Message author role. Always `assistant`. audio: anyOf: - $ref: '#/components/schemas/Audio' - type: 'null' description: Data about a previous audio response from the model. content: anyOf: - type: string - items: oneOf: - $ref: '#/components/schemas/ChatCompletionContentPartTextParam' - $ref: '#/components/schemas/ChatCompletionContentPartRefusalParam' discriminator: propertyName: type mapping: refusal: '#/components/schemas/ChatCompletionContentPartRefusalParam' text: '#/components/schemas/ChatCompletionContentPartTextParam' type: array - type: 'null' title: Content description: Assistant message content. Required unless `tool_calls` or `function_call` is specified. function_call: anyOf: - $ref: '#/components/schemas/FunctionCall' - type: 'null' description: Deprecated. Use `tool_calls` instead. Function name and arguments. refusal: anyOf: - type: string - type: 'null' title: Refusal description: Refusal message from the assistant. tool_calls: anyOf: - items: oneOf: - $ref: '#/components/schemas/ChatCompletionMessageFunctionToolCall' - $ref: '#/components/schemas/ChatCompletionMessageCustomToolCall' discriminator: propertyName: type mapping: custom: '#/components/schemas/ChatCompletionMessageCustomToolCall' function: '#/components/schemas/ChatCompletionMessageFunctionToolCall' type: array - type: 'null' title: Tool Calls description: Tool calls generated by the model. reasoning_content: anyOf: - type: string - items: $ref: '#/components/schemas/ChatCompletionContentPartTextParam' type: array - type: 'null' title: Reasoning Content description: Reasoning content. Extra field from Deepseek Chat Completion API. prefix: anyOf: - type: boolean - type: 'null' title: Prefix description: Force model to start with the provided prefix. UNSUPPORTED on this implementation. type: object required: - role title: ChatCompletionAssistantMessageParam description: Assistant role message. ChatCompletionAudio: properties: id: type: string title: Id description: Unique ID for this audio response. data: type: string title: Data description: Base64-encoded audio bytes in the requested format. expires_at: type: integer minimum: 0.0 title: Expires At description: Unix timestamp (seconds) when audio expires and is no longer accessible. transcript: type: string title: Transcript description: Transcript of the generated audio. additionalProperties: false type: object required: - id - data - expires_at - transcript title: ChatCompletionAudio description: If audio output modality is requested, contains data about the audio response. ChatCompletionAudioParam: properties: format: type: string enum: - wav - aac - mp3 - flac - opus - pcm16 title: Format description: 'Output audio format: `wav`, `aac`, `mp3`, `flac`, `opus`, or `pcm16`.' voice: type: string title: Voice description: Voice for audio response. type: object required: - format - voice title: ChatCompletionAudioParam description: Parameters for audio output. ChatCompletionContentPartImageParam: properties: type: type: string const: image_url title: Type description: Content part type. Always `image_url`. image_url: $ref: '#/components/schemas/ImageURL' description: URL descriptor containing the image `url` field. type: object required: - type - image_url title: ChatCompletionContentPartImageParam description: Image message content part (via URL). ChatCompletionContentPartInputAudioParam: properties: input_audio: $ref: '#/components/schemas/InputAudio' description: Audio data descriptor. type: type: string const: input_audio title: Type description: Content part type. Always `input_audio`. type: object required: - input_audio - type title: ChatCompletionContentPartInputAudioParam description: Input audio message content part. ChatCompletionContentPartRefusalParam: properties: type: type: string const: refusal title: Type description: Content part type. Always `refusal`. refusal: type: string title: Refusal description: Refusal content text. type: object required: - type - refusal title: ChatCompletionContentPartRefusalParam description: Refusal message content part. ChatCompletionContentPartTextParam: properties: type: type: string const: text title: Type description: Content part type. Always `text`. text: type: string title: Text description: Text content of the message part. type: object required: - type - text title: ChatCompletionContentPartTextParam description: Text message content part. ChatCompletionCustomToolParam: properties: type: type: string const: custom title: Type description: Tool type. Always `custom`. UNSUPPORTED on this implementation. custom: $ref: '#/components/schemas/Custom' description: Custom tool properties. UNSUPPORTED on this implementation. type: object required: - type - custom title: ChatCompletionCustomToolParam description: 'Custom tool specification. UNSUPPORTED on this implementation.' ChatCompletionDeveloperMessageParam: properties: name: anyOf: - type: string - type: 'null' title: Name description: Optional participant name to differentiate same-role participants. role: type: string const: developer title: Role description: Message author role. Always `developer`. content: anyOf: - type: string - items: $ref: '#/components/schemas/ChatCompletionContentPartTextParam' type: array title: Content description: Developer message content. type: object required: - role - content title: ChatCompletionDeveloperMessageParam description: Developer role message. ChatCompletionFunctionMessageParam: properties: role: type: string const: function title: Role description: Message author role. Always `function`. name: type: string title: Name description: The name of the function to call. content: anyOf: - type: string - type: 'null' title: Content description: Function message content. type: object required: - role - name - content title: ChatCompletionFunctionMessageParam description: Function role message. ChatCompletionFunctionToolParam: properties: type: type: string const: function title: Type description: Tool type. Always `function`. function: $ref: '#/components/schemas/FunctionDefinition' description: Function definition. type: object required: - type - function title: ChatCompletionFunctionToolParam description: Function tool specification. ChatCompletionMessage: properties: role: type: string const: assistant title: Role description: Message author role. Always `assistant`. content: anyOf: - type: string - type: 'null' title: Content description: Message content. refusal: anyOf: - type: string - type: 'null' title: Refusal description: Refusal message from the model. annotations: anyOf: - items: $ref: '#/components/schemas/Annotation' type: array - type: 'null' title: Annotations description: Message annotations from web search. audio: anyOf: - $ref: '#/components/schemas/ChatCompletionAudio' - type: 'null' description: Audio response data when audio output is requested. function_call: anyOf: - $ref: '#/components/schemas/FunctionCall' - type: 'null' description: Deprecated. Use `tool_calls` instead. Function name and arguments. deprecated: true tool_calls: anyOf: - items: oneOf: - $ref: '#/components/schemas/ChatCompletionMessageFunctionToolCall' - $ref: '#/components/schemas/ChatCompletionMessageCustomToolCall' discriminator: propertyName: type mapping: custom: '#/components/schemas/ChatCompletionMessageCustomToolCall' function: '#/components/schemas/ChatCompletionMessageFunctionToolCall' type: array - type: 'null' title: Tool Calls description: Tool calls generated by the model. reasoning_content: anyOf: - type: string - type: 'null' title: Reasoning Content description: Reasoning content. Extra field from Deepseek Chat Completion API. additionalProperties: false type: object required: - role title: ChatCompletionMessage description: Assistant message object in the non-streaming ChatCompletion. ChatCompletionMessageCustomToolCall: properties: type: type: string const: custom title: Type description: Tool type. Always `custom`. UNSUPPORTED on this implementation. custom: $ref: '#/components/schemas/stdapi__types__openai_chat_completions__CustomTool' description: The custom tool that the model called. UNSUPPORTED on this implementation. id: type: string title: Id description: The ID of the tool call. additionalProperties: false type: object required: - type - custom - id title: ChatCompletionMessageCustomToolCall description: 'Assistant tool call for a custom tool. UNSUPPORTED on this implementation.' ChatCompletionMessageFunctionToolCall: properties: type: type: string const: function title: Type description: Tool type. Always `function`. function: $ref: '#/components/schemas/FunctionCall' description: The function that the model called. id: type: string title: Id description: The ID of the tool call. additionalProperties: false type: object required: - type - function - id title: ChatCompletionMessageFunctionToolCall description: Assistant tool call for a function tool. ChatCompletionNamedToolChoiceCustomParam: properties: type: type: string const: custom title: Type description: Tool type. Always `custom`. UNSUPPORTED on this implementation. custom: $ref: '#/components/schemas/CustomToolChoice' description: Custom tool to call by name. UNSUPPORTED on this implementation. type: object required: - type - custom title: ChatCompletionNamedToolChoiceCustomParam description: 'Named tool choice for custom tools. UNSUPPORTED on this implementation.' ChatCompletionNamedToolChoiceParam: properties: type: type: string const: function title: Type description: For function calling, the type is always `function`. function: $ref: '#/components/schemas/FunctionToolChoiceParam' type: object required: - type - function title: ChatCompletionNamedToolChoiceParam description: Named tool choice for function tools. ChatCompletionPredictionContentParam: properties: type: type: string const: content title: Type description: The type of the predicted content. Always `content`. content: anyOf: - type: string - items: $ref: '#/components/schemas/ChatCompletionContentPartTextParam' type: array title: Content description: Content to match for predicted output. If generated tokens match this, response returns quickly. type: object required: - type - content title: ChatCompletionPredictionContentParam description: Predicted content hint to speed up responses. ChatCompletionStreamOptionsParam: properties: include_usage: type: boolean title: Include Usage description: 'If true, streams a usage chunk before `data: [DONE]` with token statistics. The `choices` field will be empty. Other chunks include a null usage field.' default: false include_obfuscation: type: boolean title: Include Obfuscation description: Enable stream obfuscation to normalize payload sizes for security. Adds overhead to the data stream; set to false to optimize bandwidth. default: false type: object title: ChatCompletionStreamOptionsParam description: Options for streaming responses. ChatCompletionSystemMessageParam: properties: name: anyOf: - type: string - type: 'null' title: Name description: Optional participant name to differentiate same-role participants. role: type: string const: system title: Role description: Message author role. Always `system`. content: anyOf: - type: string - items: $ref: '#/components/schemas/ChatCompletionContentPartTextParam' type: array title: Content description: System message content. type: object required: - role - content title: ChatCompletionSystemMessageParam description: System role message. ChatCompletionTokenLogprob: properties: token: type: string title: Token description: The token. bytes: anyOf: - items: type: integer type: array - type: 'null' title: Bytes description: UTF-8 byte representation of the token. Can be null if unavailable. logprob: type: number title: Logprob description: Log probability if in top 20 tokens, otherwise -9999.0. top_logprobs: items: $ref: '#/components/schemas/TopLogprob' type: array title: Top Logprobs description: List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned. additionalProperties: false type: object required: - token - logprob - top_logprobs title: ChatCompletionTokenLogprob description: Chat completion token log probability information. ChatCompletionToolMessageParam: properties: role: type: string const: tool title: Role description: Message author role. Always `tool`. content: anyOf: - type: string - items: $ref: '#/components/schemas/ChatCompletionContentPartTextParam' type: array title: Content description: Text content or list of text parts. tool_call_id: type: string title: Tool Call Id description: Tool call this message responds to. type: object required: - role - content - tool_call_id title: ChatCompletionToolMessageParam description: Tool role message. ChatCompletionUserMessageParam: properties: name: anyOf: - type: string - type: 'null' title: Name description: Optional participant name to differentiate same-role participants. role: type: string const: user title: Role description: Message author role. Always `user`. content: anyOf: - type: string - items: oneOf: - $ref: '#/components/schemas/ChatCompletionContentPartTextParam' - $ref: '#/components/schemas/ChatCompletionContentPartImageParam' - $ref: '#/components/schemas/ChatCompletionContentPartInputAudioParam' - $ref: '#/components/schemas/File' discriminator: propertyName: type mapping: file: '#/components/schemas/File' image_url: '#/components/schemas/ChatCompletionContentPartImageParam' input_audio: '#/components/schemas/ChatCompletionContentPartInputAudioParam' text: '#/components/schemas/ChatCompletionContentPartTextParam' type: array title: Content description: User message content. type: object required: - role - content title: ChatCompletionUserMessageParam description: User role message. Choice: properties: index: type: integer minimum: 0.0 title: Index description: Index of the choice in the list of choices. finish_reason: anyOf: - type: string enum: - stop - length - tool_calls - content_filter - function_call - type: 'null' title: Finish Reason description: 'Reason the model stopped: `stop`, `length`, `content_filter`, `tool_calls`, or `function_call` (deprecated).' logprobs: anyOf: - $ref: '#/components/schemas/ChoiceLogprobs' - type: 'null' description: Log probability information for the choice. message: $ref: '#/components/schemas/ChatCompletionMessage' description: Assistant message. additionalProperties: false type: object required: - index - message title: Choice description: Non-streaming choice element for ChatCompletion. ChoiceLogprobs: properties: content: anyOf: - items: $ref: '#/components/schemas/ChatCompletionTokenLogprob' type: array - type: 'null' title: Content description: A list of message content tokens with log probability information. refusal: anyOf: - items: $ref: '#/components/schemas/ChatCompletionTokenLogprob' type: array - type: 'null' title: Refusal description: A list of message refusal tokens with log probability information. additionalProperties: false type: object title: ChoiceLogprobs description: Log probability information for the choice. ChunkingStrategyVadConfig: properties: type: type: string const: server_vad title: Type description: Must be set to `server_vad` to enable manual chunking using server side VAD. prefix_padding_ms: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Prefix Padding Ms description: Amount of audio to include before the VAD detected speech (in milliseconds). silence_duration_ms: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Silence Duration Ms description: Duration of silence to detect speech stop (in milliseconds). Shorter values respond faster but may cut in on short pauses. threshold: anyOf: - type: number maximum: 1.0 minimum: 0.0 - type: 'null' title: Threshold description: Sensitivity threshold (0.0 to 1.0) for voice activity detection. Higher values require louder audio to activate. type: object required: - type title: ChunkingStrategyVadConfig description: Manual server-side VAD chunking configuration. CitationCharLocation: properties: type: type: string const: char_location title: Type description: Citation type. document_title: anyOf: - type: string - type: 'null' title: Document Title description: Title of the cited document. cited_text: type: string title: Cited Text description: Cited text content. document_index: type: integer title: Document Index description: Index of the cited document. end_char_index: type: integer title: End Char Index description: End character index. file_id: anyOf: - type: string - type: 'null' title: File Id description: File ID. start_char_index: type: integer title: Start Char Index description: Start character index. additionalProperties: false type: object required: - type - cited_text - document_index - end_char_index - start_char_index title: CitationCharLocation description: Character location citation. CitationCharLocationParam: properties: cited_text: type: string title: Cited Text description: Cited text content. document_index: type: integer title: Document Index description: Index of the cited document. document_title: anyOf: - type: string - type: 'null' title: Document Title description: Title of the cited document. end_char_index: type: integer title: End Char Index description: End character index. start_char_index: type: integer title: Start Char Index description: Start character index. type: type: string const: char_location title: Type description: Type discriminator. type: object required: - cited_text - document_index - end_char_index - start_char_index - type title: CitationCharLocationParam description: Citation char location parameter. CitationContentBlockLocation: properties: type: type: string const: content_block_location title: Type description: Citation type. document_title: anyOf: - type: string - type: 'null' title: Document Title description: Title of the cited document. cited_text: type: string title: Cited Text description: Cited text content. document_index: type: integer title: Document Index description: Index of the cited document. end_block_index: type: integer title: End Block Index description: End content block index. file_id: anyOf: - type: string - type: 'null' title: File Id description: File ID. start_block_index: type: integer title: Start Block Index description: Start content block index. additionalProperties: false type: object required: - type - cited_text - document_index - end_block_index - start_block_index title: CitationContentBlockLocation description: Content block location citation. CitationContentBlockLocationParam: properties: cited_text: type: string title: Cited Text description: Cited text content. document_index: type: integer title: Document Index description: Index of the cited document. document_title: anyOf: - type: string - type: 'null' title: Document Title description: Title of the cited document. end_block_index: type: integer title: End Block Index description: End content block index. start_block_index: type: integer title: Start Block Index description: Start content block index. type: type: string const: content_block_location title: Type description: Type discriminator. type: object required: - cited_text - document_index - end_block_index - start_block_index - type title: CitationContentBlockLocationParam description: Citation content block location parameter. CitationPageLocation: properties: type: type: string const: page_location title: Type description: Citation type. document_title: anyOf: - type: string - type: 'null' title: Document Title description: Title of the cited document. cited_text: type: string title: Cited Text description: Cited text content. document_index: type: integer title: Document Index description: Index of the cited document. end_page_number: type: integer title: End Page Number description: End page number. file_id: anyOf: - type: string - type: 'null' title: File Id description: File ID. start_page_number: type: integer title: Start Page Number description: Start page number. additionalProperties: false type: object required: - type - cited_text - document_index - end_page_number - start_page_number title: CitationPageLocation description: Page location citation. CitationPageLocationParam: properties: cited_text: type: string title: Cited Text description: Cited text content. document_index: type: integer title: Document Index description: Index of the cited document. document_title: anyOf: - type: string - type: 'null' title: Document Title description: Title of the cited document. end_page_number: type: integer title: End Page Number description: End page number. start_page_number: type: integer title: Start Page Number description: Start page number. type: type: string const: page_location title: Type description: Type discriminator. type: object required: - cited_text - document_index - end_page_number - start_page_number - type title: CitationPageLocationParam description: Citation page location parameter. CitationSearchResultLocationParam: properties: cited_text: type: string title: Cited Text description: Cited text content. end_block_index: type: integer title: End Block Index description: End content block index. search_result_index: type: integer title: Search Result Index description: Index of the search result. source: type: string title: Source description: Source of the search result. start_block_index: type: integer title: Start Block Index description: Start content block index. title: anyOf: - type: string - type: 'null' title: Title description: Title. type: type: string const: search_result_location title: Type description: Type discriminator. type: object required: - cited_text - end_block_index - search_result_index - source - start_block_index - type title: CitationSearchResultLocationParam description: Citation search result location parameter. CitationWebSearchResultLocationParam: properties: cited_text: type: string title: Cited Text description: Cited text content. encrypted_index: type: string title: Encrypted Index description: Encrypted index for the search result. title: anyOf: - type: string - type: 'null' title: Title description: Title. type: type: string const: web_search_result_location title: Type description: Type discriminator. url: type: string title: Url description: URL. type: object required: - cited_text - encrypted_index - type - url title: CitationWebSearchResultLocationParam description: Citation web search result location parameter. CitationsConfig: properties: enabled: type: boolean title: Enabled description: Whether the feature is enabled. additionalProperties: false type: object required: - enabled title: CitationsConfig description: Citations config. CitationsConfigParam: properties: enabled: type: boolean title: Enabled description: Whether to enable citations. type: object required: - enabled title: CitationsConfigParam description: Citations config parameter. CitationsSearchResultLocation: properties: type: type: string const: search_result_location title: Type description: Citation type. search_result_index: type: integer title: Search Result Index description: Index of the search result. cited_text: type: string title: Cited Text description: Cited text content. end_block_index: type: integer title: End Block Index description: End content block index. source: type: string title: Source description: Source of the search result. start_block_index: type: integer title: Start Block Index description: Start content block index. title: anyOf: - type: string - type: 'null' title: Title description: Title. additionalProperties: false type: object required: - type - search_result_index - cited_text - end_block_index - source - start_block_index title: CitationsSearchResultLocation description: Search result citation location. CitationsWebSearchResultLocation: properties: type: type: string const: web_search_result_location title: Type description: Citation type. url: type: string title: Url description: URL of the web search result. title: anyOf: - type: string - type: 'null' title: Title description: Title of the web search result. cited_text: type: string title: Cited Text description: Cited text content. encrypted_index: type: string title: Encrypted Index description: Encrypted index for the search result. additionalProperties: false type: object required: - type - url - cited_text - encrypted_index title: CitationsWebSearchResultLocation description: Web search result citation location. CodeExecutionOutputBlock: properties: file_id: type: string title: File Id description: File ID. type: type: string const: code_execution_output title: Type description: Type discriminator. additionalProperties: false type: object required: - file_id - type title: CodeExecutionOutputBlock description: Code execution output block. CodeExecutionOutputBlockParam: properties: file_id: type: string title: File Id description: File ID. type: type: string const: code_execution_output title: Type description: Type discriminator. type: object required: - file_id - type title: CodeExecutionOutputBlockParam description: Code execution output block parameter. CodeExecutionResultBlock: properties: content: items: $ref: '#/components/schemas/CodeExecutionOutputBlock' type: array title: Content description: Block content. return_code: type: integer title: Return Code description: Return code. stderr: type: string title: Stderr description: Stderr. stdout: type: string title: Stdout description: Stdout. type: type: string const: code_execution_result title: Type description: Type discriminator. additionalProperties: false type: object required: - content - return_code - stderr - stdout - type title: CodeExecutionResultBlock description: Code execution result block. CodeExecutionResultBlockParam: properties: content: items: $ref: '#/components/schemas/CodeExecutionOutputBlockParam' type: array title: Content description: Block content. return_code: type: integer title: Return Code description: Return code. stderr: type: string title: Stderr description: Stderr. stdout: type: string title: Stdout description: Stdout. type: type: string const: code_execution_result title: Type description: Type discriminator. type: object required: - content - return_code - stderr - stdout - type title: CodeExecutionResultBlockParam description: Code execution result block parameter. CodeExecutionToolParam: properties: name: type: string const: code_execution title: Name description: Tool name. type: type: string pattern: ^code_execution(?:_[0-9]{8})?$ title: Type description: Type discriminator. allowed_callers: anyOf: - items: type: string pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$ type: array - type: 'null' title: Allowed Callers description: Allowed callers. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: Defer loading tool until referenced by tool_search. strict: anyOf: - type: boolean - type: 'null' title: Strict description: Enable strict schema validation type: object required: - name - type title: CodeExecutionToolParam description: Code execution tool parameter. CodeExecutionToolResultBlock: properties: content: anyOf: - $ref: '#/components/schemas/CodeExecutionToolResultError' - $ref: '#/components/schemas/CodeExecutionResultBlock' - $ref: '#/components/schemas/EncryptedCodeExecutionResultBlock' title: Content description: Code execution result with encrypted stdout for PFC + web_search results. tool_use_id: type: string title: Tool Use Id description: Tool use ID. type: type: string const: code_execution_tool_result title: Type description: Type discriminator. additionalProperties: false type: object required: - content - tool_use_id - type title: CodeExecutionToolResultBlock description: Code execution tool result block. CodeExecutionToolResultBlockParam: properties: content: $ref: '#/components/schemas/CodeExecutionToolResultBlockParamContentParam' description: Code execution result with encrypted stdout for PFC + web_search results. tool_use_id: type: string title: Tool Use Id description: Tool use ID. type: type: string const: code_execution_tool_result title: Type description: Type discriminator. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. type: object required: - content - tool_use_id - type title: CodeExecutionToolResultBlockParam description: Code execution tool result block parameter. CodeExecutionToolResultBlockParamContentParam: anyOf: - $ref: '#/components/schemas/CodeExecutionToolResultErrorParam' - $ref: '#/components/schemas/CodeExecutionResultBlockParam' - $ref: '#/components/schemas/EncryptedCodeExecutionResultBlockParam' CodeExecutionToolResultError: properties: error_code: $ref: '#/components/schemas/CodeExecutionToolResultErrorCode' description: Error code. type: type: string const: code_execution_tool_result_error title: Type description: Type discriminator. additionalProperties: false type: object required: - error_code - type title: CodeExecutionToolResultError description: Code execution tool result error. CodeExecutionToolResultErrorCode: type: string enum: - invalid_tool_input - unavailable - too_many_requests - execution_time_exceeded CodeExecutionToolResultErrorParam: properties: error_code: $ref: '#/components/schemas/CodeExecutionToolResultErrorCode' description: Error code. type: type: string const: code_execution_tool_result_error title: Type description: Type discriminator. type: object required: - error_code - type title: CodeExecutionToolResultErrorParam description: Code execution tool result error parameter. CodeInterpreter: properties: container: anyOf: - type: string - $ref: '#/components/schemas/CodeInterpreterContainerAuto' - type: 'null' title: Container description: Code interpreter container (ID or config). type: type: string const: code_interpreter title: Type description: Code interpreter tool type. type: object required: - type title: CodeInterpreter description: A tool that runs Python code to help generate a response to a prompt. CodeInterpreterContainerAuto: properties: type: type: string const: auto title: Type description: Auto container type. file_ids: anyOf: - items: type: string type: array - type: 'null' title: File Ids description: Uploaded files for code interpreter. memory_limit: anyOf: - type: string enum: - 1g - 4g - 16g - 64g - type: 'null' title: Memory Limit description: Container memory limit. network_policy: anyOf: - oneOf: - $ref: '#/components/schemas/ContainerNetworkPolicyDisabled' - $ref: '#/components/schemas/ContainerNetworkPolicyAllowlist' discriminator: propertyName: type mapping: allowlist: '#/components/schemas/ContainerNetworkPolicyAllowlist' disabled: '#/components/schemas/ContainerNetworkPolicyDisabled' - type: 'null' title: Network Policy description: Network access policy. type: object required: - type title: CodeInterpreterContainerAuto description: Configuration for a code interpreter container. CodeInterpreterOutputImage: properties: type: type: string const: image title: Type description: Image output type. url: type: string title: Url description: Image output URL. additionalProperties: false type: object required: - type - url title: CodeInterpreterOutputImage description: The image output from the code interpreter. CodeInterpreterOutputLogs: properties: logs: type: string title: Logs description: Code interpreter logs. type: type: string const: logs title: Type description: Logs output type. additionalProperties: false type: object required: - logs - type title: CodeInterpreterOutputLogs description: The logs output from the code interpreter. CompactionItemParam: properties: encrypted_content: type: string title: Encrypted Content description: The encrypted content of the compaction summary. type: type: string const: compaction title: Type description: The type of the item. Always `compaction`. id: anyOf: - type: string - type: 'null' title: Id description: The ID of the compaction item. type: object required: - encrypted_content - type title: CompactionItemParam description: A compaction item generated by the v1/responses/compact API. ComparisonFilter: properties: key: type: string title: Key description: The key to compare against. type: type: string enum: - eq - ne - gt - gte - lt - lte - in - nin title: Type description: 'Comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, or `nin`.' value: anyOf: - type: string - type: number - type: boolean - items: anyOf: - type: string - type: number type: array title: Value description: The value to compare against the key. type: object required: - key - type - value title: ComparisonFilter description: Compares a specified attribute key to a given value using a defined operator. CompleteUploadBody: properties: part_ids: items: type: string type: array title: Part Ids description: The ordered list of Part IDs. md5: anyOf: - type: string - type: 'null' title: Md5 description: Optional md5 checksum for the file contents. Accepted but not validated. type: object required: - part_ids title: CompleteUploadBody description: Request body for ``POST /v1/uploads/{upload_id}/complete``. Completion: properties: id: type: string title: Id description: Unique identifier for the completion. object: type: string const: text_completion title: Object description: The object type, always ``text_completion``. default: text_completion created: type: integer title: Created description: Unix timestamp (in seconds) when the completion was created. model: type: string title: Model description: The model used to generate the completion. choices: items: $ref: '#/components/schemas/CompletionChoice' type: array title: Choices description: The list of generated completion choices. usage: anyOf: - $ref: '#/components/schemas/CompletionUsage' - type: 'null' description: Usage statistics for the completion request. system_fingerprint: anyOf: - type: string - type: 'null' title: System Fingerprint description: Backend configuration fingerprint that the model ran with. service_tier: anyOf: - type: string enum: - auto - default - flex - scale - priority - reserved - type: 'null' title: Service Tier description: Processing tier used to serve the request. additionalProperties: false type: object required: - id - created - model title: Completion description: Response for the OpenAI completions API (``POST /v1/completions``). CompletionChoice: properties: text: type: string title: Text description: The generated text for this choice. index: type: integer minimum: 0.0 title: Index description: The index of this choice in the list of choices. default: 0 finish_reason: anyOf: - type: string enum: - stop - length - content_filter - type: 'null' title: Finish Reason description: The reason the model stopped generating text. logprobs: anyOf: - $ref: '#/components/schemas/CompletionLogprobs' - type: 'null' description: Log probability information for this choice. additionalProperties: false type: object required: - text title: CompletionChoice description: A single completion choice. CompletionLogprobs: properties: tokens: anyOf: - items: type: string type: array - type: 'null' title: Tokens description: The tokens chosen by the model. token_logprobs: anyOf: - items: type: number type: array - type: 'null' title: Token Logprobs description: Log probabilities of each token. top_logprobs: anyOf: - items: additionalProperties: type: number type: object type: array - type: 'null' title: Top Logprobs description: Top log probabilities for each token. text_offset: anyOf: - items: type: integer type: array - type: 'null' title: Text Offset description: Character offsets into the prompt text. additionalProperties: false type: object title: CompletionLogprobs description: 'Log probability information for a completion choice. Always returned as ``None`` — the backend does not surface logprob data.' CompletionTokensDetails: properties: accepted_prediction_tokens: anyOf: - type: integer - type: 'null' title: Accepted Prediction Tokens description: Predicted tokens that appeared in the completion (Predicted Outputs). audio_tokens: anyOf: - type: integer - type: 'null' title: Audio Tokens description: Audio input tokens generated by the model. reasoning_tokens: anyOf: - type: integer - type: 'null' title: Reasoning Tokens description: Tokens generated for reasoning. rejected_prediction_tokens: anyOf: - type: integer - type: 'null' title: Rejected Prediction Tokens description: Predicted tokens that did not appear in the completion. Counted for billing and context limits. additionalProperties: false type: object title: CompletionTokensDetails description: Breakdown of tokens used in a completion. CompletionUsage: properties: prompt_tokens: type: integer title: Prompt Tokens description: Number of tokens in the prompt. completion_tokens: type: integer title: Completion Tokens description: Number of tokens in the generated completion. total_tokens: type: integer title: Total Tokens description: Total number of tokens used in the request (prompt + completion). completion_tokens_details: anyOf: - $ref: '#/components/schemas/CompletionTokensDetails' - type: 'null' description: Breakdown of tokens used in a completion. prompt_tokens_details: anyOf: - $ref: '#/components/schemas/PromptTokensDetails' - type: 'null' description: Breakdown of tokens used in the prompt. additionalProperties: false type: object required: - prompt_tokens - completion_tokens - total_tokens title: CompletionUsage description: Token usage statistics, compatible with OpenAI. CompoundFilter: properties: filters: items: anyOf: - $ref: '#/components/schemas/ComparisonFilter' - {} type: array title: Filters description: Array of filters to combine. type: type: string enum: - and - or title: Type description: 'Combine operation: `and` or `or`.' type: object required: - filters - type title: CompoundFilter description: Combine multiple filters using `and` or `or`. ComputerActionClick: properties: button: type: string enum: - left - right - wheel - back - forward title: Button description: Mouse button pressed. type: type: string const: click title: Type description: Click action type. x: type: integer title: X description: Click x-coordinate. y: type: integer title: Y description: Click y-coordinate. keys: anyOf: - items: type: string type: array - type: 'null' title: Keys description: Keys held while clicking. additionalProperties: false type: object required: - button - type - x - y title: ComputerActionClick description: A click action. ComputerActionDoubleClick: properties: type: type: string const: double_click title: Type description: Double click action type. x: type: integer title: X description: Double click x-coordinate. y: type: integer title: Y description: Double click y-coordinate. keys: anyOf: - items: type: string type: array - type: 'null' title: Keys description: Keys held while double-clicking. additionalProperties: false type: object required: - type - x - y title: ComputerActionDoubleClick description: A double click action. ComputerActionDrag: properties: path: items: $ref: '#/components/schemas/ComputerActionDragPath' type: array title: Path description: Drag path coordinates. type: type: string const: drag title: Type description: Drag action type. keys: anyOf: - items: type: string type: array - type: 'null' title: Keys description: Keys held while dragging. additionalProperties: false type: object required: - path - type title: ComputerActionDrag description: A drag action. ComputerActionDragPath: properties: x: type: integer title: X description: X-coordinate. y: type: integer title: Y description: Y-coordinate. additionalProperties: false type: object required: - x - y title: ComputerActionDragPath description: An x/y coordinate pair. ComputerActionKeypress: properties: keys: items: type: string type: array title: Keys description: Keys to press. type: type: string const: keypress title: Type description: Keypress action type. additionalProperties: false type: object required: - keys - type title: ComputerActionKeypress description: A collection of keypresses. ComputerActionMove: properties: type: type: string const: move title: Type description: Move action type. x: type: integer title: X description: Target x-coordinate. y: type: integer title: Y description: Target y-coordinate. keys: anyOf: - items: type: string type: array - type: 'null' title: Keys description: Keys held while moving. additionalProperties: false type: object required: - type - x - y title: ComputerActionMove description: A mouse move action. ComputerActionScreenshot: properties: type: type: string const: screenshot title: Type description: Screenshot action type. additionalProperties: false type: object required: - type title: ComputerActionScreenshot description: A screenshot action. ComputerActionScroll: properties: scroll_x: type: integer title: Scroll X description: Horizontal scroll distance. scroll_y: type: integer title: Scroll Y description: Vertical scroll distance. type: type: string const: scroll title: Type description: Scroll action type. x: type: integer title: X description: Scroll x-coordinate. y: type: integer title: Y description: Scroll y-coordinate. keys: anyOf: - items: type: string type: array - type: 'null' title: Keys description: Keys held while scrolling. additionalProperties: false type: object required: - scroll_x - scroll_y - type - x - y title: ComputerActionScroll description: A scroll action. ComputerActionType: properties: text: type: string title: Text description: Text to type. type: type: string const: type title: Type description: Type action type. additionalProperties: false type: object required: - text - type title: ComputerActionType description: An action to type in text. ComputerActionWait: properties: type: type: string const: wait title: Type description: Wait action type. additionalProperties: false type: object required: - type title: ComputerActionWait description: A wait action. ComputerCallOutput: properties: call_id: type: string title: Call Id description: Computer tool call ID. output: $ref: '#/components/schemas/ResponseComputerToolCallOutputScreenshot' description: Computer screenshot. type: type: string const: computer_call_output title: Type description: Computer call output type. id: anyOf: - type: string - type: 'null' title: Id description: Output ID. acknowledged_safety_checks: anyOf: - items: $ref: '#/components/schemas/ComputerCallOutputAcknowledgedSafetyCheck' type: array - type: 'null' title: Acknowledged Safety Checks description: Acknowledged safety checks. status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status description: 'Status: `in_progress`, `completed`, or `incomplete`.' type: object required: - call_id - output - type title: ComputerCallOutput description: The output of a computer tool call. ComputerCallOutputAcknowledgedSafetyCheck: properties: id: type: string title: Id description: Safety check ID. code: anyOf: - type: string - type: 'null' title: Code description: Safety check type. message: anyOf: - type: string - type: 'null' title: Message description: Safety check details. type: object required: - id title: ComputerCallOutputAcknowledgedSafetyCheck description: A pending safety check for the computer call. ComputerTool: properties: type: type: string const: computer title: Type description: Computer tool type. type: object required: - type title: ComputerTool description: 'A tool that controls a virtual computer. UNSUPPORTED on this implementation.' ComputerUsePreviewTool: properties: display_height: type: integer title: Display Height description: Display height in pixels. display_width: type: integer title: Display Width description: Display width in pixels. environment: type: string enum: - windows - mac - linux - ubuntu - browser title: Environment description: Computer environment to control. type: type: string const: computer_use_preview title: Type description: Computer use preview tool type. type: object required: - display_height - display_width - environment - type title: ComputerUsePreviewTool description: 'A tool that controls a virtual computer (preview version). UNSUPPORTED on this implementation.' Container: properties: id: type: string title: Id description: Identifier for the container used in this request. expires_at: type: string title: Expires At description: The time at which the container will expire. additionalProperties: false type: object required: - id - expires_at title: Container description: Information about the container used in the request (for the code execution tool). ContainerAuto: properties: type: type: string const: container_auto title: Type description: Container auto. file_ids: anyOf: - items: type: string type: array - type: 'null' title: File Ids description: Uploaded files to make available to code. memory_limit: anyOf: - type: string enum: - 1g - 4g - 16g - 64g - type: 'null' title: Memory Limit description: Container memory limit. network_policy: anyOf: - oneOf: - $ref: '#/components/schemas/ContainerNetworkPolicyDisabled' - $ref: '#/components/schemas/ContainerNetworkPolicyAllowlist' discriminator: propertyName: type mapping: allowlist: '#/components/schemas/ContainerNetworkPolicyAllowlist' disabled: '#/components/schemas/ContainerNetworkPolicyDisabled' - type: 'null' title: Network Policy description: Network access policy. skills: anyOf: - items: oneOf: - $ref: '#/components/schemas/SkillReference' - $ref: '#/components/schemas/InlineSkill' discriminator: propertyName: type mapping: inline: '#/components/schemas/InlineSkill' skill_reference: '#/components/schemas/SkillReference' type: array - type: 'null' title: Skills description: Skills to include in the container. type: object required: - type title: ContainerAuto description: Automatically creates a container for this request. ContainerNetworkPolicyAllowlist: properties: allowed_domains: items: type: string type: array title: Allowed Domains description: List of allowed domains. type: type: string const: allowlist title: Type description: Allowlist network policy. domain_secrets: anyOf: - items: $ref: '#/components/schemas/ContainerNetworkPolicyDomainSecret' type: array - type: 'null' title: Domain Secrets description: Domain-scoped secrets for allowlisted domains. type: object required: - allowed_domains - type title: ContainerNetworkPolicyAllowlist description: Allow outbound network access only to specified domains. ContainerNetworkPolicyDisabled: properties: type: type: string const: disabled title: Type description: Network policy disabled. type: object required: - type title: ContainerNetworkPolicyDisabled description: Disable outbound network access from the container. ContainerNetworkPolicyDomainSecret: properties: domain: type: string title: Domain description: The domain for this secret. name: type: string title: Name description: The secret name. value: type: string title: Value description: The secret value. type: object required: - domain - name - value title: ContainerNetworkPolicyDomainSecret description: A domain-scoped secret injected for an allowlisted domain. ContainerReference: properties: container_id: type: string title: Container Id description: Referenced container ID. type: type: string const: container_reference title: Type description: Container reference type. type: object required: - container_id - type title: ContainerReference description: References a container created with the /v1/containers endpoint. ContainerUploadBlock: properties: file_id: type: string title: File Id description: File ID. type: type: string const: container_upload title: Type description: Type discriminator. additionalProperties: false type: object required: - file_id - type title: ContainerUploadBlock description: Response model for a file uploaded to the container. ContainerUploadBlockParam: properties: file_id: type: string title: File Id description: File ID. type: type: string const: container_upload title: Type description: Type discriminator. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. type: object required: - file_id - type title: ContainerUploadBlockParam description: 'A content block for file upload to the container. Files uploaded via this block will be available in the container''s input directory. UNSUPPORTED on this implementation.' ContentBlockSourceParam: properties: content: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/TextBlockParam' - $ref: '#/components/schemas/ImageBlockParam' type: array title: Content description: Content of the source. type: type: string const: content title: Type description: Type discriminator. type: object required: - content - type title: ContentBlockSourceParam description: Content block source for document content block. ContextManagement: properties: type: type: string title: Type description: The context management entry type. Currently only `compaction` is supported. compact_threshold: anyOf: - type: integer - type: 'null' title: Compact Threshold description: Token threshold at which compaction should be triggered for this entry. type: object required: - type title: ContextManagement description: A context management entry for the request. Conversation: properties: id: type: string title: Id description: Conversation ID. additionalProperties: false type: object required: - id title: Conversation description: The conversation that this response belonged to. ConversationObject: properties: id: type: string title: Id description: The unique ID of the conversation. type: object required: - id title: ConversationObject description: A conversation reference passed as an object with an ID. CreateEmbeddingResponse: properties: object: type: string const: list title: Object description: The object type, which is always `list`. data: items: $ref: '#/components/schemas/Embedding' type: array title: Data description: The list of embeddings generated by the model. model: type: string title: Model description: The name of the model used to generate the embedding. usage: $ref: '#/components/schemas/stdapi__types__openai_embeddings__Usage' description: The usage information for the request. additionalProperties: false type: object required: - object - data - model - usage title: CreateEmbeddingResponse description: Embedding response model. CreateUploadBody: properties: bytes: type: integer maximum: 8589934592.0 exclusiveMinimum: 0.0 title: Bytes description: The number of bytes in the file you are uploading. filename: type: string title: Filename description: The name of the file to upload. mime_type: type: string title: Mime Type description: The MIME type of the file. purpose: type: string enum: - assistants - batch - fine-tune - vision - user_data - evals title: Purpose description: The intended purpose of the uploaded file. type: object required: - bytes - filename - mime_type - purpose title: CreateUploadBody description: Request body for ``POST /v1/uploads``. Custom: properties: name: type: string title: Name description: Name of the custom tool. UNSUPPORTED on this implementation. description: anyOf: - type: string - type: 'null' title: Description description: Description of the custom tool. UNSUPPORTED on this implementation. format: anyOf: - oneOf: - $ref: '#/components/schemas/CustomFormatText' - $ref: '#/components/schemas/CustomFormatGrammar' discriminator: propertyName: type mapping: grammar: '#/components/schemas/CustomFormatGrammar' text: '#/components/schemas/CustomFormatText' - type: 'null' title: Format description: 'Input format for the custom tool. Default: unconstrained text. UNSUPPORTED on this implementation.' default: type: text type: object required: - name title: Custom description: 'Properties of the custom tool used for custom tool calling. UNSUPPORTED on this implementation.' CustomFormatGrammar: properties: type: type: string const: grammar title: Type description: Format type. Always `grammar`. UNSUPPORTED on this implementation. grammar: $ref: '#/components/schemas/CustomFormatGrammarGrammar' description: Grammar definition. UNSUPPORTED on this implementation. type: object required: - type - grammar title: CustomFormatGrammar description: 'Grammar format. Always `grammar`. UNSUPPORTED on this implementation.' CustomFormatGrammarGrammar: properties: definition: type: string title: Definition description: Grammar definition. UNSUPPORTED on this implementation. syntax: type: string enum: - lark - regex title: Syntax description: 'Grammar syntax: `lark` or `regex`. UNSUPPORTED on this implementation.' type: object required: - definition - syntax title: CustomFormatGrammarGrammar description: 'The grammar definition and syntax for a grammar-based custom tool input. UNSUPPORTED on this implementation.' CustomFormatText: properties: type: type: string const: text title: Type description: Format type. Always `text`. UNSUPPORTED on this implementation. type: object required: - type title: CustomFormatText description: 'Unconstrained text format. Always `text`. UNSUPPORTED on this implementation.' CustomToolChoice: properties: name: type: string title: Name description: 'The name of the custom tool to call. UNSUPPORTED on this implementation.' type: object required: - name title: CustomToolChoice description: 'The custom tool to call by name. UNSUPPORTED on this implementation.' CustomToolInputFormatGrammar: properties: definition: type: string title: Definition description: The grammar definition. syntax: type: string enum: - lark - regex title: Syntax description: 'Grammar syntax type: `lark` or `regex`.' type: type: string const: grammar title: Type description: Grammar format identifier. type: object required: - definition - syntax - type title: CustomToolInputFormatGrammar description: A grammar-constrained input format. CustomToolInputFormatText: properties: type: type: string const: text title: Type description: Text format identifier. type: object required: - type title: CustomToolInputFormatText description: Unconstrained free-form text input format. DeletedFile: properties: id: type: string title: Id description: ID of the deleted file. type: type: string const: file_deleted title: Type description: Deleted object type ("file_deleted"). default: file_deleted additionalProperties: false type: object required: - id title: DeletedFile description: Response returned when a file is deleted via the Files API. DirectCaller: properties: type: type: string const: direct title: Type description: Type discriminator. additionalProperties: false type: object required: - type title: DirectCaller description: Caller. DocumentBlock: properties: citations: anyOf: - $ref: '#/components/schemas/CitationsConfig' - type: 'null' description: Citation configuration for the document source: oneOf: - $ref: '#/components/schemas/Base64PDFSource' - $ref: '#/components/schemas/PlainTextSource' title: Source description: The document source. discriminator: propertyName: type mapping: base64: '#/components/schemas/Base64PDFSource' text: '#/components/schemas/PlainTextSource' title: anyOf: - type: string - type: 'null' title: Title description: Document title type: type: string const: document title: Type description: Type discriminator. additionalProperties: false type: object required: - source - type title: DocumentBlock description: Document block. DocumentBlockParam: properties: type: type: string const: document title: Type description: Content block type. Always `document`. source: oneOf: - $ref: '#/components/schemas/Base64PDFSource' - $ref: '#/components/schemas/PlainTextSourceParam' - $ref: '#/components/schemas/ContentBlockSourceParam' - $ref: '#/components/schemas/URLPDFSource' - $ref: '#/components/schemas/FileSource' title: Source description: Document source data. discriminator: propertyName: type mapping: base64: '#/components/schemas/Base64PDFSource' content: '#/components/schemas/ContentBlockSourceParam' file: '#/components/schemas/FileSource' text: '#/components/schemas/PlainTextSourceParam' url: '#/components/schemas/URLPDFSource' cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control for this content block. citations: anyOf: - $ref: '#/components/schemas/CitationsConfigParam' - type: 'null' description: Citation configuration for the document context: anyOf: - type: string - type: 'null' title: Context description: Additional context for the document. title: anyOf: - type: string - type: 'null' title: Title description: Document title type: object required: - type - source title: DocumentBlockParam description: Document content block parameter. EasyInputMessage: properties: content: anyOf: - type: string - items: oneOf: - $ref: '#/components/schemas/ResponseInputText' - $ref: '#/components/schemas/ResponseInputImage' - $ref: '#/components/schemas/ResponseInputFile' - $ref: '#/components/schemas/ResponseOutputTextContent' discriminator: propertyName: type mapping: input_file: '#/components/schemas/ResponseInputFile' input_image: '#/components/schemas/ResponseInputImage' input_text: '#/components/schemas/ResponseInputText' output_text: '#/components/schemas/ResponseOutputTextContent' type: array title: Content description: Text, image, or audio input for the model. role: type: string enum: - user - assistant - system - developer title: Role description: 'Message role: `user`, `assistant`, `system`, or `developer`.' phase: anyOf: - type: string enum: - commentary - final_answer - type: 'null' title: Phase description: Labels assistant message as commentary or final answer. type: anyOf: - type: string const: message - type: 'null' title: Type description: Message input type. type: object required: - content - role title: EasyInputMessage description: A message input to the model with a role indicating instruction following hierarchy. Embedding: properties: object: type: string const: embedding title: Object description: The object type, which is always `embedding`. index: type: integer title: Index description: The index of the embedding in the list of embeddings. embedding: anyOf: - items: type: number type: array - type: string title: Embedding description: The embedding vector, which is a list of floats or a base64 string. additionalProperties: false type: object required: - object - index - embedding title: Embedding description: 'Custom embedding model that supports both float lists and base64 strings. This extends the OpenAI embedding format to handle base64 encoding properly.' EmbeddingCreateParams: properties: input: anyOf: - type: string minLength: 1 pattern: ^(?:https?://|s3://|data:|file-id:) - type: string - items: anyOf: - type: string minLength: 1 pattern: ^(?:https?://|s3://|data:|file-id:) - type: string type: array title: Input description: Input text to embed, as a single string or array of strings. For multimodal models, non-text inputs can be a URL, S3 URI, base64 data URI, or Files API reference. Token arrays are UNSUPPORTED on this implementation. model: type: string maxLength: 255 minLength: 1 title: Model description: ID of the model to use. dimensions: anyOf: - type: integer maximum: 8192.0 minimum: 1.0 - type: 'null' title: Dimensions description: The number of dimensions the resulting output embeddings should have. Supported by some models only. encoding_format: anyOf: - type: string enum: - float - base64 - type: 'null' title: Encoding Format description: 'The format to return the embeddings in: `float` or `base64`.' default: float user: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: User description: A unique identifier representing your end-user, which can help detect abuse. additionalProperties: $ref: '#/components/schemas/JsonValue' type: object required: - input - model title: EmbeddingCreateParams description: 'Request body for creating embeddings. Validates unsupported values and combinations to match OpenAI behavior.' EncryptedCodeExecutionResultBlock: properties: content: items: $ref: '#/components/schemas/CodeExecutionOutputBlock' type: array title: Content description: Block content. encrypted_stdout: type: string title: Encrypted Stdout description: Encrypted standard output. return_code: type: integer title: Return Code description: Return code. stderr: type: string title: Stderr description: Stderr. type: type: string const: encrypted_code_execution_result title: Type description: Type discriminator. additionalProperties: false type: object required: - content - encrypted_stdout - return_code - stderr - type title: EncryptedCodeExecutionResultBlock description: Code execution result with encrypted stdout for PFC + web_search results. EncryptedCodeExecutionResultBlockParam: properties: content: items: $ref: '#/components/schemas/CodeExecutionOutputBlockParam' type: array title: Content description: Block content. encrypted_stdout: type: string title: Encrypted Stdout description: Encrypted standard output. return_code: type: integer title: Return Code description: Return code. stderr: type: string title: Stderr description: Stderr. type: type: string const: encrypted_code_execution_result title: Type description: Type discriminator. type: object required: - content - encrypted_stdout - return_code - stderr - type title: EncryptedCodeExecutionResultBlockParam description: Code execution result with encrypted stdout for PFC + web_search results. File: properties: type: type: string const: file title: Type description: Content part type. Always `file`. file: $ref: '#/components/schemas/FileFile' description: Content descriptor containing base64 bytes. type: object required: - type - file title: File description: File message content part. FileDeleted: properties: id: type: string title: Id description: The file identifier. object: type: string const: file title: Object description: The object type, which is always `file`. default: file deleted: type: boolean title: Deleted description: Whether the file was deleted. additionalProperties: false type: object required: - id - deleted title: FileDeleted description: Response returned when a file is deleted. FileFile: properties: file_id: anyOf: - type: string pattern: ^file[-_] - type: 'null' title: File Id description: ID of an uploaded file to use as input. file_data: anyOf: - type: string minLength: 1 - type: 'null' title: File Data description: Base64-encoded file data, data URI, S3 URI, or URL. filename: anyOf: - type: string - type: 'null' title: Filename description: Name of the file when passing as a string. type: object title: FileFile description: File content descriptor. FileListResponse: properties: data: items: $ref: '#/components/schemas/FileMetadata' type: array title: Data description: List of file metadata objects. has_more: type: boolean title: Has More description: Whether there are more results available. default: false first_id: anyOf: - type: string - type: 'null' title: First Id description: ID of the first file in this page of results. last_id: anyOf: - type: string - type: 'null' title: Last Id description: ID of the last file in this page of results. additionalProperties: false type: object required: - data title: FileListResponse description: Paginated list of files returned by GET /v1/files. FileMetadata: properties: id: type: string title: Id description: Unique object identifier. The format and length of IDs may change over time. type: type: string const: file title: Type description: Object type ("file"). default: file filename: type: string title: Filename description: Original filename of the uploaded file. mime_type: type: string title: Mime Type description: MIME type of the file. size_bytes: type: integer title: Size Bytes description: Size of the file in bytes. created_at: type: string title: Created At description: RFC 3339 datetime string representing when the file was created. downloadable: type: boolean title: Downloadable description: Whether the file can be downloaded. default: true additionalProperties: false type: object required: - id - filename - mime_type - size_bytes - created_at title: FileMetadata description: The `FileMetadata` object represents a file that has been uploaded to the API. FileObject: properties: id: type: string title: Id description: The file identifier, which can be referenced in the API endpoints. object: type: string const: file title: Object description: The object type, which is always `file`. default: file bytes: type: integer title: Bytes description: The file size in bytes. created_at: type: integer title: Created At description: Unix timestamp (in seconds) when the file was created. filename: type: string title: Filename description: The name of the file. purpose: type: string title: Purpose description: The intended purpose of the file. status: type: string enum: - uploaded - processed - error title: Status description: Deprecated. The current status of the file. default: processed expires_at: anyOf: - type: integer - type: 'null' title: Expires At description: The Unix timestamp (in seconds) for when the file will expire. status_details: anyOf: - type: string - type: 'null' title: Status Details description: Deprecated. Details on why a fine-tuning training file failed validation. additionalProperties: false type: object required: - id - bytes - created_at - filename - purpose title: FileObject description: The `File` object represents a document that has been uploaded to the API. FileSearchRankingOptions: properties: hybrid_search: anyOf: - $ref: '#/components/schemas/FileSearchRankingOptionsHybridSearch' - type: 'null' description: Weights for hybrid search reciprocal rank fusion. ranker: anyOf: - type: string enum: - auto - default-2024-11-15 - type: 'null' title: Ranker description: File search ranker. score_threshold: anyOf: - type: number - type: 'null' title: Score Threshold description: Score threshold (0 to 1). type: object title: FileSearchRankingOptions description: Ranking options for file search. FileSearchRankingOptionsHybridSearch: properties: embedding_weight: type: number title: Embedding Weight description: Embedding weight for reciprocal rank fusion. text_weight: type: number title: Text Weight description: Text weight for reciprocal rank fusion. type: object required: - embedding_weight - text_weight title: FileSearchRankingOptionsHybridSearch description: Hybrid search weighting for reciprocal rank fusion. FileSearchResult: properties: attributes: anyOf: - additionalProperties: anyOf: - type: string - type: number - type: boolean type: object - type: 'null' title: Attributes description: Key-value pairs for the file. file_id: anyOf: - type: string - type: 'null' title: File Id description: File ID. filename: anyOf: - type: string - type: 'null' title: Filename description: Filename. score: anyOf: - type: number - type: 'null' title: Score description: Relevance score (0-1). text: anyOf: - type: string - type: 'null' title: Text description: Retrieved text from file. additionalProperties: false type: object title: FileSearchResult description: A file search result. FileSearchTool: properties: type: type: string const: file_search title: Type description: File search tool type. vector_store_ids: items: type: string type: array title: Vector Store Ids description: Vector store IDs to search. filters: anyOf: - $ref: '#/components/schemas/ComparisonFilter' - $ref: '#/components/schemas/CompoundFilter' - type: 'null' title: Filters description: Filter to apply. max_num_results: anyOf: - type: integer maximum: 50.0 minimum: 1.0 - type: 'null' title: Max Num Results description: Maximum results to return (1-50). ranking_options: anyOf: - $ref: '#/components/schemas/FileSearchRankingOptions' - type: 'null' description: Ranking options for search. type: object required: - type - vector_store_ids title: FileSearchTool description: 'A tool that searches for relevant content from uploaded files. UNSUPPORTED on this implementation.' FileSource: properties: type: type: string const: file title: Type description: Source type. file_id: type: string pattern: ^file[-_] title: File Id description: Files API file identifier. type: object required: - type - file_id title: FileSource description: File source for document or image content block (Files API). FunctionCall: properties: name: type: string title: Name description: The name of the function to call. arguments: type: string title: Arguments description: JSON arguments for the function call. May be invalid or hallucinated; validate before use. additionalProperties: false type: object required: - name - arguments title: FunctionCall description: Function tool call payload used within assistant tool calls. FunctionCallInput: properties: arguments: type: string title: Arguments description: A JSON string of the arguments passed to the function. call_id: type: string title: Call Id description: The unique ID of the function tool call generated by the model. name: type: string title: Name description: The name of the function that was called. type: type: string const: function_call title: Type description: The type of the function tool call. Always `function_call`. id: anyOf: - type: string - type: 'null' title: Id description: The unique ID of the function tool call. namespace: anyOf: - type: string - type: 'null' title: Namespace description: The namespace of the function to run. status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status description: The status of the item. type: object required: - arguments - call_id - name - type title: FunctionCallInput description: A function tool call echoed back as an input item from a previous response. FunctionCallOutput: properties: call_id: type: string title: Call Id description: The unique ID of the function tool call generated by the model. output: anyOf: - type: string - items: oneOf: - $ref: '#/components/schemas/ResponseInputText' - $ref: '#/components/schemas/ResponseInputImage' - $ref: '#/components/schemas/ResponseInputFile' - $ref: '#/components/schemas/ResponseOutputTextContent' discriminator: propertyName: type mapping: input_file: '#/components/schemas/ResponseInputFile' input_image: '#/components/schemas/ResponseInputImage' input_text: '#/components/schemas/ResponseInputText' output_text: '#/components/schemas/ResponseOutputTextContent' type: array title: Output description: Text, image, or file output of the function tool call. type: type: string const: function_call_output title: Type description: The type of the function tool call output. Always `function_call_output`. id: anyOf: - type: string - type: 'null' title: Id description: The unique ID of the function tool call output. Populated when this item is returned via API. status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status description: The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API. type: object required: - call_id - output - type title: FunctionCallOutput description: The output of a function tool call. FunctionDefinition: properties: strict: anyOf: - type: boolean - type: 'null' title: Strict description: Whether to enable strict schema adherence when generating the function call. If true, the model follows the exact schema in `parameters`; only a subset of JSON Schema is supported in that case. name: type: string title: Name description: The name of the function to be called. description: anyOf: - type: string - type: 'null' title: Description description: A description of what the function does. parameters: anyOf: - additionalProperties: $ref: '#/components/schemas/JsonValue' type: object - type: 'null' title: Parameters description: The parameters the function accepts, described as a JSON Schema object. Omitting `parameters` defines a function with an empty parameter list. type: object required: - name title: FunctionDefinition description: Function tool definition following OpenAI shared schema. FunctionShellTool: properties: type: type: string const: shell title: Type description: Shell tool type. environment: anyOf: - oneOf: - $ref: '#/components/schemas/ContainerAuto' - $ref: '#/components/schemas/LocalEnvironment' - $ref: '#/components/schemas/ContainerReference' discriminator: propertyName: type mapping: container_auto: '#/components/schemas/ContainerAuto' container_reference: '#/components/schemas/ContainerReference' local: '#/components/schemas/LocalEnvironment' - type: 'null' title: Environment description: Environment for shell commands. type: object required: - type title: FunctionShellTool description: 'A tool that allows the model to execute shell commands. UNSUPPORTED on this implementation.' FunctionTool: properties: name: type: string title: Name description: Function name. type: type: string const: function title: Type description: Function tool type. defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: Whether this function is deferred and loaded via tool search. description: anyOf: - type: string - type: 'null' title: Description description: Function description for the model. parameters: anyOf: - additionalProperties: $ref: '#/components/schemas/JsonValue' type: object - type: 'null' title: Parameters description: JSON schema for function parameters. strict: anyOf: - type: boolean - type: 'null' title: Strict description: 'Enforce strict parameter validation. Default: true.' type: object required: - name - type title: FunctionTool description: Defines a function in your own code the model can choose to call. FunctionToolChoiceParam: properties: name: type: string title: Name description: The name of the function to call. type: object required: - name title: FunctionToolChoiceParam description: The function to call by name. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError Image: properties: b64_json: anyOf: - type: string - type: 'null' title: B64 Json description: Base64-encoded image data; present when response_format is `b64_json`. revised_prompt: anyOf: - type: string - type: 'null' title: Revised Prompt description: The revised prompt used to generate the image. url: anyOf: - type: string - type: 'null' title: Url description: URL of the generated image; present when response_format is `url`. additionalProperties: false type: object title: Image description: Generated image descriptor compatible with OpenAI. ImageBlockParam: properties: type: type: string const: image title: Type description: Content block type. source: oneOf: - $ref: '#/components/schemas/Base64ImageSource' - $ref: '#/components/schemas/URLImageSource' - $ref: '#/components/schemas/FileSource' title: Source description: Image source data. discriminator: propertyName: type mapping: base64: '#/components/schemas/Base64ImageSource' file: '#/components/schemas/FileSource' url: '#/components/schemas/URLImageSource' cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control for this content block. type: object required: - type - source title: ImageBlockParam description: Image content block parameter. ImageGenerateParams: properties: model: type: string maxLength: 255 minLength: 1 title: Model description: Model for image generation. response_format: type: string enum: - url - b64_json title: Response Format description: 'Format for returned images: `url` or `b64_json`. URLs expire after 60 minutes. Streaming always returns `b64_json`.' default: url n: type: integer maximum: 10.0 minimum: 1.0 title: N description: Number of images to generate. default: 1 size: type: string pattern: ^(\d+)x(\d+)$ title: Size description: Size of the generated images. Supported values depend on the model; output size may differ. default: 1024x1024 user: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: User description: User identifier for monitoring and abuse detection. prompt: type: string minLength: 1 title: Prompt description: A text description of the desired image(s). background: anyOf: - type: string const: auto - type: string enum: - transparent - opaque title: Background description: 'Background transparency setting. If `transparent`, `output_format` must be `png` or `webp`. transparent is UNSUPPORTED on this implementation.' default: auto moderation: type: string enum: - low - auto title: Moderation description: 'Content-moderation level: `low` (less restrictive) or `auto`. low is UNSUPPORTED on this implementation.' default: auto output_compression: type: integer maximum: 100.0 minimum: 1.0 title: Output Compression description: Compression level (0-100%) for generated images. default: 100 output_format: anyOf: - type: string enum: - png - jpeg - webp - type: 'null' title: Output Format description: 'Output image format: `png`, `jpeg`, or `webp`.' partial_images: anyOf: - type: integer maximum: 3.0 minimum: 0.0 - type: 'null' title: Partial Images description: Number of partial images to generate during streaming (0-3; requires `stream=true`). 0 sends the final image as a single event. The final image may arrive before all partial images if generation finishes early, and partial images are only sent if the model supports them. quality: type: string maxLength: 255 minLength: 1 title: Quality description: Image quality. `auto` selects the best quality for the model; supported values depend on the model. default: auto style: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Style description: The style of the generated images; supported values depend on the model. stream: type: boolean title: Stream description: Generate the image in streaming mode. default: false additionalProperties: $ref: '#/components/schemas/JsonValue' type: object required: - model - prompt title: ImageGenerateParams description: Request body for generating images. ImageGeneration: properties: type: type: string const: image_generation title: Type description: Image generation tool type. action: anyOf: - type: string enum: - generate - edit - auto - type: 'null' title: Action description: 'Generate new or edit existing image. Default: auto.' background: anyOf: - type: string enum: - transparent - opaque - auto - type: 'null' title: Background description: 'Background type: `transparent`, `opaque`, or `auto`. Default: auto.' input_fidelity: anyOf: - type: string enum: - high - low - type: 'null' title: Input Fidelity description: 'Match style/features of input images. Default: low.' input_image_mask: anyOf: - $ref: '#/components/schemas/ImageGenerationInputImageMask' - type: 'null' description: Mask for inpainting. model: anyOf: - type: string - type: 'null' title: Model description: Image generation model. moderation: anyOf: - type: string enum: - auto - low - type: 'null' title: Moderation description: 'Moderation level. Default: auto.' output_compression: anyOf: - type: integer maximum: 100.0 minimum: 0.0 - type: 'null' title: Output Compression description: 'Output compression (0-100). Default: 100.' output_format: anyOf: - type: string enum: - png - webp - jpeg - type: 'null' title: Output Format description: 'Output format: `png`, `webp`, or `jpeg`. Default: png.' partial_images: anyOf: - type: integer maximum: 3.0 minimum: 0.0 - type: 'null' title: Partial Images description: 'Partial images for streaming (0-3). Default: 0.' quality: anyOf: - type: string enum: - low - medium - high - auto - type: 'null' title: Quality description: 'Image quality: `low`, `medium`, `high`, or `auto`. Default: auto.' size: anyOf: - type: string enum: - 1024x1024 - 1024x1536 - 1536x1024 - auto - type: 'null' title: Size description: 'Image size: `1024x1024`, `1024x1536`, `1536x1024`, or `auto`. Default: auto.' type: object required: - type title: ImageGeneration description: A tool that generates images. ImageGenerationCall: properties: id: type: string title: Id description: The unique ID of the image generation call. status: type: string enum: - in_progress - completed - generating - failed title: Status description: The status of the image generation call. type: type: string const: image_generation_call title: Type description: The type of the image generation call. Always `image_generation_call`. result: anyOf: - type: string - type: 'null' title: Result description: The generated image encoded in base64. additionalProperties: false type: object required: - id - status - type title: ImageGenerationCall description: An image generation request made by the model. ImageGenerationCallInput: properties: id: type: string title: Id description: The unique ID of the image generation call. status: type: string enum: - in_progress - completed - generating - failed title: Status description: The status of the image generation call. type: type: string const: image_generation_call title: Type description: The type of the image generation call. Always `image_generation_call`. result: anyOf: - type: string - type: 'null' title: Result description: The generated image encoded in base64. type: object required: - id - status - type title: ImageGenerationCallInput description: An image generation call as an input item. ImageGenerationInputImageMask: properties: file_id: anyOf: - type: string - type: 'null' title: File Id description: Mask image file ID. image_url: anyOf: - type: string - type: 'null' title: Image Url description: Base64-encoded mask image. type: object title: ImageGenerationInputImageMask description: Optional mask for inpainting. ImageURL: properties: url: type: string minLength: 1 title: Url description: Image URL string, data URI, S3 URI, or base64-encoded string. detail: anyOf: - type: string enum: - low - high - auto - type: 'null' title: Detail description: 'Image resolution: `low`, `high`, or `auto`. Default: `auto`.' type: object required: - url title: ImageURL description: Image URL detail for image content part. ImagesResponse: properties: created: type: integer minimum: 0.0 title: Created description: Unix timestamp (seconds) when the image was created. background: anyOf: - type: string enum: - transparent - opaque - type: 'null' title: Background description: 'Background setting: `transparent` or `opaque`.' data: anyOf: - items: $ref: '#/components/schemas/Image' type: array - type: 'null' title: Data description: List of generated images. output_format: anyOf: - type: string enum: - png - jpeg - webp - type: 'null' title: Output Format description: 'Output format: `png`, `webp`, or `jpeg`.' quality: anyOf: - type: string enum: - low - medium - high - type: 'null' title: Quality description: Quality of the generated image. size: anyOf: - type: string - type: 'null' title: Size description: Size of the generated image. usage: anyOf: - $ref: '#/components/schemas/stdapi__types__openai_images__Usage' - type: 'null' description: Token usage information for the image generation. additionalProperties: false type: object required: - created title: ImagesResponse description: OpenAI-compatible non-streaming image generation response. IncompleteDetails: properties: reason: anyOf: - type: string enum: - max_output_tokens - content_filter - type: 'null' title: Reason description: Incomplete reason. additionalProperties: false type: object title: IncompleteDetails description: Details about why the response is incomplete. InlineSkill: properties: description: type: string title: Description description: The description of the skill. name: type: string title: Name description: The name of the skill. source: $ref: '#/components/schemas/InlineSkillSource' type: type: string const: inline title: Type description: Defines an inline skill for this request. type: object required: - description - name - source - type title: InlineSkill description: An inline skill definition. InlineSkillSource: properties: data: type: string title: Data description: Base64-encoded skill zip bundle. media_type: type: string const: application/zip title: Media Type description: The media type of the inline skill payload. Must be `application/zip`. type: type: string const: base64 title: Type description: The type of the inline skill source. Must be `base64`. type: object required: - data - media_type - type title: InlineSkillSource description: Inline skill payload. InputAudio: properties: data: type: string minLength: 1 title: Data description: Base64-encoded audio data, data URI, S3 URI, or URL. format: type: string enum: - wav - mp3 title: Format description: 'Audio format: `wav` or `mp3`.' type: object required: - data - format title: InputAudio description: Input audio descriptor. InputMessage: properties: content: items: oneOf: - $ref: '#/components/schemas/ResponseInputText' - $ref: '#/components/schemas/ResponseInputImage' - $ref: '#/components/schemas/ResponseInputFile' - $ref: '#/components/schemas/ResponseOutputTextContent' discriminator: propertyName: type mapping: input_file: '#/components/schemas/ResponseInputFile' input_image: '#/components/schemas/ResponseInputImage' input_text: '#/components/schemas/ResponseInputText' output_text: '#/components/schemas/ResponseOutputTextContent' type: array title: Content description: Input content items. role: type: string enum: - user - system - developer title: Role description: 'Message role: `user`, `system`, or `developer`.' status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status description: 'Item status: `in_progress`, `completed`, or `incomplete`.' type: anyOf: - type: string const: message - type: 'null' title: Type description: Message input type. type: object required: - content - role title: InputMessage description: A message input with a restricted set of roles (no `assistant`). InputTokenCountParams: properties: model: type: string title: Model description: Model ID. input: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/EasyInputMessage' - $ref: '#/components/schemas/InputMessage' - $ref: '#/components/schemas/ComputerCallOutput' - $ref: '#/components/schemas/FunctionCallInput' - $ref: '#/components/schemas/FunctionCallOutput' - $ref: '#/components/schemas/ToolSearchCallInput' - $ref: '#/components/schemas/ImageGenerationCallInput' - $ref: '#/components/schemas/LocalShellCallInput' - $ref: '#/components/schemas/LocalShellCallOutputInput' - $ref: '#/components/schemas/ShellCall' - $ref: '#/components/schemas/ShellCallOutput' - $ref: '#/components/schemas/ApplyPatchCall' - $ref: '#/components/schemas/ApplyPatchCallOutput' - $ref: '#/components/schemas/McpListToolsInput' - $ref: '#/components/schemas/McpApprovalRequestInput' - $ref: '#/components/schemas/McpApprovalResponse' - $ref: '#/components/schemas/McpCallInput' - $ref: '#/components/schemas/CompactionItemParam' - $ref: '#/components/schemas/ItemReference' - $ref: '#/components/schemas/ResponseOutputMessage-Input' - $ref: '#/components/schemas/ResponseReasoningItem' type: array - type: 'null' title: Input description: Text, image, or file inputs. instructions: anyOf: - type: string - type: 'null' title: Instructions description: System message. Not carried over with previous_response_id. tools: anyOf: - items: oneOf: - $ref: '#/components/schemas/FunctionTool' - $ref: '#/components/schemas/FileSearchTool' - $ref: '#/components/schemas/ComputerTool' - $ref: '#/components/schemas/ComputerUsePreviewTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/Mcp' - $ref: '#/components/schemas/CodeInterpreter' - $ref: '#/components/schemas/ImageGeneration' - $ref: '#/components/schemas/LocalShell' - $ref: '#/components/schemas/FunctionShellTool' - $ref: '#/components/schemas/stdapi__types__openai_responses__CustomTool' - $ref: '#/components/schemas/NamespaceTool' - $ref: '#/components/schemas/ToolSearchTool' - $ref: '#/components/schemas/WebSearchPreviewTool' - $ref: '#/components/schemas/ApplyPatchTool' discriminator: propertyName: type mapping: apply_patch: '#/components/schemas/ApplyPatchTool' code_interpreter: '#/components/schemas/CodeInterpreter' computer: '#/components/schemas/ComputerTool' computer_use_preview: '#/components/schemas/ComputerUsePreviewTool' custom: '#/components/schemas/stdapi__types__openai_responses__CustomTool' file_search: '#/components/schemas/FileSearchTool' function: '#/components/schemas/FunctionTool' image_generation: '#/components/schemas/ImageGeneration' local_shell: '#/components/schemas/LocalShell' mcp: '#/components/schemas/Mcp' namespace: '#/components/schemas/NamespaceTool' shell: '#/components/schemas/FunctionShellTool' tool_search: '#/components/schemas/ToolSearchTool' web_search: '#/components/schemas/WebSearchTool' web_search_2025_08_26: '#/components/schemas/WebSearchTool' web_search_preview: '#/components/schemas/WebSearchPreviewTool' web_search_preview_2025_03_11: '#/components/schemas/WebSearchPreviewTool' type: array - type: 'null' title: Tools description: Available tools. tool_choice: anyOf: - type: string enum: - none - auto - required - $ref: '#/components/schemas/ToolChoiceAllowed' - $ref: '#/components/schemas/ToolChoiceTypes' - $ref: '#/components/schemas/ToolChoiceFunction' - $ref: '#/components/schemas/ToolChoiceMcp' - $ref: '#/components/schemas/ToolChoiceCustom' - $ref: '#/components/schemas/ToolChoiceApplyPatch' - $ref: '#/components/schemas/ToolChoiceShell' - type: 'null' title: Tool Choice description: Tool selection. parallel_tool_calls: anyOf: - type: boolean - type: 'null' title: Parallel Tool Calls description: Allow parallel tool calls. reasoning: anyOf: - $ref: '#/components/schemas/Reasoning' - type: 'null' description: Reasoning configuration. text: anyOf: - $ref: '#/components/schemas/ResponseTextConfig' - type: 'null' description: 'Text response config. UNSUPPORTED on this implementation.' truncation: anyOf: - type: string enum: - auto - disabled - type: 'null' title: Truncation description: 'Truncation strategy. UNSUPPORTED on this implementation.' previous_response_id: anyOf: - type: string - type: 'null' title: Previous Response Id description: 'Previous response ID for multi-turn. UNSUPPORTED on this implementation.' conversation: anyOf: - type: string - $ref: '#/components/schemas/ConversationObject' - type: 'null' title: Conversation description: 'Conversation ID. UNSUPPORTED on this implementation.' type: object required: - model title: InputTokenCountParams description: 'Request body for POST /v1/responses/input_tokens. Counts input tokens without producing a response.' InputTokenCountResponse: properties: object: type: string const: response.input_tokens title: Object default: response.input_tokens input_tokens: type: integer title: Input Tokens description: Total input token count. additionalProperties: false type: object required: - input_tokens title: InputTokenCountResponse description: Response body for POST /v1/responses/input_tokens. InputTokensDetails: properties: cached_tokens: type: integer title: Cached Tokens description: Cached token count. additionalProperties: false type: object required: - cached_tokens title: InputTokensDetails description: A detailed breakdown of the input tokens. ItemReference: properties: id: type: string title: Id description: The ID of the item to reference. type: anyOf: - type: string const: item_reference - type: 'null' title: Type description: The type of item to reference. Always `item_reference`. type: object required: - id title: ItemReference description: An internal identifier for an item to reference. JSONOutputFormatParam: properties: type: type: string const: json_schema title: Type description: Output format type. Always `json_schema`. schema: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object title: Schema description: The JSON schema of the format. type: object required: - type - schema title: JSONOutputFormatParam description: JSON output format configuration. JSONSchema: properties: strict: anyOf: - type: boolean - type: 'null' title: Strict description: Whether to enable strict schema adherence when generating the function call. If true, the model follows the exact schema in `parameters`; only a subset of JSON Schema is supported in that case. name: type: string title: Name description: The name of the response format (max 64 chars). description: anyOf: - type: string - type: 'null' title: Description description: A description of what the response format is for, used by the model to determine how to respond in the format. schema: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object title: Schema description: The schema for the response format, described as a JSON Schema object. type: object required: - name - schema title: JSONSchema description: Structured Outputs JSON Schema options. JsonValue: {} LegacyFunction: properties: name: type: string title: Name description: The name of the function to be called. description: anyOf: - type: string - type: 'null' title: Description description: A description of what the function does. parameters: anyOf: - additionalProperties: $ref: '#/components/schemas/JsonValue' type: object - type: 'null' title: Parameters description: The parameters the function accepts, described as a JSON Schema object. Omitting `parameters` defines a function with an empty parameter list. type: object required: - name title: LegacyFunction description: Legacy function definition (deprecated in favor of tools). ListFilesResponse: properties: object: type: string const: list title: Object description: The object type, which is always `list`. default: list data: items: $ref: '#/components/schemas/FileObject' type: array title: Data description: List of File objects. has_more: type: boolean title: Has More description: Whether more results exist after this page. first_id: type: string title: First Id description: ID of the first file in the list, or '' when empty. last_id: type: string title: Last Id description: ID of the last file in the list, or '' when empty. additionalProperties: false type: object required: - data - has_more - first_id - last_id title: ListFilesResponse description: Paginated list of files returned by GET /v1/files. LocalEnvironment: properties: type: type: string const: local title: Type description: Local environment. skills: anyOf: - items: $ref: '#/components/schemas/LocalSkill' type: array - type: 'null' title: Skills description: List of skills. type: object required: - type title: LocalEnvironment description: Use a local computer environment. LocalShell: properties: type: type: string const: local_shell title: Type description: Local shell tool type. type: object required: - type title: LocalShell description: 'A tool that allows the model to execute shell commands in a local environment. UNSUPPORTED on this implementation.' LocalShellCall: properties: id: type: string title: Id description: Local shell call ID. action: $ref: '#/components/schemas/LocalShellCallAction' description: Shell command to execute. call_id: type: string title: Call Id description: Model-generated call ID. status: type: string enum: - in_progress - completed - incomplete title: Status description: Call status. type: type: string const: local_shell_call title: Type description: Local shell call type. additionalProperties: false type: object required: - id - action - call_id - status - type title: LocalShellCall description: A tool call to run a command on the local shell. LocalShellCallAction: properties: command: items: type: string type: array title: Command description: Command to run. env: additionalProperties: type: string type: object title: Env description: Environment variables. type: type: string const: exec title: Type description: Exec action type. timeout_ms: anyOf: - type: integer - type: 'null' title: Timeout Ms description: Timeout in milliseconds. user: anyOf: - type: string - type: 'null' title: User description: User to run as. working_directory: anyOf: - type: string - type: 'null' title: Working Directory description: Working directory. additionalProperties: false type: object required: - command - env - type title: LocalShellCallAction description: Execute a shell command on the server. LocalShellCallActionInput: properties: command: items: type: string type: array title: Command description: Command to run. env: additionalProperties: type: string type: object title: Env description: Environment variables. type: type: string const: exec title: Type description: Exec action type. timeout_ms: anyOf: - type: integer - type: 'null' title: Timeout Ms description: Timeout in milliseconds. user: anyOf: - type: string - type: 'null' title: User description: User to run as. working_directory: anyOf: - type: string - type: 'null' title: Working Directory description: Working directory. type: object required: - command - env - type title: LocalShellCallActionInput description: Execute a shell command on the server. LocalShellCallInput: properties: id: type: string title: Id description: The unique ID of the local shell call. action: $ref: '#/components/schemas/LocalShellCallActionInput' call_id: type: string title: Call Id description: The unique ID of the local shell tool call generated by the model. status: type: string enum: - in_progress - completed - incomplete title: Status description: The status of the local shell call. type: type: string const: local_shell_call title: Type description: The type of the local shell call. Always `local_shell_call`. type: object required: - id - action - call_id - status - type title: LocalShellCallInput description: A tool call to run a command on the local shell (as input item). LocalShellCallOutput: properties: id: type: string title: Id description: Shell tool call ID. output: type: string title: Output description: JSON output string. type: type: string const: local_shell_call_output title: Type description: Shell call output type. status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status description: Item status. additionalProperties: false type: object required: - id - output - type title: LocalShellCallOutput description: The output of a local shell tool call. LocalShellCallOutputInput: properties: id: type: string title: Id description: The unique ID of the local shell tool call generated by the model. output: type: string title: Output description: A JSON string of the output of the local shell tool call. type: type: string const: local_shell_call_output title: Type description: The type of the local shell tool call output. Always `local_shell_call_output`. status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status description: The status of the item. One of `in_progress`, `completed`, or `incomplete`. type: object required: - id - output - type title: LocalShellCallOutputInput description: The output of a local shell tool call (as input item). LocalSkill: properties: description: type: string title: Description description: The description of the skill. name: type: string title: Name description: The name of the skill. path: type: string title: Path description: The path to the directory containing the skill. type: object required: - description - name - path title: LocalSkill description: A local skill for a shell environment. Logprob: properties: token: type: string title: Token description: Text token. bytes: items: type: integer type: array title: Bytes description: Token bytes. logprob: type: number title: Logprob description: Log probability. top_logprobs: items: $ref: '#/components/schemas/LogprobTopLogprob' type: array title: Top Logprobs description: Top log probabilities. additionalProperties: false type: object required: - token - bytes - logprob - top_logprobs title: Logprob description: The log probability of a token. LogprobTopLogprob: properties: token: anyOf: - type: string - type: 'null' title: Token description: Possible text token. logprob: anyOf: - type: number - type: 'null' title: Logprob description: Log probability. additionalProperties: false type: object title: LogprobTopLogprob description: A possible token with its log probability. Mcp: properties: server_label: type: string title: Server Label description: Label for this MCP server. type: type: string const: mcp title: Type description: MCP tool type. allowed_tools: anyOf: - items: type: string type: array - $ref: '#/components/schemas/McpAllowedToolsFilter' - type: 'null' title: Allowed Tools description: Allowed tool names or filter. authorization: anyOf: - type: string - type: 'null' title: Authorization description: OAuth access token for the MCP server. connector_id: anyOf: - type: string enum: - connector_dropbox - connector_gmail - connector_googlecalendar - connector_googledrive - connector_microsoftteams - connector_outlookcalendar - connector_outlookemail - connector_sharepoint - type: 'null' title: Connector Id description: Service connector. Requires `server_url` or `connector_id`. defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: Deferred and discovered via tool search. headers: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Headers description: HTTP headers for the MCP server. require_approval: anyOf: - $ref: '#/components/schemas/McpRequireApprovalFilter' - type: string enum: - always - never - type: 'null' title: Require Approval description: Tools requiring approval. server_description: anyOf: - type: string - type: 'null' title: Server Description description: MCP server description. server_url: anyOf: - type: string - type: 'null' title: Server Url description: MCP server URL. Requires `server_url` or `connector_id`. type: object required: - server_label - type title: Mcp description: 'Give the model access to additional tools via remote Model Context Protocol (MCP) servers. UNSUPPORTED on this implementation.' McpAllowedToolsFilter: properties: read_only: anyOf: - type: boolean - type: 'null' title: Read Only description: Filter by read-only status. tool_names: anyOf: - items: type: string type: array - type: 'null' title: Tool Names description: List of allowed tool names. type: object title: McpAllowedToolsFilter description: A filter object to specify which MCP tools are allowed. McpApprovalRequest: properties: id: type: string title: Id description: Approval request ID. arguments: type: string title: Arguments description: Tool arguments JSON. name: type: string title: Name description: Tool name. server_label: type: string title: Server Label description: MCP server label. type: type: string const: mcp_approval_request title: Type description: MCP approval request type. additionalProperties: false type: object required: - id - arguments - name - server_label - type title: McpApprovalRequest description: A request for human approval of a tool invocation. McpApprovalRequestInput: properties: id: type: string title: Id description: Approval request ID. arguments: type: string title: Arguments description: Tool arguments JSON. name: type: string title: Name description: Tool name. server_label: type: string title: Server Label description: MCP server label. type: type: string const: mcp_approval_request title: Type description: MCP approval request type. type: object required: - id - arguments - name - server_label - type title: McpApprovalRequestInput description: A request for human approval of a tool invocation (as input item). McpApprovalResponse: properties: approval_request_id: type: string title: Approval Request Id description: The ID of the approval request being answered. approve: type: boolean title: Approve description: Whether the request was approved. type: type: string const: mcp_approval_response title: Type description: The type of the item. Always `mcp_approval_response`. id: anyOf: - type: string - type: 'null' title: Id description: The unique ID of the approval response. reason: anyOf: - type: string - type: 'null' title: Reason description: Optional reason for the decision. type: object required: - approval_request_id - approve - type title: McpApprovalResponse description: A response to an MCP approval request. McpApprovalResponseOutput: properties: id: type: string title: Id description: Approval response ID. approval_request_id: type: string title: Approval Request Id description: Approval request ID. approve: type: boolean title: Approve description: Whether approved. type: type: string const: mcp_approval_response title: Type description: MCP approval response type. reason: anyOf: - type: string - type: 'null' title: Reason description: Decision reason. additionalProperties: false type: object required: - id - approval_request_id - approve - type title: McpApprovalResponseOutput description: A response to an MCP approval request. McpCall: properties: id: type: string title: Id description: Tool call ID. arguments: type: string title: Arguments description: Tool arguments JSON. name: type: string title: Name description: Tool name. server_label: type: string title: Server Label description: MCP server label. type: type: string const: mcp_call title: Type description: MCP call type. approval_request_id: anyOf: - type: string - type: 'null' title: Approval Request Id description: Approval request ID. error: anyOf: - type: string - type: 'null' title: Error description: Tool call error. output: anyOf: - type: string - type: 'null' title: Output description: Tool call output. status: anyOf: - type: string enum: - in_progress - completed - incomplete - calling - failed - type: 'null' title: Status description: Tool call status. additionalProperties: false type: object required: - id - arguments - name - server_label - type title: McpCall description: An invocation of a tool on an MCP server. McpCallInput: properties: id: type: string title: Id description: Tool call ID. arguments: type: string title: Arguments description: Tool arguments JSON. name: type: string title: Name description: Tool name. server_label: type: string title: Server Label description: MCP server label. type: type: string const: mcp_call title: Type description: MCP call type. approval_request_id: anyOf: - type: string - type: 'null' title: Approval Request Id description: Approval request ID. error: anyOf: - type: string - type: 'null' title: Error description: Tool call error. output: anyOf: - type: string - type: 'null' title: Output description: Tool call output. status: anyOf: - type: string enum: - in_progress - completed - incomplete - calling - failed - type: 'null' title: Status description: Tool call status. type: object required: - id - arguments - name - server_label - type title: McpCallInput description: An invocation of a tool on an MCP server (as input item). McpListTools: properties: id: type: string title: Id description: List ID. server_label: type: string title: Server Label description: MCP server label. tools: items: $ref: '#/components/schemas/McpListToolsToolOutput' type: array title: Tools description: Server tools. type: type: string const: mcp_list_tools title: Type description: MCP list tools type. error: anyOf: - type: string - type: 'null' title: Error description: Error if tools could not be listed. additionalProperties: false type: object required: - id - server_label - tools - type title: McpListTools description: A list of tools available on an MCP server. McpListToolsInput: properties: id: type: string title: Id description: The unique ID of the list. server_label: type: string title: Server Label description: The label of the MCP server. tools: items: $ref: '#/components/schemas/McpListToolsToolItem' type: array title: Tools description: The tools available on the server. type: type: string const: mcp_list_tools title: Type description: The type of the item. Always `mcp_list_tools`. error: anyOf: - type: string - type: 'null' title: Error description: Error message if the server could not list tools. type: object required: - id - server_label - tools - type title: McpListToolsInput description: A list of tools available on an MCP server (as input item). McpListToolsToolItem: properties: input_schema: title: Input Schema description: Tool input JSON schema. name: type: string title: Name description: Tool name. annotations: anyOf: - {} - type: 'null' title: Annotations description: Tool annotations. description: anyOf: - type: string - type: 'null' title: Description description: Tool description. type: object required: - input_schema - name title: McpListToolsToolItem description: A tool available on an MCP server. McpListToolsToolOutput: properties: input_schema: title: Input Schema description: Tool input JSON schema. name: type: string title: Name description: Tool name. annotations: anyOf: - {} - type: 'null' title: Annotations description: Tool annotations. description: anyOf: - type: string - type: 'null' title: Description description: Tool description. additionalProperties: false type: object required: - input_schema - name title: McpListToolsToolOutput description: A tool available on an MCP server. McpRequireApprovalFilter: properties: always: anyOf: - $ref: '#/components/schemas/McpToolFilter' - type: 'null' description: A filter object to specify which tools always require approval. never: anyOf: - $ref: '#/components/schemas/McpToolFilter' - type: 'null' description: A filter object to specify which tools never require approval. type: object title: McpRequireApprovalFilter description: Specify which of the MCP server's tools require approval. McpToolFilter: properties: read_only: anyOf: - type: boolean - type: 'null' title: Read Only description: Filter by read-only status. tool_names: anyOf: - items: type: string type: array - type: 'null' title: Tool Names description: List of tool names. type: object title: McpToolFilter description: Filter specifying a set of MCP tools by name or read-only status. MemoryToolParam: properties: name: type: string const: memory title: Name description: Tool name. type: type: string pattern: ^memory(?:_[0-9]{8})?$ title: Type description: Type discriminator. allowed_callers: anyOf: - items: type: string pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$ type: array - type: 'null' title: Allowed Callers description: Allowed callers. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: Defer loading tool until referenced by tool_search. input_examples: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Input Examples description: Example inputs. strict: anyOf: - type: boolean - type: 'null' title: Strict description: Enable strict schema validation type: object required: - name - type title: MemoryToolParam description: Memory tool parameter. Message: properties: id: type: string title: Id description: Unique object identifier. Format and length may change over time. type: type: string const: message title: Type description: Object type. Always `message`. role: type: string const: assistant title: Role description: Conversational role of the generated message. Always `assistant`. content: items: oneOf: - $ref: '#/components/schemas/TextBlock' - $ref: '#/components/schemas/ThinkingBlock' - $ref: '#/components/schemas/RedactedThinkingBlock' - $ref: '#/components/schemas/ToolUseBlock' - $ref: '#/components/schemas/ServerToolUseBlock' - $ref: '#/components/schemas/WebSearchToolResultBlock' - $ref: '#/components/schemas/WebFetchToolResultBlock' - $ref: '#/components/schemas/CodeExecutionToolResultBlock' - $ref: '#/components/schemas/BashCodeExecutionToolResultBlock' - $ref: '#/components/schemas/TextEditorCodeExecutionToolResultBlock' - $ref: '#/components/schemas/ToolSearchToolResultBlock' - $ref: '#/components/schemas/ContainerUploadBlock' discriminator: propertyName: type mapping: bash_code_execution_tool_result: '#/components/schemas/BashCodeExecutionToolResultBlock' code_execution_tool_result: '#/components/schemas/CodeExecutionToolResultBlock' container_upload: '#/components/schemas/ContainerUploadBlock' redacted_thinking: '#/components/schemas/RedactedThinkingBlock' server_tool_use: '#/components/schemas/ServerToolUseBlock' text: '#/components/schemas/TextBlock' text_editor_code_execution_tool_result: '#/components/schemas/TextEditorCodeExecutionToolResultBlock' thinking: '#/components/schemas/ThinkingBlock' tool_search_tool_result: '#/components/schemas/ToolSearchToolResultBlock' tool_use: '#/components/schemas/ToolUseBlock' web_fetch_tool_result: '#/components/schemas/WebFetchToolResultBlock' web_search_tool_result: '#/components/schemas/WebSearchToolResultBlock' type: array title: Content description: Content generated by the model, as an array of content blocks each with a `type`. If the input `messages` ended with an `assistant` turn, this continues directly from that turn. model: type: string title: Model description: Model ID. stop_reason: anyOf: - type: string enum: - end_turn - max_tokens - stop_sequence - tool_use - pause_turn - refusal - type: 'null' title: Stop Reason description: 'Why generation stopped: `end_turn` (natural stop), `max_tokens` (hit the limit), `stop_sequence` (matched a custom stop sequence), `tool_use` (model invoked a tool), `pause_turn` (long-running turn paused — resend as-is to continue), or `refusal` (streaming classifier intervened). Always non-null except in the streaming `message_start` event.' stop_sequence: anyOf: - type: string - type: 'null' title: Stop Sequence description: The matched custom stop sequence, if any. usage: $ref: '#/components/schemas/stdapi__types__anthropic_messages__Usage' description: Cumulative billing/rate-limit token usage. May not match the visible content one-to-one; total input tokens = `input_tokens` + `cache_creation_input_tokens` + `cache_read_input_tokens`. container: anyOf: - $ref: '#/components/schemas/Container' - type: 'null' description: Information about the container used in the request (for the code execution tool). additionalProperties: false type: object required: - id - type - role - content - model - usage title: Message description: Messages API response. MessageCountTokensParams: properties: model: type: string title: Model description: Model ID. messages: items: $ref: '#/components/schemas/MessageParam' type: array title: Messages description: Conversation turns, alternating `user`/`assistant` roles. Consecutive turns with the same role are combined. If the final message has role `assistant`, the response continues from its content. A `content` value may be a plain string (shorthand for one `text` block) or an array of content blocks. A first message with role `system` sets an inline system prompt, appended after the top-level `system` parameter. system: anyOf: - type: string - items: $ref: '#/components/schemas/TextBlockParam' type: array - type: 'null' title: System description: System prompt providing context and instructions, such as a goal or role. tools: anyOf: - items: anyOf: - $ref: '#/components/schemas/ToolParam' - $ref: '#/components/schemas/ToolBashParam' - $ref: '#/components/schemas/ToolTextEditorParam' - $ref: '#/components/schemas/ToolComputerParam' - $ref: '#/components/schemas/WebSearchToolParam' - $ref: '#/components/schemas/CodeExecutionToolParam' - $ref: '#/components/schemas/MemoryToolParam' - $ref: '#/components/schemas/WebFetchToolParam' - $ref: '#/components/schemas/ToolSearchToolBm25Param' - $ref: '#/components/schemas/ToolSearchToolRegexParam' type: array - type: 'null' title: Tools description: Tool definitions the model may use. Each includes `name`, an optional but recommended `description`, and `input_schema` (JSON Schema for the tool's `input`). The model returns `tool_use` content blocks; run the tool and return results via `tool_result` content blocks. Client tools run on your side; server tools have their own documented behavior. tool_choice: anyOf: - oneOf: - $ref: '#/components/schemas/ToolChoiceAutoParam' - $ref: '#/components/schemas/ToolChoiceAnyParam' - $ref: '#/components/schemas/ToolChoiceToolParam' - $ref: '#/components/schemas/ToolChoiceNoneParam' discriminator: propertyName: type mapping: any: '#/components/schemas/ToolChoiceAnyParam' auto: '#/components/schemas/ToolChoiceAutoParam' none: '#/components/schemas/ToolChoiceNoneParam' tool: '#/components/schemas/ToolChoiceToolParam' - type: 'null' title: Tool Choice description: 'How the model should use the provided tools: a specific tool, any available tool, model''s choice, or none.' output_config: anyOf: - $ref: '#/components/schemas/OutputConfigParam' - type: 'null' description: Configuration options for the model's output, such as the output format. thinking: anyOf: - oneOf: - $ref: '#/components/schemas/ThinkingConfigEnabledParam' - $ref: '#/components/schemas/ThinkingConfigDisabledParam' - $ref: '#/components/schemas/ThinkingConfigAdaptiveParam' discriminator: propertyName: type mapping: adaptive: '#/components/schemas/ThinkingConfigAdaptiveParam' disabled: '#/components/schemas/ThinkingConfigDisabledParam' enabled: '#/components/schemas/ThinkingConfigEnabledParam' - type: 'null' title: Thinking description: Extended thinking configuration. When enabled, responses include `thinking` content blocks showing the model's reasoning before the final answer. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control applied to last cacheable block. additionalProperties: $ref: '#/components/schemas/JsonValue' type: object required: - model - messages title: MessageCountTokensParams description: Count tokens request for the Messages API. MessageCreateParams: properties: model: type: string title: Model description: Model ID. messages: items: $ref: '#/components/schemas/MessageParam' type: array title: Messages description: Conversation turns, alternating `user`/`assistant` roles. Consecutive turns with the same role are combined. If the final message has role `assistant`, the response continues from its content. A `content` value may be a plain string (shorthand for one `text` block) or an array of content blocks. A first message with role `system` sets an inline system prompt, appended after the top-level `system` parameter. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control applied to the last cacheable block. max_tokens: anyOf: - type: integer minimum: 1.0 - type: 'null' title: Max Tokens description: Maximum tokens to generate before stopping; the model may stop earlier. Maximum value varies by model. inference_geo: anyOf: - type: string - type: 'null' title: Inference Geo description: 'Specifies the geographic region for inference processing. UNSUPPORTED on this implementation. Data residency configuration is managed at server configuration level.' metadata: anyOf: - $ref: '#/components/schemas/MetadataParam' - type: 'null' description: Request metadata. output_config: anyOf: - $ref: '#/components/schemas/OutputConfigParam' - type: 'null' description: Configuration options for the model's output, such as the output format. service_tier: anyOf: - type: string enum: - auto - standard_only - flex - priority - reserved - type: 'null' title: Service Tier description: Determines whether to use priority capacity (if available) or standard capacity. See service-tiers documentation for details. stop_sequences: anyOf: - items: type: string type: array - type: 'null' title: Stop Sequences description: Custom sequences that stop generation when encountered. The response `stop_reason` becomes `stop_sequence` and `stop_sequence` holds the matched value. stream: type: boolean title: Stream description: Whether to incrementally stream the response using server-sent events (SSE). default: false system: anyOf: - type: string - items: $ref: '#/components/schemas/TextBlockParam' type: array - type: 'null' title: System description: System prompt providing context and instructions, such as a goal or role. temperature: anyOf: - type: number maximum: 1.0 minimum: 0.0 - type: 'null' title: Temperature description: Randomness of the response, 0.0-1.0 (default 1.0). Lower values suit analytical/multiple-choice tasks, higher values suit creative tasks. Not fully deterministic even at 0.0. thinking: anyOf: - oneOf: - $ref: '#/components/schemas/ThinkingConfigEnabledParam' - $ref: '#/components/schemas/ThinkingConfigDisabledParam' - $ref: '#/components/schemas/ThinkingConfigAdaptiveParam' discriminator: propertyName: type mapping: adaptive: '#/components/schemas/ThinkingConfigAdaptiveParam' disabled: '#/components/schemas/ThinkingConfigDisabledParam' enabled: '#/components/schemas/ThinkingConfigEnabledParam' - type: 'null' title: Thinking description: Extended thinking configuration. When enabled, responses include `thinking` content blocks showing the model's reasoning before the final answer. tool_choice: anyOf: - oneOf: - $ref: '#/components/schemas/ToolChoiceAutoParam' - $ref: '#/components/schemas/ToolChoiceAnyParam' - $ref: '#/components/schemas/ToolChoiceToolParam' - $ref: '#/components/schemas/ToolChoiceNoneParam' discriminator: propertyName: type mapping: any: '#/components/schemas/ToolChoiceAnyParam' auto: '#/components/schemas/ToolChoiceAutoParam' none: '#/components/schemas/ToolChoiceNoneParam' tool: '#/components/schemas/ToolChoiceToolParam' - type: 'null' title: Tool Choice description: 'How the model should use the provided tools: a specific tool, any available tool, model''s choice, or none.' tools: anyOf: - items: anyOf: - $ref: '#/components/schemas/ToolParam' - $ref: '#/components/schemas/ToolBashParam' - $ref: '#/components/schemas/ToolTextEditorParam' - $ref: '#/components/schemas/ToolComputerParam' - $ref: '#/components/schemas/WebSearchToolParam' - $ref: '#/components/schemas/CodeExecutionToolParam' - $ref: '#/components/schemas/MemoryToolParam' - $ref: '#/components/schemas/WebFetchToolParam' - $ref: '#/components/schemas/ToolSearchToolBm25Param' - $ref: '#/components/schemas/ToolSearchToolRegexParam' type: array - type: 'null' title: Tools description: Tool definitions the model may use. Each includes `name`, an optional but recommended `description`, and `input_schema` (JSON Schema for the tool's `input`). The model returns `tool_use` content blocks; run the tool and return results via `tool_result` content blocks. Client tools run on your side; server tools have their own documented behavior. top_k: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Top K description: Sample only from the top K most likely tokens per step, removing low-probability outliers. Advanced use only; prefer `temperature`. Not supported by the AWS Bedrock Converse API, where it is passed as an extra argument; some models require a different argument name for it. top_p: anyOf: - type: number minimum: 0.0 - type: 'null' title: Top P description: 'Nucleus sampling: cuts off the cumulative token probability distribution at `top_p`. Use either `temperature` or `top_p`, not both. Advanced use only; prefer `temperature`.' container: anyOf: - type: string - type: 'null' title: Container description: Container identifier for reuse across requests. additionalProperties: $ref: '#/components/schemas/JsonValue' type: object required: - model - messages title: MessageCreateParams description: Create message request following the Messages API specification. MessageParam: properties: role: type: string enum: - user - assistant - system title: Role description: Message role. content: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/TextBlockParam' - $ref: '#/components/schemas/ImageBlockParam' - $ref: '#/components/schemas/DocumentBlockParam' - $ref: '#/components/schemas/SearchResultBlockParam' - $ref: '#/components/schemas/ThinkingBlockParam' - $ref: '#/components/schemas/RedactedThinkingBlockParam' - $ref: '#/components/schemas/ToolUseBlockParam' - $ref: '#/components/schemas/ToolResultBlockParam' - $ref: '#/components/schemas/ServerToolUseBlockParam' - $ref: '#/components/schemas/WebSearchToolResultBlockParam' - $ref: '#/components/schemas/WebFetchToolResultBlockParam' - $ref: '#/components/schemas/CodeExecutionToolResultBlockParam' - $ref: '#/components/schemas/BashCodeExecutionToolResultBlockParam' - $ref: '#/components/schemas/TextEditorCodeExecutionToolResultBlockParam' - $ref: '#/components/schemas/ToolSearchToolResultBlockParam' - $ref: '#/components/schemas/ContainerUploadBlockParam' - oneOf: - $ref: '#/components/schemas/TextBlock' - $ref: '#/components/schemas/ThinkingBlock' - $ref: '#/components/schemas/RedactedThinkingBlock' - $ref: '#/components/schemas/ToolUseBlock' - $ref: '#/components/schemas/ServerToolUseBlock' - $ref: '#/components/schemas/WebSearchToolResultBlock' - $ref: '#/components/schemas/WebFetchToolResultBlock' - $ref: '#/components/schemas/CodeExecutionToolResultBlock' - $ref: '#/components/schemas/BashCodeExecutionToolResultBlock' - $ref: '#/components/schemas/TextEditorCodeExecutionToolResultBlock' - $ref: '#/components/schemas/ToolSearchToolResultBlock' - $ref: '#/components/schemas/ContainerUploadBlock' discriminator: propertyName: type mapping: bash_code_execution_tool_result: '#/components/schemas/BashCodeExecutionToolResultBlock' code_execution_tool_result: '#/components/schemas/CodeExecutionToolResultBlock' container_upload: '#/components/schemas/ContainerUploadBlock' redacted_thinking: '#/components/schemas/RedactedThinkingBlock' server_tool_use: '#/components/schemas/ServerToolUseBlock' text: '#/components/schemas/TextBlock' text_editor_code_execution_tool_result: '#/components/schemas/TextEditorCodeExecutionToolResultBlock' thinking: '#/components/schemas/ThinkingBlock' tool_search_tool_result: '#/components/schemas/ToolSearchToolResultBlock' tool_use: '#/components/schemas/ToolUseBlock' web_fetch_tool_result: '#/components/schemas/WebFetchToolResultBlock' web_search_tool_result: '#/components/schemas/WebSearchToolResultBlock' type: array title: Content description: Message content. type: object required: - role - content title: MessageParam description: Base message parameter. MessageTokensCount: properties: input_tokens: type: integer title: Input Tokens description: The total number of tokens across the provided list of messages, system prompt, and tools. additionalProperties: false type: object required: - input_tokens title: MessageTokensCount description: Token count response from the Messages API. MetadataParam: properties: user_id: anyOf: - type: string - type: 'null' title: User Id description: End-user identifier. type: object title: MetadataParam description: Request metadata for tracking and filtering. Model: properties: id: type: string minLength: 1 title: Id description: The unique identifier for the model. object: type: string const: model title: Object description: The object type ("model"). default: model created: type: integer minimum: 0.0 title: Created description: The Unix timestamp when the model was created. owned_by: type: string minLength: 1 title: Owned By description: The organization that owns the model. additionalProperties: false type: object required: - id - created - owned_by title: Model description: OpenAI-compatible Model. ModelDetails: properties: id: type: string title: Id name: type: string title: Name provider: type: string title: Provider service: type: string title: Service default: AWS Bedrock input_modalities: items: type: string type: array title: Input Modalities output_modalities: items: type: string type: array title: Output Modalities response_streaming: anyOf: - type: boolean - type: 'null' title: Response Streaming legacy: anyOf: - type: boolean - type: 'null' title: Legacy start_of_life_time: anyOf: - type: string format: date-time - type: 'null' title: Start Of Life Time end_of_life_time: anyOf: - type: string format: date-time - type: 'null' title: End Of Life Time legacy_time: anyOf: - type: string format: date-time - type: 'null' title: Legacy Time public_extended_access_time: anyOf: - type: string format: date-time - type: 'null' title: Public Extended Access Time aliases: anyOf: - items: type: string type: array - type: 'null' title: Aliases regions: items: $ref: '#/components/schemas/RegionName' type: array title: Regions inference_profiles: anyOf: - additionalProperties: type: string propertyNames: $ref: '#/components/schemas/RegionName' type: object - type: 'null' title: Inference Profiles supported_routes: items: type: string type: array title: Supported Routes default: [] supported_mcp_tools: items: type: string type: array title: Supported Mcp Tools default: [] type: object required: - id - name - provider - input_modalities - output_modalities - regions title: ModelDetails description: "Metadata and capability flags for a single Bedrock model.\n\n\ Attributes:\n id: Bedrock model identifier.\n name: Human-readable model\ \ name.\n provider: Model provider name (e.g. Anthropic, Amazon).\n \ \ service: AWS service hosting the model.\n input_modalities: Accepted\ \ input types (e.g. TEXT, IMAGE).\n output_modalities: Produced output\ \ types (e.g. TEXT, IMAGE).\n response_streaming: Whether the model supports\ \ streaming responses.\n legacy: Whether the model is deprecated.\n \ \ start_of_life_time: GA date, if known.\n end_of_life_time: Deprecation\ \ date, if known.\n legacy_time: Date the model was marked legacy, if known.\n\ \ public_extended_access_time: Extended public-access end date, if known.\n\ \ aliases: Alternative model IDs that resolve to this model.\n regions:\ \ All regions where the model is accessible.\n inference_profiles: Per-region\ \ inference profile ARNs.\n supported_routes: Route paths this model can\ \ serve (e.g. /v1/chat/completions).\n supported_mcp_tools: MCP tool names\ \ (operation_ids) this model can serve." ModelInfo: properties: id: type: string title: Id description: Unique model identifier. created_at: type: string title: Created At description: RFC 3339 datetime string representing the time at which the model was released. May be set to an epoch value if the release date is unknown. display_name: type: string title: Display Name description: A human-readable name for the model. type: type: string const: model title: Type description: Object type. For Models, this is always `"model"`. default: model additionalProperties: false type: object required: - id - created_at - display_name title: ModelInfo description: Model information. ModelListResponse: properties: data: items: $ref: '#/components/schemas/ModelInfo' type: array title: Data description: List of model objects. has_more: type: boolean title: Has More description: Whether there are more results available. default: false first_id: anyOf: - type: string - type: 'null' title: First Id description: The ID of the first model in the list. last_id: anyOf: - type: string - type: 'null' title: Last Id description: The ID of the last model in the list. additionalProperties: false type: object required: - data title: ModelListResponse description: Paginated list of models. ModelsResponse: properties: object: type: string title: Object default: list data: items: $ref: '#/components/schemas/Model' type: array title: Data type: object required: - data title: ModelsResponse description: 'Response for the /v1/models endpoint following OpenAI API specification. Contains a list of available models and response metadata.' MoonshotThinkingOptions: properties: type: type: string enum: - enabled - disabled title: Type description: Enable or disable thinking capability. type: object required: - type title: MoonshotThinkingOptions description: 'Thinking configuration for Moonshot models. Controls whether thinking is enabled for the model.' NamespaceTool: properties: description: type: string title: Description description: Description shown to the model. name: type: string title: Name description: Namespace name. tools: items: oneOf: - $ref: '#/components/schemas/NamespaceToolFunction' - $ref: '#/components/schemas/stdapi__types__openai_responses__CustomTool' discriminator: propertyName: type mapping: custom: '#/components/schemas/stdapi__types__openai_responses__CustomTool' function: '#/components/schemas/NamespaceToolFunction' type: array title: Tools description: Tools available in this namespace. type: type: string const: namespace title: Type description: Namespace tool type. type: object required: - description - name - tools - type title: NamespaceTool description: 'Groups function/custom tools under a shared namespace. UNSUPPORTED on this implementation.' NamespaceToolFunction: properties: name: type: string title: Name description: Function name. type: type: string const: function title: Type description: Function type. defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: Deferred and discovered via tool search. description: anyOf: - type: string - type: 'null' title: Description description: Function description. parameters: anyOf: - {} - type: 'null' title: Parameters description: Parameter schema. strict: anyOf: - type: boolean - type: 'null' title: Strict description: Enforce strict validation. type: object required: - name - type title: NamespaceToolFunction description: A function tool within a namespace. OutputConfigParam: properties: effort: anyOf: - type: string enum: - low - medium - high - xhigh - max - type: 'null' title: Effort description: Effort level for the model's output processing. format: anyOf: - $ref: '#/components/schemas/JSONOutputFormatParam' - type: 'null' description: A schema to specify output format in responses. See structured outputs documentation. type: object title: OutputConfigParam description: Configuration options for the model's output. OutputTokensDetails: properties: reasoning_tokens: type: integer title: Reasoning Tokens description: Reasoning token count. additionalProperties: false type: object required: - reasoning_tokens title: OutputTokensDetails description: A detailed breakdown of the output tokens. PendingSafetyCheck: properties: id: type: string title: Id description: Safety check ID. code: anyOf: - type: string - type: 'null' title: Code description: Safety check type. message: anyOf: - type: string - type: 'null' title: Message description: Safety check details. additionalProperties: false type: object required: - id title: PendingSafetyCheck description: A pending safety check for the computer call. PlainTextSource: properties: data: type: string title: Data description: The data content. media_type: type: string const: text/plain title: Media Type description: The media type. type: type: string const: text title: Type description: Type discriminator. additionalProperties: false type: object required: - data - media_type - type title: PlainTextSource description: Plain text source. PlainTextSourceParam: properties: data: type: string title: Data description: Data content. media_type: type: string const: text/plain title: Media Type description: Media type. type: type: string const: text title: Type description: Type discriminator. type: object required: - data - media_type - type title: PlainTextSourceParam description: Plain text source for document content block. PromptTokensDetails: properties: audio_tokens: anyOf: - type: integer - type: 'null' title: Audio Tokens description: Audio input tokens present in the prompt. cached_tokens: anyOf: - type: integer - type: 'null' title: Cached Tokens description: Cached tokens present in the prompt. additionalProperties: false type: object title: PromptTokensDetails description: Breakdown of tokens used in the prompt. QwenTranslationMemory: properties: source: type: string title: Source description: Source statement target: type: string title: Target description: Target translation statement type: object required: - source - target title: QwenTranslationMemory description: 'Translation memory entry for Qwen translation. Provides example translations to guide the model.' QwenTranslationOptions: properties: source_lang: type: string title: Source Lang description: Source language name in English, or "auto" for auto-detection. target_lang: type: string title: Target Lang description: Target language name in English. terms: anyOf: - items: $ref: '#/components/schemas/QwenTranslationTerm' type: array - type: 'null' title: Terms description: Custom term translations with source and target. tm_list: anyOf: - items: $ref: '#/components/schemas/QwenTranslationMemory' type: array - type: 'null' title: Tm List description: Translation memory with source and target statements. domains: anyOf: - type: string - type: 'null' title: Domains description: Domain hint in English (e.g., "medical", "legal", "technical"). type: object required: - source_lang - target_lang title: QwenTranslationOptions description: 'Translation options for Qwen models with translation capabilities. Configures source/target languages, custom term translations, translation memory, and domain hints for specialized translation tasks.' QwenTranslationTerm: properties: source: type: string title: Source description: Source term to translate target: type: string title: Target description: Target translation for the term type: object required: - source - target title: QwenTranslationTerm description: 'Term intervention for Qwen translation. Allows specifying custom translations for specific terms.' Reasoning: properties: effort: anyOf: - type: string enum: - none - minimal - low - medium - high - xhigh - type: 'null' title: Effort description: 'Reasoning effort: `none`, `minimal`, `low`, `medium`, `high`, or `xhigh`.' generate_summary: anyOf: - type: string enum: - auto - concise - detailed - type: 'null' title: Generate Summary description: 'Deprecated: use `summary` instead.' summary: anyOf: - type: string enum: - auto - concise - detailed - type: 'null' title: Summary description: 'Reasoning summary: `auto`, `concise`, or `detailed`.' type: object title: Reasoning description: Configuration options for reasoning models. ReasoningItemContent: properties: text: type: string title: Text description: Reasoning text. type: type: string const: reasoning_text title: Type description: Reasoning text type. additionalProperties: false type: object required: - text - type title: ReasoningItemContent description: Reasoning text from the model. ReasoningItemSummary: properties: text: type: string title: Text description: Reasoning summary. type: type: string const: summary_text title: Type description: Summary text type. additionalProperties: false type: object required: - text - type title: ReasoningItemSummary description: A summary text from the model. RedactedThinkingBlock: properties: type: type: string const: redacted_thinking title: Type description: Content block type. Always `redacted_thinking`. data: type: string title: Data description: The redacted thinking content as a base64-encoded string. additionalProperties: false type: object required: - type - data title: RedactedThinkingBlock description: Redacted thinking content block. RedactedThinkingBlockParam: properties: type: type: string const: redacted_thinking title: Type description: Content block type. Always `redacted_thinking`. data: type: string title: Data description: The redacted thinking content as a base64-encoded string. type: object required: - type - data title: RedactedThinkingBlockParam description: Redacted thinking content block parameter. RegionName: type: string Response: properties: id: type: string title: Id description: Response ID. created_at: type: number title: Created At description: Unix timestamp of creation. error: anyOf: - $ref: '#/components/schemas/ResponseError' - type: 'null' description: Response error if failed. incomplete_details: anyOf: - $ref: '#/components/schemas/IncompleteDetails' - type: 'null' description: Incomplete details. instructions: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/EasyInputMessage' - $ref: '#/components/schemas/InputMessage' - $ref: '#/components/schemas/ComputerCallOutput' - $ref: '#/components/schemas/FunctionCallInput' - $ref: '#/components/schemas/FunctionCallOutput' - $ref: '#/components/schemas/ToolSearchCallInput' - $ref: '#/components/schemas/ImageGenerationCallInput' - $ref: '#/components/schemas/LocalShellCallInput' - $ref: '#/components/schemas/LocalShellCallOutputInput' - $ref: '#/components/schemas/ShellCall' - $ref: '#/components/schemas/ShellCallOutput' - $ref: '#/components/schemas/ApplyPatchCall' - $ref: '#/components/schemas/ApplyPatchCallOutput' - $ref: '#/components/schemas/McpListToolsInput' - $ref: '#/components/schemas/McpApprovalRequestInput' - $ref: '#/components/schemas/McpApprovalResponse' - $ref: '#/components/schemas/McpCallInput' - $ref: '#/components/schemas/CompactionItemParam' - $ref: '#/components/schemas/ItemReference' - $ref: '#/components/schemas/ResponseOutputMessage-Output' - $ref: '#/components/schemas/ResponseReasoningItem' type: array - type: 'null' title: Instructions description: System or developer message. metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Metadata description: Key-value pairs for the response. model: type: string title: Model description: Model ID. object: type: string const: response title: Object description: Object type. output: items: oneOf: - $ref: '#/components/schemas/ResponseOutputMessage-Output' - $ref: '#/components/schemas/ResponseFileSearchToolCall' - $ref: '#/components/schemas/ResponseFunctionToolCall' - $ref: '#/components/schemas/ResponseFunctionToolCallOutputItem' - $ref: '#/components/schemas/ResponseFunctionWebSearch' - $ref: '#/components/schemas/ResponseComputerToolCall' - $ref: '#/components/schemas/ResponseComputerToolCallOutputItem' - $ref: '#/components/schemas/ResponseReasoningItem' - $ref: '#/components/schemas/ResponseToolSearchCall' - $ref: '#/components/schemas/ResponseToolSearchOutputItem' - $ref: '#/components/schemas/ResponseCompactionItem' - $ref: '#/components/schemas/ImageGenerationCall' - $ref: '#/components/schemas/ResponseCodeInterpreterToolCall' - $ref: '#/components/schemas/LocalShellCall' - $ref: '#/components/schemas/LocalShellCallOutput' - $ref: '#/components/schemas/ResponseFunctionShellToolCall' - $ref: '#/components/schemas/ResponseFunctionShellToolCallOutput' - $ref: '#/components/schemas/ResponseApplyPatchToolCall' - $ref: '#/components/schemas/ResponseApplyPatchToolCallOutput' - $ref: '#/components/schemas/McpCall' - $ref: '#/components/schemas/McpListTools' - $ref: '#/components/schemas/McpApprovalRequest' - $ref: '#/components/schemas/McpApprovalResponseOutput' - $ref: '#/components/schemas/ResponseCustomToolCall' - $ref: '#/components/schemas/ResponseCustomToolCallOutputItem' discriminator: propertyName: type mapping: apply_patch_call: '#/components/schemas/ResponseApplyPatchToolCall' apply_patch_call_output: '#/components/schemas/ResponseApplyPatchToolCallOutput' code_interpreter_call: '#/components/schemas/ResponseCodeInterpreterToolCall' compaction: '#/components/schemas/ResponseCompactionItem' computer_call: '#/components/schemas/ResponseComputerToolCall' computer_call_output: '#/components/schemas/ResponseComputerToolCallOutputItem' custom_tool_call: '#/components/schemas/ResponseCustomToolCall' custom_tool_call_output: '#/components/schemas/ResponseCustomToolCallOutputItem' file_search_call: '#/components/schemas/ResponseFileSearchToolCall' function_call: '#/components/schemas/ResponseFunctionToolCall' function_call_output: '#/components/schemas/ResponseFunctionToolCallOutputItem' image_generation_call: '#/components/schemas/ImageGenerationCall' local_shell_call: '#/components/schemas/LocalShellCall' local_shell_call_output: '#/components/schemas/LocalShellCallOutput' mcp_approval_request: '#/components/schemas/McpApprovalRequest' mcp_approval_response: '#/components/schemas/McpApprovalResponseOutput' mcp_call: '#/components/schemas/McpCall' mcp_list_tools: '#/components/schemas/McpListTools' message: '#/components/schemas/ResponseOutputMessage-Output' reasoning: '#/components/schemas/ResponseReasoningItem' shell_call: '#/components/schemas/ResponseFunctionShellToolCall' shell_call_output: '#/components/schemas/ResponseFunctionShellToolCallOutput' tool_search_call: '#/components/schemas/ResponseToolSearchCall' tool_search_output: '#/components/schemas/ResponseToolSearchOutputItem' web_search_call: '#/components/schemas/ResponseFunctionWebSearch' type: array title: Output description: Generated content items. parallel_tool_calls: type: boolean title: Parallel Tool Calls description: Allow parallel tool calls. temperature: anyOf: - type: number - type: 'null' title: Temperature description: Sampling temperature (0-2). tool_choice: anyOf: - type: string enum: - none - auto - required - $ref: '#/components/schemas/ToolChoiceAllowed' - $ref: '#/components/schemas/ToolChoiceTypes' - $ref: '#/components/schemas/ToolChoiceFunction' - $ref: '#/components/schemas/ToolChoiceMcp' - $ref: '#/components/schemas/ToolChoiceCustom' - $ref: '#/components/schemas/ToolChoiceApplyPatch' - $ref: '#/components/schemas/ToolChoiceShell' title: Tool Choice description: Tool selection method. tools: items: oneOf: - $ref: '#/components/schemas/FunctionTool' - $ref: '#/components/schemas/FileSearchTool' - $ref: '#/components/schemas/ComputerTool' - $ref: '#/components/schemas/ComputerUsePreviewTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/Mcp' - $ref: '#/components/schemas/CodeInterpreter' - $ref: '#/components/schemas/ImageGeneration' - $ref: '#/components/schemas/LocalShell' - $ref: '#/components/schemas/FunctionShellTool' - $ref: '#/components/schemas/stdapi__types__openai_responses__CustomTool' - $ref: '#/components/schemas/NamespaceTool' - $ref: '#/components/schemas/ToolSearchTool' - $ref: '#/components/schemas/WebSearchPreviewTool' - $ref: '#/components/schemas/ApplyPatchTool' discriminator: propertyName: type mapping: apply_patch: '#/components/schemas/ApplyPatchTool' code_interpreter: '#/components/schemas/CodeInterpreter' computer: '#/components/schemas/ComputerTool' computer_use_preview: '#/components/schemas/ComputerUsePreviewTool' custom: '#/components/schemas/stdapi__types__openai_responses__CustomTool' file_search: '#/components/schemas/FileSearchTool' function: '#/components/schemas/FunctionTool' image_generation: '#/components/schemas/ImageGeneration' local_shell: '#/components/schemas/LocalShell' mcp: '#/components/schemas/Mcp' namespace: '#/components/schemas/NamespaceTool' shell: '#/components/schemas/FunctionShellTool' tool_search: '#/components/schemas/ToolSearchTool' web_search: '#/components/schemas/WebSearchTool' web_search_2025_08_26: '#/components/schemas/WebSearchTool' web_search_preview: '#/components/schemas/WebSearchPreviewTool' web_search_preview_2025_03_11: '#/components/schemas/WebSearchPreviewTool' type: array title: Tools description: Available tools. top_p: anyOf: - type: number - type: 'null' title: Top P description: Nucleus sampling parameter. background: anyOf: - type: boolean - type: 'null' title: Background description: Run in background. completed_at: anyOf: - type: number - type: 'null' title: Completed At description: Completion timestamp. conversation: anyOf: - $ref: '#/components/schemas/Conversation' - type: 'null' description: Conversation. max_output_tokens: anyOf: - type: integer - type: 'null' title: Max Output Tokens description: Max output tokens. max_tool_calls: anyOf: - type: integer - type: 'null' title: Max Tool Calls description: Max tool calls allowed. previous_response_id: anyOf: - type: string - type: 'null' title: Previous Response Id description: Previous response ID for multi-turn. prompt: anyOf: - $ref: '#/components/schemas/ResponsePrompt' - type: 'null' description: Prompt template reference. prompt_cache_key: anyOf: - type: string - type: 'null' title: Prompt Cache Key description: Cache key for similar requests. prompt_cache_retention: anyOf: - type: string enum: - in-memory - 24h - 1h - 5m - type: 'null' title: Prompt Cache Retention description: Cache retention policy. reasoning: anyOf: - $ref: '#/components/schemas/Reasoning' - type: 'null' description: Reasoning configuration. safety_identifier: anyOf: - type: string - type: 'null' title: Safety Identifier description: User policy violation identifier. service_tier: anyOf: - type: string enum: - auto - default - flex - scale - priority - type: 'null' title: Service Tier description: Service tier for request. status: anyOf: - type: string enum: - completed - failed - in_progress - cancelled - queued - incomplete - type: 'null' title: Status description: Response status. text: anyOf: - $ref: '#/components/schemas/ResponseTextConfig' - type: 'null' description: Text response config. top_logprobs: anyOf: - type: integer - type: 'null' title: Top Logprobs description: Top logprobs count (0-20). truncation: anyOf: - type: string enum: - auto - disabled - type: 'null' title: Truncation description: Truncation strategy. usage: anyOf: - $ref: '#/components/schemas/ResponseUsage' - type: 'null' description: Token usage details. user: anyOf: - type: string - type: 'null' title: User description: User identifier (use safety_identifier instead). additionalProperties: false type: object required: - id - created_at - model - object - output - parallel_tool_calls - tool_choice - tools title: Response description: A model response from the Responses API. ResponseApplyPatchOperationCreateFile: properties: diff: type: string title: Diff description: Diff to apply. path: type: string title: Path description: Path of the file to create. type: type: string const: create_file title: Type description: Create a new file with the provided diff. additionalProperties: false type: object required: - diff - path - type title: ResponseApplyPatchOperationCreateFile description: Instruction describing how to create a file via the apply_patch tool. ResponseApplyPatchOperationDeleteFile: properties: path: type: string title: Path description: Path of the file to delete. type: type: string const: delete_file title: Type description: Delete the specified file. additionalProperties: false type: object required: - path - type title: ResponseApplyPatchOperationDeleteFile description: Instruction describing how to delete a file via the apply_patch tool. ResponseApplyPatchOperationUpdateFile: properties: diff: type: string title: Diff description: Diff to apply. path: type: string title: Path description: Path of the file to update. type: type: string const: update_file title: Type description: Update an existing file with the provided diff. additionalProperties: false type: object required: - diff - path - type title: ResponseApplyPatchOperationUpdateFile description: Instruction describing how to update a file via the apply_patch tool. ResponseApplyPatchToolCall: properties: id: type: string title: Id description: Apply patch tool call ID. call_id: type: string title: Call Id description: Model-generated apply patch call ID. operation: oneOf: - $ref: '#/components/schemas/ResponseApplyPatchOperationCreateFile' - $ref: '#/components/schemas/ResponseApplyPatchOperationDeleteFile' - $ref: '#/components/schemas/ResponseApplyPatchOperationUpdateFile' title: Operation description: Patch operation to apply. discriminator: propertyName: type mapping: create_file: '#/components/schemas/ResponseApplyPatchOperationCreateFile' delete_file: '#/components/schemas/ResponseApplyPatchOperationDeleteFile' update_file: '#/components/schemas/ResponseApplyPatchOperationUpdateFile' status: type: string enum: - in_progress - completed title: Status description: Apply patch status. type: type: string const: apply_patch_call title: Type description: Apply patch call type. created_by: anyOf: - type: string - type: 'null' title: Created By description: Tool call creator. additionalProperties: false type: object required: - id - call_id - operation - status - type title: ResponseApplyPatchToolCall description: A tool call that applies file diffs by creating, deleting, or updating files. ResponseApplyPatchToolCallOutput: properties: id: type: string title: Id description: Apply patch output ID. call_id: type: string title: Call Id description: Apply patch call ID. status: type: string enum: - completed - failed title: Status description: Output status. type: type: string const: apply_patch_call_output title: Type description: Apply patch output type. created_by: anyOf: - type: string - type: 'null' title: Created By description: Output creator. output: anyOf: - type: string - type: 'null' title: Output description: Textual output from apply patch. additionalProperties: false type: object required: - id - call_id - status - type title: ResponseApplyPatchToolCallOutput description: The output emitted by an apply patch tool call. ResponseCodeInterpreterToolCall: properties: id: type: string title: Id description: Code interpreter tool call ID. container_id: type: string title: Container Id description: Container ID. status: type: string enum: - in_progress - completed - incomplete - interpreting - failed title: Status description: Code interpreter status. type: type: string const: code_interpreter_call title: Type description: Code interpreter call type. code: anyOf: - type: string - type: 'null' title: Code description: Code to run. outputs: anyOf: - items: oneOf: - $ref: '#/components/schemas/CodeInterpreterOutputLogs' - $ref: '#/components/schemas/CodeInterpreterOutputImage' discriminator: propertyName: type mapping: image: '#/components/schemas/CodeInterpreterOutputImage' logs: '#/components/schemas/CodeInterpreterOutputLogs' type: array - type: 'null' title: Outputs description: Code interpreter outputs (logs or images). additionalProperties: false type: object required: - id - container_id - status - type title: ResponseCodeInterpreterToolCall description: A tool call to run code. ResponseCompactionItem: properties: id: type: string title: Id description: Compaction item ID. encrypted_content: type: string title: Encrypted Content description: Encrypted compaction content. type: type: string const: compaction title: Type description: Compaction type. created_by: anyOf: - type: string - type: 'null' title: Created By description: Item creator. additionalProperties: false type: object required: - id - encrypted_content - type title: ResponseCompactionItem description: A compaction item generated by the v1/responses/compact API. ResponseComputerToolCall: properties: id: type: string title: Id description: Computer call ID. call_id: type: string title: Call Id description: Response identifier. pending_safety_checks: items: $ref: '#/components/schemas/PendingSafetyCheck' type: array title: Pending Safety Checks description: Pending safety checks. status: type: string enum: - in_progress - completed - incomplete title: Status description: Call status. type: type: string const: computer_call title: Type description: Computer call type. action: anyOf: - oneOf: - $ref: '#/components/schemas/ComputerActionClick' - $ref: '#/components/schemas/ComputerActionDoubleClick' - $ref: '#/components/schemas/ComputerActionDrag' - $ref: '#/components/schemas/ComputerActionKeypress' - $ref: '#/components/schemas/ComputerActionMove' - $ref: '#/components/schemas/ComputerActionScreenshot' - $ref: '#/components/schemas/ComputerActionScroll' - $ref: '#/components/schemas/ComputerActionType' - $ref: '#/components/schemas/ComputerActionWait' discriminator: propertyName: type mapping: click: '#/components/schemas/ComputerActionClick' double_click: '#/components/schemas/ComputerActionDoubleClick' drag: '#/components/schemas/ComputerActionDrag' keypress: '#/components/schemas/ComputerActionKeypress' move: '#/components/schemas/ComputerActionMove' screenshot: '#/components/schemas/ComputerActionScreenshot' scroll: '#/components/schemas/ComputerActionScroll' type: '#/components/schemas/ComputerActionType' wait: '#/components/schemas/ComputerActionWait' - type: 'null' title: Action description: Action to perform. actions: anyOf: - items: oneOf: - $ref: '#/components/schemas/ComputerActionClick' - $ref: '#/components/schemas/ComputerActionDoubleClick' - $ref: '#/components/schemas/ComputerActionDrag' - $ref: '#/components/schemas/ComputerActionKeypress' - $ref: '#/components/schemas/ComputerActionMove' - $ref: '#/components/schemas/ComputerActionScreenshot' - $ref: '#/components/schemas/ComputerActionScroll' - $ref: '#/components/schemas/ComputerActionType' - $ref: '#/components/schemas/ComputerActionWait' discriminator: propertyName: type mapping: click: '#/components/schemas/ComputerActionClick' double_click: '#/components/schemas/ComputerActionDoubleClick' drag: '#/components/schemas/ComputerActionDrag' keypress: '#/components/schemas/ComputerActionKeypress' move: '#/components/schemas/ComputerActionMove' screenshot: '#/components/schemas/ComputerActionScreenshot' scroll: '#/components/schemas/ComputerActionScroll' type: '#/components/schemas/ComputerActionType' wait: '#/components/schemas/ComputerActionWait' type: array - type: 'null' title: Actions description: Batched actions for computer_use. additionalProperties: false type: object required: - id - call_id - pending_safety_checks - status - type title: ResponseComputerToolCall description: A tool call to a computer use tool. ResponseComputerToolCallOutputItem: properties: id: type: string title: Id description: Computer call output ID. call_id: type: string title: Call Id description: Computer tool call ID. output: $ref: '#/components/schemas/ResponseComputerToolCallOutputScreenshot' description: Computer screenshot. status: type: string enum: - completed - incomplete - failed - in_progress title: Status description: Output status. type: type: string const: computer_call_output title: Type description: Computer call output type. acknowledged_safety_checks: anyOf: - items: $ref: '#/components/schemas/AcknowledgedSafetyCheck' type: array - type: 'null' title: Acknowledged Safety Checks description: Acknowledged safety checks. created_by: anyOf: - type: string - type: 'null' title: Created By description: Item creator. additionalProperties: false type: object required: - id - call_id - output - status - type title: ResponseComputerToolCallOutputItem description: The output of a computer tool call. ResponseComputerToolCallOutputScreenshot: properties: type: type: string const: computer_screenshot title: Type description: Computer screenshot. file_id: anyOf: - type: string - type: 'null' title: File Id description: Uploaded file with screenshot. image_url: anyOf: - type: string - type: 'null' title: Image Url description: Screenshot URL. type: object required: - type title: ResponseComputerToolCallOutputScreenshot description: A computer screenshot image used with the computer use tool. ResponseContainerReference: properties: container_id: type: string title: Container Id description: The container ID. type: type: string const: container_reference title: Type description: The environment type. Always `container_reference`. additionalProperties: false type: object required: - container_id - type title: ResponseContainerReference description: Represents a container created with /v1/containers. ResponseCreateParams: properties: model: type: string title: Model description: Model ID used to generate the response. input: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/EasyInputMessage' - $ref: '#/components/schemas/InputMessage' - $ref: '#/components/schemas/ComputerCallOutput' - $ref: '#/components/schemas/FunctionCallInput' - $ref: '#/components/schemas/FunctionCallOutput' - $ref: '#/components/schemas/ToolSearchCallInput' - $ref: '#/components/schemas/ImageGenerationCallInput' - $ref: '#/components/schemas/LocalShellCallInput' - $ref: '#/components/schemas/LocalShellCallOutputInput' - $ref: '#/components/schemas/ShellCall' - $ref: '#/components/schemas/ShellCallOutput' - $ref: '#/components/schemas/ApplyPatchCall' - $ref: '#/components/schemas/ApplyPatchCallOutput' - $ref: '#/components/schemas/McpListToolsInput' - $ref: '#/components/schemas/McpApprovalRequestInput' - $ref: '#/components/schemas/McpApprovalResponse' - $ref: '#/components/schemas/McpCallInput' - $ref: '#/components/schemas/CompactionItemParam' - $ref: '#/components/schemas/ItemReference' - $ref: '#/components/schemas/ResponseOutputMessage-Input' - $ref: '#/components/schemas/ResponseReasoningItem' type: array - type: 'null' title: Input description: Text, image, or file inputs to the model, used to generate a response. background: anyOf: - type: boolean - type: 'null' title: Background description: 'Whether to run the model response in the background. UNSUPPORTED on this implementation.' context_management: anyOf: - items: $ref: '#/components/schemas/ContextManagement' type: array - type: 'null' title: Context Management description: 'Context management configuration for this request. UNSUPPORTED on this implementation.' conversation: anyOf: - type: string - $ref: '#/components/schemas/ConversationObject' - type: 'null' title: Conversation description: 'The conversation that this response belongs to. Cannot be used with `previous_response_id`. UNSUPPORTED on this implementation.' include: anyOf: - items: type: string enum: - file_search_call.results - web_search_call.results - web_search_call.action.sources - message.input_image.image_url - computer_call_output.output.image_url - code_interpreter_call.outputs - reasoning.encrypted_content - message.output_text.logprobs type: array - type: 'null' title: Include description: Specify additional output data to include in the model response. instructions: anyOf: - type: string - type: 'null' title: Instructions description: A system (or developer) message inserted into the model's context. max_output_tokens: anyOf: - type: integer exclusiveMinimum: 0.0 - type: 'null' title: Max Output Tokens description: An upper bound for the number of tokens that can be generated for a response. max_tool_calls: anyOf: - type: integer - type: 'null' title: Max Tool Calls description: 'The maximum number of total calls to built-in tools that can be processed in a response. UNSUPPORTED on this implementation.' metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Metadata description: Set of 16 key-value pairs that can be attached to an object. parallel_tool_calls: anyOf: - type: boolean - type: 'null' title: Parallel Tool Calls description: Whether to allow the model to run tool calls in parallel. previous_response_id: anyOf: - type: string - type: 'null' title: Previous Response Id description: The unique ID of the previous response. Use to create multi-turn conversations. prompt: anyOf: - $ref: '#/components/schemas/ResponsePrompt' - type: 'null' description: 'Reference to a prompt template and its variables. UNSUPPORTED on this implementation.' prompt_cache_key: anyOf: - type: string - type: 'null' title: Prompt Cache Key description: Cache key for similar requests. prompt_cache_retention: anyOf: - type: string enum: - in-memory - 24h - 1h - 5m - type: 'null' title: Prompt Cache Retention description: Cache retention policy. reasoning: anyOf: - $ref: '#/components/schemas/Reasoning' - type: 'null' description: Reasoning configuration. safety_identifier: anyOf: - type: string - type: 'null' title: Safety Identifier description: 'User policy violation identifier. UNSUPPORTED on this implementation.' service_tier: anyOf: - type: string enum: - auto - default - flex - scale - priority - type: 'null' title: Service Tier description: Service tier for request. store: anyOf: - type: boolean - type: 'null' title: Store description: 'Store response for later retrieval. UNSUPPORTED on this implementation.' stream: anyOf: - type: boolean - type: 'null' title: Stream description: Stream response as it is generated. stream_options: anyOf: - $ref: '#/components/schemas/StreamOptions' - type: 'null' description: 'Streaming options. UNSUPPORTED on this implementation.' temperature: anyOf: - type: number maximum: 2.0 minimum: 0.0 - type: 'null' title: Temperature description: Sampling temperature (0-2). text: anyOf: - $ref: '#/components/schemas/ResponseTextConfig' - type: 'null' description: Text response config. tool_choice: anyOf: - type: string enum: - none - auto - required - $ref: '#/components/schemas/ToolChoiceAllowed' - $ref: '#/components/schemas/ToolChoiceTypes' - $ref: '#/components/schemas/ToolChoiceFunction' - $ref: '#/components/schemas/ToolChoiceMcp' - $ref: '#/components/schemas/ToolChoiceCustom' - $ref: '#/components/schemas/ToolChoiceApplyPatch' - $ref: '#/components/schemas/ToolChoiceShell' - type: 'null' title: Tool Choice description: Tool selection method. tools: anyOf: - items: oneOf: - $ref: '#/components/schemas/FunctionTool' - $ref: '#/components/schemas/FileSearchTool' - $ref: '#/components/schemas/ComputerTool' - $ref: '#/components/schemas/ComputerUsePreviewTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/Mcp' - $ref: '#/components/schemas/CodeInterpreter' - $ref: '#/components/schemas/ImageGeneration' - $ref: '#/components/schemas/LocalShell' - $ref: '#/components/schemas/FunctionShellTool' - $ref: '#/components/schemas/stdapi__types__openai_responses__CustomTool' - $ref: '#/components/schemas/NamespaceTool' - $ref: '#/components/schemas/ToolSearchTool' - $ref: '#/components/schemas/WebSearchPreviewTool' - $ref: '#/components/schemas/ApplyPatchTool' discriminator: propertyName: type mapping: apply_patch: '#/components/schemas/ApplyPatchTool' code_interpreter: '#/components/schemas/CodeInterpreter' computer: '#/components/schemas/ComputerTool' computer_use_preview: '#/components/schemas/ComputerUsePreviewTool' custom: '#/components/schemas/stdapi__types__openai_responses__CustomTool' file_search: '#/components/schemas/FileSearchTool' function: '#/components/schemas/FunctionTool' image_generation: '#/components/schemas/ImageGeneration' local_shell: '#/components/schemas/LocalShell' mcp: '#/components/schemas/Mcp' namespace: '#/components/schemas/NamespaceTool' shell: '#/components/schemas/FunctionShellTool' tool_search: '#/components/schemas/ToolSearchTool' web_search: '#/components/schemas/WebSearchTool' web_search_2025_08_26: '#/components/schemas/WebSearchTool' web_search_preview: '#/components/schemas/WebSearchPreviewTool' web_search_preview_2025_03_11: '#/components/schemas/WebSearchPreviewTool' type: array - type: 'null' title: Tools description: Available tools. top_logprobs: anyOf: - type: integer maximum: 20.0 minimum: 0.0 - type: 'null' title: Top Logprobs description: Top logprobs count (0-20). top_p: anyOf: - type: number maximum: 1.0 minimum: 0.0 - type: 'null' title: Top P description: Nucleus sampling parameter. truncation: anyOf: - type: string enum: - auto - disabled - type: 'null' title: Truncation description: 'Truncation strategy. UNSUPPORTED on this implementation.' user: anyOf: - type: string - type: 'null' title: User description: User identifier (use safety_identifier instead). type: object required: - model title: ResponseCreateParams description: Request body for POST /v1/responses. ResponseCustomToolCall: properties: call_id: type: string title: Call Id description: An identifier used to map this custom tool call to a tool call output. input: type: string title: Input description: The input for the custom tool call generated by the model. name: type: string title: Name description: The name of the custom tool being called. type: type: string const: custom_tool_call title: Type description: The type of the custom tool call. Always `custom_tool_call`. id: anyOf: - type: string - type: 'null' title: Id description: The unique ID of the custom tool call. namespace: anyOf: - type: string - type: 'null' title: Namespace description: The namespace of the custom tool being called. additionalProperties: false type: object required: - call_id - input - name - type title: ResponseCustomToolCall description: A call to a custom tool created by the model. ResponseCustomToolCallOutputItem: properties: call_id: type: string title: Call Id description: The call ID, used to map this custom tool call output to a custom tool call. output: anyOf: - type: string - items: oneOf: - $ref: '#/components/schemas/ResponseInputText' - $ref: '#/components/schemas/ResponseInputImage' - $ref: '#/components/schemas/ResponseInputFile' - $ref: '#/components/schemas/ResponseOutputTextContent' discriminator: propertyName: type mapping: input_file: '#/components/schemas/ResponseInputFile' input_image: '#/components/schemas/ResponseInputImage' input_text: '#/components/schemas/ResponseInputText' output_text: '#/components/schemas/ResponseOutputTextContent' type: array title: Output description: The output from the custom tool call. Can be a string or a list of output content. type: type: string const: custom_tool_call_output title: Type description: The type of the custom tool call output. Always `custom_tool_call_output`. id: type: string title: Id description: The unique ID of the custom tool call output item. status: type: string enum: - in_progress - completed - incomplete title: Status description: The status of the item. created_by: anyOf: - type: string - type: 'null' title: Created By description: The identifier of the actor that created the item. additionalProperties: false type: object required: - call_id - output - type - id - status title: ResponseCustomToolCallOutputItem description: A custom tool call output item returned via API. ResponseError: properties: code: type: string enum: - server_error - rate_limit_exceeded - invalid_prompt - vector_store_timeout - invalid_image - invalid_image_format - invalid_base64_image - invalid_image_url - image_too_large - image_too_small - image_parse_error - image_content_policy_violation - invalid_image_mode - image_file_too_large - unsupported_image_media_type - empty_image_file - failed_to_download_image - image_file_not_found title: Code description: Error code. message: type: string title: Message description: Error message. additionalProperties: false type: object required: - code - message title: ResponseError description: An error object returned when the model fails to generate a response. ResponseFileSearchToolCall: properties: id: type: string title: Id description: File search tool call ID. queries: items: type: string type: array title: Queries description: Search queries. status: type: string enum: - in_progress - searching - completed - incomplete - failed title: Status description: File search status. type: type: string const: file_search_call title: Type description: File search call type. results: anyOf: - items: $ref: '#/components/schemas/FileSearchResult' type: array - type: 'null' title: Results description: File search results. additionalProperties: false type: object required: - id - queries - status - type title: ResponseFileSearchToolCall description: The results of a file search tool call. ResponseFormatJSONObject: properties: type: type: string const: json_object title: Type description: The type of response format. Always `json_object`. default: json_object additionalProperties: false type: object title: ResponseFormatJSONObject description: The type of response format being defined. ResponseFormatJSONSchema: properties: strict: anyOf: - type: boolean - type: 'null' title: Strict description: Whether to enable strict schema adherence when generating the function call. If true, the model follows the exact schema in `parameters`; only a subset of JSON Schema is supported in that case. type: type: string const: json_schema title: Type description: The type of response format. Always `json_schema`. default: json_schema json_schema: $ref: '#/components/schemas/JSONSchema' description: Structured Outputs JSON Schema configuration. type: object required: - json_schema title: ResponseFormatJSONSchema description: "Structured Outputs configuration options, including a JSON Schema.\n\ \nAttributes:\n type: Must be \"json_schema\".\n json_schema: Structured\ \ Outputs JSON Schema configuration." ResponseFormatText: properties: type: type: string const: text title: Type description: The type of response format. Always `text`. default: text additionalProperties: false type: object title: ResponseFormatText description: The type of response format being defined. ResponseFormatTextJSONSchemaConfig: properties: name: type: string title: Name description: Response format name (a-z, A-Z, 0-9, underscores, dashes; max 64 chars). schema: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object title: Schema description: JSON Schema for response format. type: type: string const: json_schema title: Type description: JSON schema response format. description: anyOf: - type: string - type: 'null' title: Description description: Description of the response format for the model. strict: anyOf: - type: boolean - type: 'null' title: Strict description: Enable strict schema adherence. type: object required: - name - schema - type title: ResponseFormatTextJSONSchemaConfig description: JSON Schema response format for generating structured JSON responses. ResponseFunctionShellToolCall: properties: id: type: string title: Id description: The unique ID of the shell tool call. action: $ref: '#/components/schemas/ResponseFunctionShellToolCallAction' call_id: type: string title: Call Id description: The unique ID of the shell tool call generated by the model. status: type: string enum: - in_progress - completed - incomplete title: Status description: The status of the shell call. type: type: string const: shell_call title: Type description: The type of the item. Always `shell_call`. environment: anyOf: - oneOf: - $ref: '#/components/schemas/ResponseLocalEnvironment' - $ref: '#/components/schemas/ResponseContainerReference' discriminator: propertyName: type mapping: container_reference: '#/components/schemas/ResponseContainerReference' local: '#/components/schemas/ResponseLocalEnvironment' - type: 'null' title: Environment description: Represents the use of a local environment to perform shell actions. created_by: anyOf: - type: string - type: 'null' title: Created By description: The ID of the entity that created this tool call. additionalProperties: false type: object required: - id - action - call_id - status - type title: ResponseFunctionShellToolCall description: A tool call that executes one or more shell commands in a managed environment. ResponseFunctionShellToolCallAction: properties: commands: items: type: string type: array title: Commands description: The shell commands to execute. max_output_length: anyOf: - type: integer - type: 'null' title: Max Output Length description: Optional maximum number of characters to return from each command. timeout_ms: anyOf: - type: integer - type: 'null' title: Timeout Ms description: Optional timeout in milliseconds for the commands. additionalProperties: false type: object required: - commands title: ResponseFunctionShellToolCallAction description: The shell commands and limits that describe how to run the tool call. ResponseFunctionShellToolCallOutput: properties: id: type: string title: Id description: The unique ID of the shell call output. call_id: type: string title: Call Id description: The unique ID of the shell tool call generated by the model. output: items: $ref: '#/components/schemas/ShellToolCallOutputContent' type: array title: Output description: An array of shell call output contents. status: type: string enum: - in_progress - completed - incomplete title: Status description: The status of the shell call output. type: type: string const: shell_call_output title: Type description: The type of the shell call output. Always `shell_call_output`. max_output_length: anyOf: - type: integer - type: 'null' title: Max Output Length description: The maximum length of the shell command output. created_by: anyOf: - type: string - type: 'null' title: Created By description: The identifier of the actor that created the item. additionalProperties: false type: object required: - id - call_id - output - status - type title: ResponseFunctionShellToolCallOutput description: The output of a shell tool call that was emitted. ResponseFunctionToolCall: properties: arguments: type: string title: Arguments description: JSON string of function arguments. call_id: type: string title: Call Id description: Function tool call ID. name: type: string title: Name description: Function name. type: type: string const: function_call title: Type description: Function call type. id: anyOf: - type: string - type: 'null' title: Id description: Function call unique ID. namespace: anyOf: - type: string - type: 'null' title: Namespace description: Function namespace. status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status description: 'Item status: `in_progress`, `completed`, or `incomplete`.' additionalProperties: false type: object required: - arguments - call_id - name - type title: ResponseFunctionToolCall description: A tool call to run a function. ResponseFunctionToolCallOutputItem: properties: id: type: string title: Id description: The unique ID of the function call tool output. call_id: type: string title: Call Id description: The unique ID of the function tool call generated by the model. output: anyOf: - type: string - items: oneOf: - $ref: '#/components/schemas/ResponseInputText' - $ref: '#/components/schemas/ResponseInputImage' - $ref: '#/components/schemas/ResponseInputFile' - $ref: '#/components/schemas/ResponseOutputTextContent' discriminator: propertyName: type mapping: input_file: '#/components/schemas/ResponseInputFile' input_image: '#/components/schemas/ResponseInputImage' input_text: '#/components/schemas/ResponseInputText' output_text: '#/components/schemas/ResponseOutputTextContent' type: array title: Output description: The output from the function call. Can be a string or a list of output content. status: type: string enum: - in_progress - completed - incomplete title: Status description: The status of the item. type: type: string const: function_call_output title: Type description: The type of the function tool call output. Always `function_call_output`. created_by: anyOf: - type: string - type: 'null' title: Created By description: The identifier of the actor that created the item. additionalProperties: false type: object required: - id - call_id - output - status - type title: ResponseFunctionToolCallOutputItem description: A function tool call output item returned via API. ResponseFunctionWebSearch: properties: id: type: string title: Id description: Web search tool call ID. action: oneOf: - $ref: '#/components/schemas/WebSearchActionSearch' - $ref: '#/components/schemas/WebSearchActionOpenPage' - $ref: '#/components/schemas/WebSearchActionFind' title: Action description: Web search action taken. discriminator: propertyName: type mapping: find_in_page: '#/components/schemas/WebSearchActionFind' open_page: '#/components/schemas/WebSearchActionOpenPage' search: '#/components/schemas/WebSearchActionSearch' status: type: string enum: - in_progress - searching - completed - failed title: Status description: Web search status. type: type: string const: web_search_call title: Type description: Web search call type. additionalProperties: false type: object required: - id - action - status - type title: ResponseFunctionWebSearch description: The results of a web search tool call. ResponseInputFile: properties: type: type: string const: input_file title: Type description: Input file type. file_data: anyOf: - type: string - type: 'null' title: File Data description: File content. file_id: anyOf: - type: string - type: 'null' title: File Id description: File ID. file_url: anyOf: - type: string - type: 'null' title: File Url description: File URL. filename: anyOf: - type: string - type: 'null' title: Filename description: Filename. type: object required: - type title: ResponseInputFile description: A file input to the model. ResponseInputImage: properties: type: type: string const: input_image title: Type description: Input image type. detail: anyOf: - type: string enum: - low - high - auto - original - type: 'null' title: Detail description: 'Image detail level: `high`, `low`, `auto`, or `original`. Default: auto.' file_id: anyOf: - type: string - type: 'null' title: File Id description: Image file ID. image_url: anyOf: - type: string - type: 'null' title: Image Url description: Image URL or base64 data URL. type: object required: - type title: ResponseInputImage description: An image input to the model. ResponseInputText: properties: text: type: string title: Text description: Text input. type: type: string const: input_text title: Type description: Input text type. type: object required: - text - type title: ResponseInputText description: A text input to the model. ResponseLocalEnvironment: properties: type: type: string const: local title: Type description: The environment type. Always `local`. additionalProperties: false type: object required: - type title: ResponseLocalEnvironment description: Represents the use of a local environment to perform shell actions. ResponseOutputMessage-Input: properties: id: type: string title: Id description: Output message ID. content: items: oneOf: - $ref: '#/components/schemas/ResponseOutputText-Input' - $ref: '#/components/schemas/ResponseOutputRefusal' discriminator: propertyName: type mapping: output_text: '#/components/schemas/ResponseOutputText-Input' refusal: '#/components/schemas/ResponseOutputRefusal' type: array title: Content description: Message content. role: type: string const: assistant title: Role description: Assistant role. status: type: string enum: - in_progress - completed - incomplete title: Status description: Message status. type: type: string const: message title: Type description: Message type. phase: anyOf: - type: string enum: - commentary - final_answer - type: 'null' title: Phase description: Labels assistant message as commentary or final answer. additionalProperties: false type: object required: - id - content - role - status - type title: ResponseOutputMessage description: An output message from the model. ResponseOutputMessage-Output: properties: id: type: string title: Id description: Output message ID. content: items: oneOf: - $ref: '#/components/schemas/ResponseOutputText-Output' - $ref: '#/components/schemas/ResponseOutputRefusal' discriminator: propertyName: type mapping: output_text: '#/components/schemas/ResponseOutputText-Output' refusal: '#/components/schemas/ResponseOutputRefusal' type: array title: Content description: Message content. role: type: string const: assistant title: Role description: Assistant role. status: type: string enum: - in_progress - completed - incomplete title: Status description: Message status. type: type: string const: message title: Type description: Message type. phase: anyOf: - type: string enum: - commentary - final_answer - type: 'null' title: Phase description: Labels assistant message as commentary or final answer. additionalProperties: false type: object required: - id - content - role - status - type title: ResponseOutputMessage description: An output message from the model. ResponseOutputRefusal: properties: refusal: type: string title: Refusal description: Refusal explanation. type: type: string const: refusal title: Type description: Refusal type. additionalProperties: false type: object required: - refusal - type title: ResponseOutputRefusal description: A refusal from the model. ResponseOutputText-Input: properties: annotations: items: oneOf: - $ref: '#/components/schemas/AnnotationFileCitation' - $ref: '#/components/schemas/AnnotationURLCitation-Input' - $ref: '#/components/schemas/AnnotationContainerFileCitation' - $ref: '#/components/schemas/AnnotationFilePath' discriminator: propertyName: type mapping: container_file_citation: '#/components/schemas/AnnotationContainerFileCitation' file_citation: '#/components/schemas/AnnotationFileCitation' file_path: '#/components/schemas/AnnotationFilePath' url_citation: '#/components/schemas/AnnotationURLCitation-Input' type: array title: Annotations description: Text annotations. text: type: string title: Text description: Model text output. type: type: string const: output_text title: Type description: Output text type. logprobs: anyOf: - items: $ref: '#/components/schemas/Logprob' type: array - type: 'null' title: Logprobs description: Output token log probabilities. additionalProperties: false type: object required: - annotations - text - type title: ResponseOutputText description: A text output from the model. ResponseOutputText-Output: properties: annotations: items: oneOf: - $ref: '#/components/schemas/AnnotationFileCitation' - $ref: '#/components/schemas/stdapi__types__openai_responses__AnnotationURLCitation' - $ref: '#/components/schemas/AnnotationContainerFileCitation' - $ref: '#/components/schemas/AnnotationFilePath' discriminator: propertyName: type mapping: container_file_citation: '#/components/schemas/AnnotationContainerFileCitation' file_citation: '#/components/schemas/AnnotationFileCitation' file_path: '#/components/schemas/AnnotationFilePath' url_citation: '#/components/schemas/stdapi__types__openai_responses__AnnotationURLCitation' type: array title: Annotations description: Text annotations. text: type: string title: Text description: Model text output. type: type: string const: output_text title: Type description: Output text type. logprobs: anyOf: - items: $ref: '#/components/schemas/Logprob' type: array - type: 'null' title: Logprobs description: Output token log probabilities. additionalProperties: false type: object required: - annotations - text - type title: ResponseOutputText description: A text output from the model. ResponseOutputTextContent: properties: type: type: string const: output_text title: Type description: Output text type. text: type: string title: Text description: Text content from assistant response. additionalProperties: $ref: '#/components/schemas/JsonValue' type: object required: - type - text title: ResponseOutputTextContent description: An output_text content block echoed back in the input array (previous assistant response). ResponsePrompt: properties: id: type: string title: Id description: The unique identifier of the prompt template to use. variables: anyOf: - additionalProperties: anyOf: - type: string - $ref: '#/components/schemas/ResponseInputText' - $ref: '#/components/schemas/ResponseInputImage' - $ref: '#/components/schemas/ResponseInputFile' type: object - type: 'null' title: Variables description: Optional map of values to substitute in for variables in the prompt template. version: anyOf: - type: string - type: 'null' title: Version description: Optional version of the prompt template. additionalProperties: false type: object required: - id title: ResponsePrompt description: Reference to a prompt template and its variables. ResponseReasoningItem: properties: id: type: string title: Id description: Reasoning content ID. summary: items: $ref: '#/components/schemas/ReasoningItemSummary' type: array title: Summary description: Reasoning summary. type: type: string const: reasoning title: Type description: Reasoning type. content: anyOf: - items: $ref: '#/components/schemas/ReasoningItemContent' type: array - type: 'null' title: Content description: Reasoning text content. encrypted_content: anyOf: - type: string - type: 'null' title: Encrypted Content description: Encrypted reasoning content when included. status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status description: 'Status: `in_progress`, `completed`, or `incomplete`.' additionalProperties: false type: object required: - id - summary - type title: ResponseReasoningItem description: A description of the chain of thought used by a reasoning model while generating a response. ResponseTextConfig: properties: format: anyOf: - oneOf: - $ref: '#/components/schemas/ResponseFormatText' - $ref: '#/components/schemas/ResponseFormatTextJSONSchemaConfig' - $ref: '#/components/schemas/ResponseFormatJSONObject' discriminator: propertyName: type mapping: json_object: '#/components/schemas/ResponseFormatJSONObject' json_schema: '#/components/schemas/ResponseFormatTextJSONSchemaConfig' text: '#/components/schemas/ResponseFormatText' - type: 'null' title: Format description: 'An object specifying the format that the model must output. Configuring `{ "type": "json_schema" }` enables Structured Outputs.' verbosity: anyOf: - type: string enum: - low - medium - high - type: 'null' title: Verbosity description: 'Constrains the verbosity of the model''s response. Values: `low`, `medium`, or `high`.' type: object title: ResponseTextConfig description: Configuration options for a text response from the model. ResponseToolSearchCall: properties: id: type: string title: Id description: Tool search call ID. arguments: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object title: Arguments description: Tool search arguments. execution: type: string enum: - server - client title: Execution description: Server or client execution. status: type: string enum: - in_progress - completed - incomplete title: Status description: Call status. type: type: string const: tool_search_call title: Type description: Tool search call type. call_id: anyOf: - type: string - type: 'null' title: Call Id description: Model-generated call ID. created_by: anyOf: - type: string - type: 'null' title: Created By description: Item creator. additionalProperties: false type: object required: - id - arguments - execution - status - type title: ResponseToolSearchCall description: A tool search call item. ResponseToolSearchOutputItem: properties: id: type: string title: Id description: The unique ID of the tool search output item. execution: type: string enum: - server - client title: Execution description: Whether tool search was executed by the server or by the client. status: type: string enum: - in_progress - completed - incomplete title: Status description: The status of the tool search output item that was recorded. tools: items: oneOf: - $ref: '#/components/schemas/FunctionTool' - $ref: '#/components/schemas/FileSearchTool' - $ref: '#/components/schemas/ComputerTool' - $ref: '#/components/schemas/ComputerUsePreviewTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/Mcp' - $ref: '#/components/schemas/CodeInterpreter' - $ref: '#/components/schemas/ImageGeneration' - $ref: '#/components/schemas/LocalShell' - $ref: '#/components/schemas/FunctionShellTool' - $ref: '#/components/schemas/stdapi__types__openai_responses__CustomTool' - $ref: '#/components/schemas/NamespaceTool' - $ref: '#/components/schemas/ToolSearchTool' - $ref: '#/components/schemas/WebSearchPreviewTool' - $ref: '#/components/schemas/ApplyPatchTool' discriminator: propertyName: type mapping: apply_patch: '#/components/schemas/ApplyPatchTool' code_interpreter: '#/components/schemas/CodeInterpreter' computer: '#/components/schemas/ComputerTool' computer_use_preview: '#/components/schemas/ComputerUsePreviewTool' custom: '#/components/schemas/stdapi__types__openai_responses__CustomTool' file_search: '#/components/schemas/FileSearchTool' function: '#/components/schemas/FunctionTool' image_generation: '#/components/schemas/ImageGeneration' local_shell: '#/components/schemas/LocalShell' mcp: '#/components/schemas/Mcp' namespace: '#/components/schemas/NamespaceTool' shell: '#/components/schemas/FunctionShellTool' tool_search: '#/components/schemas/ToolSearchTool' web_search: '#/components/schemas/WebSearchTool' web_search_2025_08_26: '#/components/schemas/WebSearchTool' web_search_preview: '#/components/schemas/WebSearchPreviewTool' web_search_preview_2025_03_11: '#/components/schemas/WebSearchPreviewTool' type: array title: Tools description: The loaded tool definitions returned by tool search. type: type: string const: tool_search_output title: Type description: The type of the item. Always `tool_search_output`. call_id: anyOf: - type: string - type: 'null' title: Call Id description: The unique ID of the tool search call generated by the model. created_by: anyOf: - type: string - type: 'null' title: Created By description: The identifier of the actor that created the item. additionalProperties: false type: object required: - id - execution - status - tools - type title: ResponseToolSearchOutputItem description: A tool search output item. ResponseUsage: properties: input_tokens: type: integer title: Input Tokens description: Input token count. input_tokens_details: $ref: '#/components/schemas/InputTokensDetails' description: Input token details. output_tokens: type: integer title: Output Tokens description: Output token count. output_tokens_details: $ref: '#/components/schemas/OutputTokensDetails' description: Output token details. total_tokens: type: integer title: Total Tokens description: Total token count. additionalProperties: false type: object required: - input_tokens - input_tokens_details - output_tokens - output_tokens_details - total_tokens title: ResponseUsage description: Token usage details for a response, including input, output, and total counts. SearchResultBlockParam: properties: type: type: string const: search_result title: Type description: Content block type. Always `search_result`. content: items: $ref: '#/components/schemas/TextBlockParam' type: array title: Content description: The content of the search result. source: type: string title: Source description: The source URL of the search result. title: type: string title: Title description: Title of the search result. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control for this content block. citations: anyOf: - $ref: '#/components/schemas/CitationsConfigParam' - type: 'null' description: Citations configuration for the search result. type: object required: - type - content - source - title title: SearchResultBlockParam description: Search result content block parameter. ServerToolCaller: properties: tool_id: type: string title: Tool Id description: The tool identifier. type: type: string pattern: ^code_execution(?:_[0-9]{8})?$ title: Type description: Type discriminator. additionalProperties: false type: object required: - tool_id - type title: ServerToolCaller description: Tool invocation generated by a server-side tool. ServerToolUsage: properties: web_search_requests: type: integer title: Web Search Requests description: Web search requests. web_fetch_requests: type: integer title: Web Fetch Requests description: Web fetch requests. additionalProperties: false type: object required: - web_search_requests - web_fetch_requests title: ServerToolUsage description: Server tool usage. ServerToolUseBlock: properties: type: type: string const: server_tool_use title: Type description: Content block type. Always `server_tool_use`. id: type: string title: Id description: Unique identifier for this server tool use. name: type: string title: Name description: Name of the server tool being used. input: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object title: Input description: Tool input parameters as a JSON object. caller: anyOf: - $ref: '#/components/schemas/DirectCaller' - $ref: '#/components/schemas/ServerToolCaller' - type: 'null' title: Caller description: Caller. additionalProperties: false type: object required: - type - id - name - input title: ServerToolUseBlock description: Server-side tool use content block. ServerToolUseBlockParam: properties: type: type: string const: server_tool_use title: Type description: Content block type. Always `server_tool_use`. id: type: string title: Id description: Unique identifier for this server tool use. name: type: string title: Name description: Name of the server tool being used. input: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object title: Input description: Tool input parameters as a JSON object. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control for this content block. caller: anyOf: - $ref: '#/components/schemas/DirectCaller' - $ref: '#/components/schemas/ServerToolCaller' - type: 'null' title: Caller description: Caller. type: object required: - type - id - name - input title: ServerToolUseBlockParam description: Server-side tool use content block parameter. ShellCall: properties: action: $ref: '#/components/schemas/ShellCallAction' call_id: type: string title: Call Id description: The unique ID of the shell tool call generated by the model. type: type: string const: shell_call title: Type description: The type of the item. Always `shell_call`. id: anyOf: - type: string - type: 'null' title: Id description: The unique ID of the shell tool call. Populated when this item is returned via API. environment: anyOf: - oneOf: - $ref: '#/components/schemas/LocalEnvironment' - $ref: '#/components/schemas/ContainerReference' discriminator: propertyName: type mapping: container_reference: '#/components/schemas/ContainerReference' local: '#/components/schemas/LocalEnvironment' - type: 'null' title: Environment description: The environment to execute the shell commands in. status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status description: The status of the shell call. type: object required: - action - call_id - type title: ShellCall description: A tool representing a request to execute one or more shell commands. ShellCallAction: properties: commands: items: type: string type: array title: Commands description: Ordered shell commands for the execution environment to run. max_output_length: anyOf: - type: integer - type: 'null' title: Max Output Length description: Maximum number of UTF-8 characters to capture from combined stdout and stderr output. timeout_ms: anyOf: - type: integer - type: 'null' title: Timeout Ms description: Maximum wall-clock time in milliseconds to allow the shell commands to run. type: object required: - commands title: ShellCallAction description: The shell commands and limits that describe how to run the tool call. ShellCallOutcomeExit: properties: exit_code: type: integer title: Exit Code description: Shell exit code. type: type: string const: exit title: Type description: Exit outcome. type: object required: - exit_code - type title: ShellCallOutcomeExit description: Indicates that the shell commands finished and returned an exit code. ShellCallOutcomeTimeout: properties: type: type: string const: timeout title: Type description: Timeout outcome. type: object required: - type title: ShellCallOutcomeTimeout description: Indicates that the shell call exceeded its configured time limit. ShellCallOutput: properties: call_id: type: string title: Call Id description: The unique ID of the shell tool call generated by the model. output: items: $ref: '#/components/schemas/ShellCallOutputContent' type: array title: Output description: Captured chunks of stdout and stderr output, along with their associated outcomes. type: type: string const: shell_call_output title: Type description: The type of the item. Always `shell_call_output`. id: anyOf: - type: string - type: 'null' title: Id description: The unique ID of the shell tool call output. Populated when this item is returned via API. max_output_length: anyOf: - type: integer - type: 'null' title: Max Output Length description: The maximum number of UTF-8 characters captured for this shell call's combined output. status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status description: The status of the shell call output. type: object required: - call_id - output - type title: ShellCallOutput description: The streamed output items emitted by a shell tool call. ShellCallOutputContent: properties: outcome: oneOf: - $ref: '#/components/schemas/ShellCallOutcomeTimeout' - $ref: '#/components/schemas/ShellCallOutcomeExit' title: Outcome description: Exit or timeout outcome. discriminator: propertyName: type mapping: exit: '#/components/schemas/ShellCallOutcomeExit' timeout: '#/components/schemas/ShellCallOutcomeTimeout' stderr: type: string title: Stderr description: Captured stderr. stdout: type: string title: Stdout description: Captured stdout. type: object required: - outcome - stderr - stdout title: ShellCallOutputContent description: Captured stdout and stderr for a portion of a shell tool call output. ShellToolCallOutputContent: properties: outcome: oneOf: - $ref: '#/components/schemas/ShellToolCallOutputOutcomeTimeout' - $ref: '#/components/schemas/ShellToolCallOutputOutcomeExit' title: Outcome description: Represents either an exit outcome or a timeout outcome for a shell call output chunk. discriminator: propertyName: type mapping: exit: '#/components/schemas/ShellToolCallOutputOutcomeExit' timeout: '#/components/schemas/ShellToolCallOutputOutcomeTimeout' stderr: type: string title: Stderr description: The standard error output that was captured. stdout: type: string title: Stdout description: The standard output that was captured. created_by: anyOf: - type: string - type: 'null' title: Created By description: The identifier of the actor that created the item. additionalProperties: false type: object required: - outcome - stderr - stdout title: ShellToolCallOutputContent description: The content of a shell tool call output that was emitted. ShellToolCallOutputOutcomeExit: properties: exit_code: type: integer title: Exit Code description: Exit code from the shell process. type: type: string const: exit title: Type description: The outcome type. Always `exit`. additionalProperties: false type: object required: - exit_code - type title: ShellToolCallOutputOutcomeExit description: Indicates that the shell commands finished and returned an exit code. ShellToolCallOutputOutcomeTimeout: properties: type: type: string const: timeout title: Type description: Timeout outcome. additionalProperties: false type: object required: - type title: ShellToolCallOutputOutcomeTimeout description: Indicates that the shell call exceeded its configured time limit. SkillReference: properties: skill_id: type: string title: Skill Id description: The ID of the referenced skill. type: type: string const: skill_reference title: Type description: References a skill created with the /v1/skills endpoint. version: anyOf: - type: string - type: 'null' title: Version description: Optional skill version. Use a positive integer or 'latest'. Omit for default. type: object required: - skill_id - type title: SkillReference description: References a skill created with the /v1/skills endpoint. SpeechCreateParams: properties: input: type: string minLength: 1 title: Input description: Text to generate audio for. Amazon Polly models accept SSML documents. model: type: string title: Model description: 'TTS model. Available: `amazon.polly-standard`, `amazon.polly-neural`, `amazon.polly-long-form`, `amazon.polly-generative`.' default: amazon.polly-standard voice: type: string title: Voice description: Voice for audio generation. Supported voices vary by model and language. default: alloy instructions: anyOf: - type: string - type: 'null' title: Instructions description: Additional voice control instructions. Does not work with `amazon.polly-standard`, `amazon.polly-neural`, `amazon.polly-long-form`, or `amazon.polly-generative`. response_format: type: string enum: - mp3 - ogg - opus - aac - flac - wav - pcm title: Response Format description: 'Audio format: `mp3`, `opus`, `ogg`, `aac`, `flac`, `wav`, or `pcm`.' default: mp3 speed: type: number maximum: 2.0 minimum: 0.2 title: Speed description: 'Audio speed. Range: `0.2` to `2.0`. Default: `1.0`.' default: 1.0 stream_format: type: string enum: - audio - sse title: Stream Format description: 'Streaming format: `sse` or `audio`. MCP tools default to `sse` for better client compatibility.' default: audio additionalProperties: $ref: '#/components/schemas/JsonValue' type: object required: - input title: SpeechCreateParams description: Request model for text-to-speech generation. StreamOptions: properties: include_obfuscation: anyOf: - type: boolean - type: 'null' title: Include Obfuscation description: When true, stream obfuscation will be enabled. Adds random characters to normalize payload sizes as a mitigation to side-channel attacks. type: object title: StreamOptions description: 'Options for streaming responses. Only set this when you set `stream: true`.' TextBlock: properties: type: type: string const: text title: Type description: Content block type. text: type: string title: Text description: Text content. citations: anyOf: - items: oneOf: - $ref: '#/components/schemas/CitationCharLocation' - $ref: '#/components/schemas/CitationPageLocation' - $ref: '#/components/schemas/CitationContentBlockLocation' - $ref: '#/components/schemas/CitationsWebSearchResultLocation' - $ref: '#/components/schemas/CitationsSearchResultLocation' discriminator: propertyName: type mapping: char_location: '#/components/schemas/CitationCharLocation' content_block_location: '#/components/schemas/CitationContentBlockLocation' page_location: '#/components/schemas/CitationPageLocation' search_result_location: '#/components/schemas/CitationsSearchResultLocation' web_search_result_location: '#/components/schemas/CitationsWebSearchResultLocation' type: array - type: 'null' title: Citations description: Citations supporting the text block. additionalProperties: false type: object required: - type - text title: TextBlock description: Text content block. TextBlockParam: properties: type: type: string const: text title: Type description: Content block type. text: type: string title: Text description: Text content. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control for this content block. citations: anyOf: - items: anyOf: - $ref: '#/components/schemas/CitationCharLocationParam' - $ref: '#/components/schemas/CitationPageLocationParam' - $ref: '#/components/schemas/CitationContentBlockLocationParam' - $ref: '#/components/schemas/CitationWebSearchResultLocationParam' - $ref: '#/components/schemas/CitationSearchResultLocationParam' type: array - type: 'null' title: Citations description: 'Citations supporting the text block. Type depends on document: PDF uses `page_location`, plain text uses `char_location`, content documents use `content_block_location`.' type: object required: - type - text title: TextBlockParam description: Text content block parameter for system prompts and messages. TextEditorCodeExecutionCreateResultBlock: properties: is_file_update: type: boolean title: Is File Update description: Whether this result is a file update. type: type: string const: text_editor_code_execution_create_result title: Type description: Type discriminator. additionalProperties: false type: object required: - is_file_update - type title: TextEditorCodeExecutionCreateResultBlock description: Text editor code execution create result block. TextEditorCodeExecutionCreateResultBlockParam: properties: is_file_update: type: boolean title: Is File Update description: Whether this result is a file update. type: type: string const: text_editor_code_execution_create_result title: Type description: Type discriminator. type: object required: - is_file_update - type title: TextEditorCodeExecutionCreateResultBlockParam description: Text editor code execution create result block parameter. TextEditorCodeExecutionStrReplaceResultBlock: properties: lines: anyOf: - items: type: string type: array - type: 'null' title: Lines description: The lines of content. new_lines: anyOf: - type: integer - type: 'null' title: New Lines description: The number of lines in the new text. new_start: anyOf: - type: integer - type: 'null' title: New Start description: The starting line of the new text. old_lines: anyOf: - type: integer - type: 'null' title: Old Lines description: The number of lines in the original text. old_start: anyOf: - type: integer - type: 'null' title: Old Start description: The starting line of the original text. type: type: string const: text_editor_code_execution_str_replace_result title: Type description: Type discriminator. additionalProperties: false type: object required: - type title: TextEditorCodeExecutionStrReplaceResultBlock description: Text editor code execution str replace result block. TextEditorCodeExecutionStrReplaceResultBlockParam: properties: type: type: string const: text_editor_code_execution_str_replace_result title: Type description: Type discriminator. lines: anyOf: - items: type: string type: array - type: 'null' title: Lines description: The lines of content. new_lines: anyOf: - type: integer - type: 'null' title: New Lines description: The number of lines in the new text. new_start: anyOf: - type: integer - type: 'null' title: New Start description: The starting line of the new text. old_lines: anyOf: - type: integer - type: 'null' title: Old Lines description: The number of lines in the original text. old_start: anyOf: - type: integer - type: 'null' title: Old Start description: The starting line of the original text. type: object required: - type title: TextEditorCodeExecutionStrReplaceResultBlockParam description: Text editor code execution str replace result block parameter. TextEditorCodeExecutionToolResultBlock: properties: content: anyOf: - $ref: '#/components/schemas/TextEditorCodeExecutionToolResultError' - $ref: '#/components/schemas/TextEditorCodeExecutionViewResultBlock' - $ref: '#/components/schemas/TextEditorCodeExecutionCreateResultBlock' - $ref: '#/components/schemas/TextEditorCodeExecutionStrReplaceResultBlock' title: Content description: Block content. tool_use_id: type: string title: Tool Use Id description: Tool use ID. type: type: string const: text_editor_code_execution_tool_result title: Type description: Type discriminator. additionalProperties: false type: object required: - content - tool_use_id - type title: TextEditorCodeExecutionToolResultBlock description: Text editor code execution tool result block. TextEditorCodeExecutionToolResultBlockParam: properties: content: anyOf: - $ref: '#/components/schemas/TextEditorCodeExecutionToolResultErrorParam' - $ref: '#/components/schemas/TextEditorCodeExecutionViewResultBlockParam' - $ref: '#/components/schemas/TextEditorCodeExecutionCreateResultBlockParam' - $ref: '#/components/schemas/TextEditorCodeExecutionStrReplaceResultBlockParam' title: Content tool_use_id: type: string title: Tool Use Id description: Tool use ID. type: type: string const: text_editor_code_execution_tool_result title: Type description: Type discriminator. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. type: object required: - content - tool_use_id - type title: TextEditorCodeExecutionToolResultBlockParam description: Text editor code execution tool result block parameter. TextEditorCodeExecutionToolResultError: properties: error_code: type: string enum: - invalid_tool_input - unavailable - too_many_requests - execution_time_exceeded - file_not_found title: Error Code description: Error code. error_message: anyOf: - type: string - type: 'null' title: Error Message description: Error message. type: type: string const: text_editor_code_execution_tool_result_error title: Type description: Type discriminator. additionalProperties: false type: object required: - error_code - type title: TextEditorCodeExecutionToolResultError description: Text editor code execution tool result error. TextEditorCodeExecutionToolResultErrorParam: properties: error_code: type: string enum: - invalid_tool_input - unavailable - too_many_requests - execution_time_exceeded - file_not_found title: Error Code description: Error code. type: type: string const: text_editor_code_execution_tool_result_error title: Type description: Type discriminator. error_message: anyOf: - type: string - type: 'null' title: Error Message description: Error message. type: object required: - error_code - type title: TextEditorCodeExecutionToolResultErrorParam description: Text editor code execution tool result error parameter. TextEditorCodeExecutionViewResultBlock: properties: content: type: string title: Content description: Block content. file_type: type: string enum: - text - image - pdf title: File Type description: The type of file output. num_lines: anyOf: - type: integer - type: 'null' title: Num Lines description: The number of lines. start_line: anyOf: - type: integer - type: 'null' title: Start Line description: The starting line number. total_lines: anyOf: - type: integer - type: 'null' title: Total Lines description: Total number of lines in the file. type: type: string const: text_editor_code_execution_view_result title: Type description: Type discriminator. additionalProperties: false type: object required: - content - file_type - type title: TextEditorCodeExecutionViewResultBlock description: Text editor code execution view result block. TextEditorCodeExecutionViewResultBlockParam: properties: content: type: string title: Content description: Block content. file_type: type: string enum: - text - image - pdf title: File Type description: The type of file output. type: type: string const: text_editor_code_execution_view_result title: Type description: Type discriminator. num_lines: anyOf: - type: integer - type: 'null' title: Num Lines description: The number of lines. start_line: anyOf: - type: integer - type: 'null' title: Start Line description: The starting line number. total_lines: anyOf: - type: integer - type: 'null' title: Total Lines description: Total number of lines in the file. type: object required: - content - file_type - type title: TextEditorCodeExecutionViewResultBlockParam description: Text editor code execution view result block parameter. ThinkingBlock: properties: type: type: string const: thinking title: Type description: Content block type. Always `thinking`. thinking: type: string title: Thinking description: The thinking process content. signature: anyOf: - type: string - type: 'null' title: Signature description: Signature for the thinking block. additionalProperties: false type: object required: - type - thinking title: ThinkingBlock description: Thinking content block for extended thinking. ThinkingBlockParam: properties: type: type: string const: thinking title: Type description: Content block type. Always `thinking`. thinking: type: string title: Thinking description: The thinking process content. signature: anyOf: - type: string - type: 'null' title: Signature description: A token that verifies that the thinking text was generated by the model. type: object required: - type - thinking title: ThinkingBlockParam description: Thinking content block parameter. ThinkingConfigAdaptiveParam: properties: type: type: string const: adaptive title: Type description: Thinking config type. Always `adaptive`. type: object required: - type title: ThinkingConfigAdaptiveParam description: Adaptive thinking configuration. ThinkingConfigDisabledParam: properties: type: type: string const: disabled title: Type description: Thinking config type. Always `disabled`. type: object required: - type title: ThinkingConfigDisabledParam description: Disabled thinking configuration. ThinkingConfigEnabledParam: properties: type: type: string const: enabled title: Type description: Thinking config type. Always `enabled`. budget_tokens: type: integer title: Budget Tokens description: Determines how many tokens the model can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be less than `max_tokens`. type: object required: - type - budget_tokens title: ThinkingConfigEnabledParam description: Enabled thinking configuration. ToolBashParam: properties: type: type: string pattern: ^bash(?:_[0-9]{8})?$ title: Type description: Tool type. name: type: string const: bash title: Name description: Tool name used in tool_use blocks. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. allowed_callers: anyOf: - items: type: string pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$ type: array - type: 'null' title: Allowed Callers description: Allowed callers. defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: Defer loading tool until referenced by tool_search. input_examples: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Input Examples description: Example inputs. strict: anyOf: - type: boolean - type: 'null' title: Strict description: Enable strict schema validation type: object required: - type - name title: ToolBashParam description: Bash tool definition for command execution. ToolChoiceAllowed: properties: mode: type: string enum: - auto - required title: Mode description: '`auto` lets model pick tools. `required` forces tool call.' tools: items: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object type: array title: Tools description: Allowed tool definitions. type: type: string const: allowed_tools title: Type description: Allowed tools type. type: object required: - mode - tools - type title: ToolChoiceAllowed description: Constrains the tools available to the model to a pre-defined set. ToolChoiceAnyParam: properties: type: type: string const: any title: Type description: Tool choice type. Always `any`. disable_parallel_tool_use: anyOf: - type: boolean - type: 'null' title: Disable Parallel Tool Use description: Disable parallel tool use. type: object required: - type title: ToolChoiceAnyParam description: Any tool choice - model must use at least one tool. ToolChoiceApplyPatch: properties: type: type: string const: apply_patch title: Type description: Apply patch tool. type: object required: - type title: ToolChoiceApplyPatch description: Forces the model to call the apply_patch tool when executing a tool call. ToolChoiceAutoParam: properties: type: type: string const: auto title: Type description: Tool choice type. Always `auto`. disable_parallel_tool_use: anyOf: - type: boolean - type: 'null' title: Disable Parallel Tool Use description: Disable parallel tool use. type: object required: - type title: ToolChoiceAutoParam description: Auto tool choice - model decides whether to use tools. ToolChoiceCustom: properties: name: type: string title: Name description: Custom tool name to call. type: type: string const: custom title: Type description: Custom tool type. type: object required: - name - type title: ToolChoiceCustom description: Force the model to call a specific custom tool. ToolChoiceFunction: properties: name: type: string title: Name description: Function name to call. type: type: string const: function title: Type description: Function tool type. type: object required: - name - type title: ToolChoiceFunction description: Force the model to call a specific function. ToolChoiceMcp: properties: server_label: type: string title: Server Label description: MCP server label. type: type: string const: mcp title: Type description: MCP tool type. name: anyOf: - type: string - type: 'null' title: Name description: Tool name on the server. type: object required: - server_label - type title: ToolChoiceMcp description: Force the model to call a specific tool on a remote MCP server. ToolChoiceNoneParam: properties: type: type: string const: none title: Type description: Type discriminator. type: object required: - type title: ToolChoiceNoneParam description: The model will not be allowed to use tools. ToolChoiceShell: properties: type: type: string const: shell title: Type description: Shell tool. type: object required: - type title: ToolChoiceShell description: Forces the model to call the shell tool when a tool call is required. ToolChoiceToolParam: properties: type: type: string const: tool title: Type description: Tool choice type. Always `tool`. name: type: string title: Name description: Name of the tool to use. disable_parallel_tool_use: anyOf: - type: boolean - type: 'null' title: Disable Parallel Tool Use description: Disable parallel tool use. type: object required: - type - name title: ToolChoiceToolParam description: Specific tool choice - model must use the specified tool. ToolChoiceTypes: properties: type: type: string enum: - file_search - web_search_preview - computer - computer_use_preview - computer_use - web_search_preview_2025_03_11 - image_generation - code_interpreter title: Type description: Built-in tool type to use. type: object required: - type title: ToolChoiceTypes description: Indicates that the model should use a built-in tool to generate a response. ToolComputerParam: properties: type: type: string pattern: ^computer(?:_[0-9]{8})?$ title: Type description: Tool type. Always ``computer_*``. name: type: string const: computer title: Name description: Name of the tool. This is how the tool will be called by the model and in ``tool_use`` blocks. display_width_px: type: integer title: Display Width Px description: The width of the display in pixels. display_height_px: type: integer title: Display Height Px description: The height of the display in pixels. display_number: anyOf: - type: integer - type: 'null' title: Display Number description: The X11 display number (e.g. 0, 1) for the display. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. allowed_callers: anyOf: - items: type: string pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$ type: array - type: 'null' title: Allowed Callers description: Allowed callers. defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: Defer loading tool until referenced by tool_search. enable_zoom: anyOf: - type: boolean - type: 'null' title: Enable Zoom description: Whether to enable an action to take a zoomed-in screenshot of the screen. Added in ``computer_20251124``. input_examples: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Input Examples description: Example inputs. strict: anyOf: - type: boolean - type: 'null' title: Strict description: Enable strict schema validation type: object required: - type - name - display_width_px - display_height_px title: ToolComputerParam description: Computer use tool definition for GUI automation. ToolInputSchema: properties: type: type: string const: object title: Type description: Schema type. default: object properties: anyOf: - additionalProperties: $ref: '#/components/schemas/JsonValue' type: object - type: 'null' title: Properties description: Schema properties. required: anyOf: - items: type: string type: array - type: 'null' title: Required description: Required properties. type: object title: ToolInputSchema description: JSON schema for tool input parameters. ToolParam: properties: type: type: string const: custom title: Type description: Tool type. default: custom name: type: string title: Name description: Name of the tool, used to call it in `tool_use` blocks. input_schema: $ref: '#/components/schemas/ToolInputSchema' description: JSON schema for the shape of the `input` this tool accepts and that the model will produce. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. description: anyOf: - type: string - type: 'null' title: Description description: Description of what this tool does. More detail helps the model use it correctly. eager_input_streaming: anyOf: - type: boolean - type: 'null' title: Eager Input Streaming description: Stream tool input parameters incrementally as they are generated instead of buffering the full JSON output. When null (default), behavior follows the fine-grained-tool-streaming beta header. strict: anyOf: - type: boolean - type: 'null' title: Strict description: Enable strict schema validation. allowed_callers: anyOf: - items: type: string pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$ type: array - type: 'null' title: Allowed Callers description: Allowed callers. defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: Defer loading tool until referenced by tool_search. input_examples: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Input Examples description: Example inputs. type: object required: - name - input_schema title: ToolParam description: Tool definition for function calling. ToolReferenceBlock: properties: tool_name: type: string title: Tool Name description: Tool name. type: type: string const: tool_reference title: Type description: Type discriminator. additionalProperties: false type: object required: - tool_name - type title: ToolReferenceBlock description: Tool reference block. ToolReferenceBlockParam: properties: tool_name: type: string title: Tool Name description: Tool name. type: type: string const: tool_reference title: Type description: Type discriminator. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. type: object required: - tool_name - type title: ToolReferenceBlockParam description: Tool reference block that can be included in tool_result content. ToolResultBlockParam: properties: type: type: string const: tool_result title: Type description: Content block type. Always `tool_result`. tool_use_id: type: string title: Tool Use Id description: ID of the tool use this result corresponds to. content: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/TextBlockParam' - $ref: '#/components/schemas/ImageBlockParam' type: array title: Content description: Tool result content. is_error: anyOf: - type: boolean - type: 'null' title: Is Error description: Whether this is an error result. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control for this content block. type: object required: - type - tool_use_id - content title: ToolResultBlockParam description: Tool result content block parameter. ToolSearchCallInput: properties: arguments: title: Arguments description: The arguments supplied to the tool search call. type: type: string const: tool_search_call title: Type description: The item type. Always `tool_search_call`. id: anyOf: - type: string - type: 'null' title: Id description: The unique ID of this tool search call. call_id: anyOf: - type: string - type: 'null' title: Call Id description: The unique ID of the tool search call generated by the model. execution: anyOf: - type: string enum: - server - client - type: 'null' title: Execution description: Whether tool search was executed by the server or by the client. status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status description: The status of the tool search call. type: object required: - arguments - type title: ToolSearchCallInput description: A tool search call input item. ToolSearchTool: properties: type: type: string const: tool_search title: Type description: Tool search type. description: anyOf: - type: string - type: 'null' title: Description description: Description for client-executed tool search. execution: anyOf: - type: string enum: - server - client - type: 'null' title: Execution description: Execute tool search on server or client. parameters: anyOf: - {} - type: 'null' title: Parameters description: Parameter schema for client-executed tool search. type: object required: - type title: ToolSearchTool description: 'Hosted or BYOT tool search configuration for deferred tools. UNSUPPORTED on this implementation.' ToolSearchToolBm25Param: properties: name: type: string const: tool_search_tool_bm25 title: Name description: Tool name. type: type: string pattern: ^tool_search_tool_bm25(?:_[0-9]{8})?$ title: Type description: Type discriminator. allowed_callers: anyOf: - items: type: string pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$ type: array - type: 'null' title: Allowed Callers description: Allowed callers. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: Defer loading tool until referenced by tool_search. strict: anyOf: - type: boolean - type: 'null' title: Strict description: Enable strict schema validation type: object required: - name - type title: ToolSearchToolBm25Param description: Tool search tool BM25 parameter. ToolSearchToolRegexParam: properties: name: type: string const: tool_search_tool_regex title: Name description: Tool name. type: type: string pattern: ^tool_search_tool_regex(?:_[0-9]{8})?$ title: Type description: Type discriminator. allowed_callers: anyOf: - items: type: string pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$ type: array - type: 'null' title: Allowed Callers description: Allowed callers. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: Defer loading tool until referenced by tool_search. strict: anyOf: - type: boolean - type: 'null' title: Strict description: Enable strict schema validation type: object required: - name - type title: ToolSearchToolRegexParam description: Tool search tool regex parameter. ToolSearchToolResultBlock: properties: content: anyOf: - $ref: '#/components/schemas/ToolSearchToolResultError' - $ref: '#/components/schemas/ToolSearchToolSearchResultBlock' title: Content description: Block content. tool_use_id: type: string title: Tool Use Id description: Tool use ID. type: type: string const: tool_search_tool_result title: Type description: Type discriminator. additionalProperties: false type: object required: - content - tool_use_id - type title: ToolSearchToolResultBlock description: Tool search tool result block. ToolSearchToolResultBlockParam: properties: content: anyOf: - $ref: '#/components/schemas/ToolSearchToolResultErrorParam' - $ref: '#/components/schemas/ToolSearchToolSearchResultBlockParam' title: Content tool_use_id: type: string title: Tool Use Id description: Tool use ID. type: type: string const: tool_search_tool_result title: Type description: Type discriminator. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. type: object required: - content - tool_use_id - type title: ToolSearchToolResultBlockParam description: Tool search tool result block parameter. ToolSearchToolResultError: properties: error_code: $ref: '#/components/schemas/ToolSearchToolResultErrorCode' description: Error code. error_message: anyOf: - type: string - type: 'null' title: Error Message description: Error message. type: type: string const: tool_search_tool_result_error title: Type description: Type discriminator. additionalProperties: false type: object required: - error_code - type title: ToolSearchToolResultError description: Tool search tool result error. ToolSearchToolResultErrorCode: type: string enum: - invalid_tool_input - unavailable - too_many_requests - execution_time_exceeded ToolSearchToolResultErrorParam: properties: error_code: $ref: '#/components/schemas/ToolSearchToolResultErrorCode' description: Error code. type: type: string const: tool_search_tool_result_error title: Type description: Type discriminator. type: object required: - error_code - type title: ToolSearchToolResultErrorParam description: Tool search tool result error parameter. ToolSearchToolSearchResultBlock: properties: tool_references: items: $ref: '#/components/schemas/ToolReferenceBlock' type: array title: Tool References description: Tool references. type: type: string const: tool_search_tool_search_result title: Type description: Type discriminator. additionalProperties: false type: object required: - tool_references - type title: ToolSearchToolSearchResultBlock description: Tool search tool search result block. ToolSearchToolSearchResultBlockParam: properties: tool_references: items: $ref: '#/components/schemas/ToolReferenceBlockParam' type: array title: Tool References description: Tool references. type: type: string const: tool_search_tool_search_result title: Type description: Type discriminator. type: object required: - tool_references - type title: ToolSearchToolSearchResultBlockParam description: Tool search tool search result block parameter. ToolTextEditorParam: properties: type: type: string pattern: ^text_editor(?:_[0-9]{8})?$ title: Type description: Tool type. name: type: string enum: - str_replace_editor - str_replace_based_edit_tool title: Name description: Tool name used in tool_use blocks. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. allowed_callers: anyOf: - items: type: string pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$ type: array - type: 'null' title: Allowed Callers description: Allowed callers. defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: Defer loading tool until referenced by tool_search. input_examples: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Input Examples description: Example inputs. strict: anyOf: - type: boolean - type: 'null' title: Strict description: Enable strict schema validation max_characters: anyOf: - type: integer - type: 'null' title: Max Characters description: Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. type: object required: - type - name title: ToolTextEditorParam description: Text editor tool definition for file editing. ToolUseBlock: properties: type: type: string const: tool_use title: Type description: Content block type. Always `tool_use`. id: type: string title: Id description: Unique identifier for this tool use. name: type: string title: Name description: Name of the tool being used. input: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object title: Input description: Tool input parameters as a JSON object. caller: anyOf: - $ref: '#/components/schemas/DirectCaller' - $ref: '#/components/schemas/ServerToolCaller' - type: 'null' title: Caller description: Caller. additionalProperties: false type: object required: - type - id - name - input title: ToolUseBlock description: Tool use content block. ToolUseBlockParam: properties: type: type: string const: tool_use title: Type description: Content block type. Always `tool_use`. id: type: string title: Id description: Unique identifier for this tool use. name: type: string title: Name description: Name of the tool being used. input: additionalProperties: $ref: '#/components/schemas/JsonValue' type: object title: Input description: Tool input parameters as a JSON object. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control for this content block. caller: anyOf: - $ref: '#/components/schemas/DirectCaller' - $ref: '#/components/schemas/ServerToolCaller' - type: 'null' title: Caller description: Caller. type: object required: - type - id - name - input title: ToolUseBlockParam description: Tool use content block parameter. TopLogprob: properties: token: type: string title: Token description: The token. bytes: anyOf: - items: type: integer type: array - type: 'null' title: Bytes description: UTF-8 byte representation of the token. Can be null if unavailable. logprob: type: number title: Logprob description: Log probability if in top 20 tokens, otherwise -9999.0. additionalProperties: false type: object required: - token - logprob title: TopLogprob description: Top log probability token information. URLImageSource: properties: type: type: string const: url title: Type description: Image source type. url: type: string minLength: 1 title: Url description: URL of the image, data URI, S3 URI, or base64 encoded string. type: object required: - type - url title: URLImageSource description: URL image source for image content block. URLPDFSource: properties: type: type: string const: url title: Type description: Document source type. url: type: string minLength: 1 title: Url description: URL of the PDF document, data URI, S3 URI, or base64 encoded string. type: object required: - type - url title: URLPDFSource description: URL PDF source for document content block. Upload: properties: id: type: string pattern: ^upload_[a-z2-7]{32}$ title: Id description: The Upload unique identifier. object: type: string const: upload title: Object description: The object type, which is always 'upload'. default: upload bytes: type: integer title: Bytes description: The intended number of bytes to be uploaded. created_at: type: integer title: Created At description: The Unix timestamp (in seconds) for when the Upload was created. expires_at: type: integer title: Expires At description: The Unix timestamp (in seconds) for when the Upload will expire. filename: type: string title: Filename description: The name of the file to be uploaded. purpose: type: string enum: - assistants - batch - fine-tune - vision - user_data - evals title: Purpose description: The intended purpose of the file. status: type: string enum: - pending - completed - cancelled - expired title: Status description: The status of the Upload. file: anyOf: - $ref: '#/components/schemas/FileObject' - type: 'null' description: The ready File object after the Upload is completed. additionalProperties: false type: object required: - id - bytes - created_at - expires_at - filename - purpose - status title: Upload description: The Upload object can accept byte chunks in the form of Parts. UploadPart: properties: id: type: string pattern: ^part_[0-9a-f]{32}$ title: Id description: The upload Part unique identifier. object: type: string const: upload.part title: Object description: The object type, which is always `upload.part`. default: upload.part created_at: type: integer title: Created At description: The Unix timestamp (in seconds) for when the Part was created. upload_id: type: string pattern: ^upload_[a-z2-7]{32}$ title: Upload Id description: The ID of the Upload object that this Part was added to. additionalProperties: false type: object required: - id - created_at - upload_id title: UploadPart description: A part of a multipart upload. UsageInputTokensDetails: properties: image_tokens: type: integer minimum: 0.0 title: Image Tokens description: The number of image tokens in the input prompt. default: 0 text_tokens: type: integer minimum: 0.0 title: Text Tokens description: The number of text tokens in the input prompt. default: 0 additionalProperties: false type: object title: UsageInputTokensDetails description: Detailed input token usage for image generation. UserLocationParam: properties: type: type: string const: approximate title: Type description: Type discriminator. city: anyOf: - type: string - type: 'null' title: City description: User city. country: anyOf: - type: string - type: 'null' title: Country description: Two-letter ISO country code of the user. region: anyOf: - type: string - type: 'null' title: Region description: User region. timezone: anyOf: - type: string - type: 'null' title: Timezone description: IANA timezone of the user. type: object required: - type title: UserLocationParam description: User location parameter. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError WebFetchBlock: properties: content: $ref: '#/components/schemas/DocumentBlock' description: Block content. retrieved_at: anyOf: - type: string - type: 'null' title: Retrieved At description: ISO 8601 timestamp when the content was retrieved type: type: string const: web_fetch_result title: Type description: Type discriminator. url: type: string title: Url description: Fetched content URL additionalProperties: false type: object required: - content - type - url title: WebFetchBlock description: Web fetch block. WebFetchBlockParam: properties: content: $ref: '#/components/schemas/DocumentBlockParam' description: Block content. type: type: string const: web_fetch_result title: Type description: Type discriminator. url: type: string title: Url description: Fetched content URL retrieved_at: anyOf: - type: string - type: 'null' title: Retrieved At description: ISO 8601 timestamp when the content was retrieved type: object required: - content - type - url title: WebFetchBlockParam description: Web fetch block parameter. WebFetchToolParam: properties: name: type: string const: web_fetch title: Name description: Tool name. type: type: string pattern: ^web_fetch(?:_[0-9]{8})?$ title: Type description: Type discriminator. allowed_callers: anyOf: - items: type: string pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$ type: array - type: 'null' title: Allowed Callers description: Allowed callers. allowed_domains: anyOf: - items: type: string type: array - type: 'null' title: Allowed Domains description: List of domains to allow fetching from blocked_domains: anyOf: - items: type: string type: array - type: 'null' title: Blocked Domains description: List of domains to block fetching from cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. citations: anyOf: - $ref: '#/components/schemas/CitationsConfigParam' - type: 'null' description: Citations configuration for fetched documents. Citations are disabled by default. defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: Defer loading tool until referenced by tool_search. max_content_tokens: anyOf: - type: integer - type: 'null' title: Max Content Tokens description: Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. max_uses: anyOf: - type: integer - type: 'null' title: Max Uses description: Maximum number of times the tool can be used in the API request. strict: anyOf: - type: boolean - type: 'null' title: Strict description: Enable strict schema validation type: object required: - name - type title: WebFetchToolParam description: Web fetch tool parameter. WebFetchToolResultBlock: properties: caller: anyOf: - $ref: '#/components/schemas/DirectCaller' - $ref: '#/components/schemas/ServerToolCaller' - type: 'null' title: Caller description: Caller. content: anyOf: - $ref: '#/components/schemas/WebFetchToolResultErrorBlock' - $ref: '#/components/schemas/WebFetchBlock' title: Content description: Block content. tool_use_id: type: string title: Tool Use Id description: Tool use ID. type: type: string const: web_fetch_tool_result title: Type description: Type discriminator. additionalProperties: false type: object required: - content - tool_use_id - type title: WebFetchToolResultBlock description: Web fetch tool result block. WebFetchToolResultBlockParam: properties: content: anyOf: - $ref: '#/components/schemas/WebFetchToolResultErrorBlockParam' - $ref: '#/components/schemas/WebFetchBlockParam' title: Content description: Block content. tool_use_id: type: string title: Tool Use Id description: Tool use ID. type: type: string const: web_fetch_tool_result title: Type description: Type discriminator. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. caller: anyOf: - $ref: '#/components/schemas/DirectCaller' - $ref: '#/components/schemas/ServerToolCaller' - type: 'null' title: Caller description: Caller. type: object required: - content - tool_use_id - type title: WebFetchToolResultBlockParam description: Web fetch tool result block parameter. WebFetchToolResultErrorBlock: properties: error_code: type: string enum: - invalid_tool_input - url_too_long - url_not_allowed - url_not_accessible - unsupported_content_type - too_many_requests - max_uses_exceeded - unavailable title: Error Code description: Error code. type: type: string const: web_fetch_tool_result_error title: Type description: Type discriminator. additionalProperties: false type: object required: - error_code - type title: WebFetchToolResultErrorBlock description: Web fetch tool result error block. WebFetchToolResultErrorBlockParam: properties: error_code: type: string enum: - invalid_tool_input - url_too_long - url_not_allowed - url_not_accessible - unsupported_content_type - too_many_requests - max_uses_exceeded - unavailable title: Error Code description: Error code. type: type: string const: web_fetch_tool_result_error title: Type description: Type discriminator. type: object required: - error_code - type title: WebFetchToolResultErrorBlockParam description: Web fetch tool result error block parameter. WebSearchActionFind: properties: pattern: type: string title: Pattern description: Pattern to find in page. type: type: string const: find_in_page title: Type description: Find in page action type. url: type: string title: Url description: Page URL searched. additionalProperties: false type: object required: - pattern - type - url title: WebSearchActionFind description: Web search action of type `find_in_page`. WebSearchActionOpenPage: properties: type: type: string const: open_page title: Type description: Open page action type. url: anyOf: - type: string - type: 'null' title: Url description: Opened URL. additionalProperties: false type: object required: - type title: WebSearchActionOpenPage description: Web search action of type `open_page`. WebSearchActionSearch: properties: query: type: string title: Query description: '[DEPRECATED] Search query.' type: type: string const: search title: Type description: Search action type. queries: anyOf: - items: type: string type: array - type: 'null' title: Queries description: Search queries. sources: anyOf: - items: $ref: '#/components/schemas/WebSearchActionSource' type: array - type: 'null' title: Sources description: Search sources. additionalProperties: false type: object required: - query - type title: WebSearchActionSearch description: Web search action of type `search`. WebSearchActionSource: properties: type: type: string const: url title: Type description: URL source type. url: type: string title: Url description: Source URL. additionalProperties: false type: object required: - type - url title: WebSearchActionSource description: A source used in the search. WebSearchFilters: properties: allowed_domains: anyOf: - items: type: string type: array - type: 'null' title: Allowed Domains description: Allowed domains for the search. type: object title: WebSearchFilters description: Filters for web search. WebSearchOptions: properties: search_context_size: type: string enum: - low - medium - high title: Search Context Size description: 'Search context size: `low`, `medium`, or `high`. Default: `medium`. UNSUPPORTED on this implementation.' default: medium user_location: anyOf: - $ref: '#/components/schemas/WebSearchOptionsUserLocation' - type: 'null' description: Approximate location parameters. UNSUPPORTED on this implementation. additionalProperties: false type: object title: WebSearchOptions description: 'Web search tool options. UNSUPPORTED on this implementation.' WebSearchOptionsUserLocation: properties: type: type: string const: approximate title: Type description: Location type. Always `approximate`. UNSUPPORTED on this implementation. approximate: $ref: '#/components/schemas/WebSearchOptionsUserLocationApproximate' description: Approximate location parameters. UNSUPPORTED on this implementation. additionalProperties: false type: object required: - type - approximate title: WebSearchOptionsUserLocation description: 'User location parameters for web search (approximate). UNSUPPORTED on this implementation.' WebSearchOptionsUserLocationApproximate: properties: city: anyOf: - type: string - type: 'null' title: City description: User city, e.g., `San Francisco`. UNSUPPORTED on this implementation. country: anyOf: - type: string - type: 'null' title: Country description: Two-letter ISO country code, e.g., `US`. UNSUPPORTED on this implementation. region: anyOf: - type: string - type: 'null' title: Region description: User region, e.g., `California`. UNSUPPORTED on this implementation. timezone: anyOf: - type: string - type: 'null' title: Timezone description: IANA timezone, e.g., `America/Los_Angeles`. UNSUPPORTED on this implementation. additionalProperties: false type: object title: WebSearchOptionsUserLocationApproximate description: 'Approximate user location for web search. UNSUPPORTED on this implementation.' WebSearchPreviewTool: properties: type: type: string enum: - web_search_preview - web_search_preview_2025_03_11 title: Type description: Web search preview tool type. search_content_types: anyOf: - items: type: string enum: - text - image type: array - type: 'null' title: Search Content Types description: Content types to include in search results. search_context_size: anyOf: - type: string enum: - low - medium - high - type: 'null' title: Search Context Size description: 'Context window size: `low`, `medium`, or `high`. Default: `medium`.' user_location: anyOf: - $ref: '#/components/schemas/WebSearchPreviewUserLocation' - type: 'null' description: User's location. external_web_access: anyOf: - type: boolean - type: 'null' title: External Web Access description: Allow external web access. type: object required: - type title: WebSearchPreviewTool description: This tool searches the web for relevant results to use in a response. WebSearchPreviewUserLocation: properties: type: type: string const: approximate title: Type description: Approximate location type. city: anyOf: - type: string - type: 'null' title: City description: User's city. country: anyOf: - type: string - type: 'null' title: Country description: User's ISO country code. region: anyOf: - type: string - type: 'null' title: Region description: User's region. timezone: anyOf: - type: string - type: 'null' title: Timezone description: User's IANA timezone. type: object required: - type title: WebSearchPreviewUserLocation description: The user's location for web search preview. WebSearchResultBlock: properties: type: type: string const: web_search_result title: Type description: Result type. Always `web_search_result`. encrypted_content: anyOf: - type: string - type: 'null' title: Encrypted Content description: Encrypted web page content. title: type: string title: Title description: Title of the web page. url: type: string title: Url description: URL of the web page. page_age: anyOf: - type: string - type: 'null' title: Page Age description: Age of the page (e.g., '2 days ago'). additionalProperties: false type: object required: - type - title - url title: WebSearchResultBlock description: Individual web search result. WebSearchResultBlockParam: properties: encrypted_content: type: string title: Encrypted Content description: Encrypted web page content. title: type: string title: Title description: The title. type: type: string const: web_search_result title: Type description: Type discriminator. url: type: string title: Url description: The URL. page_age: anyOf: - type: string - type: 'null' title: Page Age description: How long ago the page was published or updated. type: object required: - encrypted_content - title - type - url title: WebSearchResultBlockParam description: Web search result block parameter. WebSearchTool: properties: type: type: string enum: - web_search - web_search_2025_08_26 title: Type description: Web search tool type. filters: anyOf: - $ref: '#/components/schemas/WebSearchFilters' - type: 'null' description: Search filters. search_context_size: anyOf: - type: string enum: - low - medium - high - type: 'null' title: Search Context Size description: 'Context window size: `low`, `medium`, or `high`. Default: `medium`.' user_location: anyOf: - $ref: '#/components/schemas/WebSearchUserLocation' - type: 'null' description: User's approximate location. external_web_access: anyOf: - type: boolean - type: 'null' title: External Web Access description: Allow external web access. type: object required: - type title: WebSearchTool description: Search the web for sources related to the prompt. WebSearchToolParam: properties: type: type: string pattern: ^web_search(?:_[0-9]{8})?$ title: Type description: Tool type. name: type: string const: web_search title: Name description: Name of the tool, used to call it in `tool_use` blocks. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. allowed_callers: anyOf: - items: type: string pattern: ^(?:direct|code_execution(?:_[0-9]{8})?)$ type: array - type: 'null' title: Allowed Callers description: Allowed callers. allowed_domains: anyOf: - items: type: string type: array - type: 'null' title: Allowed Domains description: If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. blocked_domains: anyOf: - items: type: string type: array - type: 'null' title: Blocked Domains description: If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: Defer loading tool until referenced by tool_search. max_uses: anyOf: - type: integer - type: 'null' title: Max Uses description: Maximum number of times the tool can be used in the API request. strict: anyOf: - type: boolean - type: 'null' title: Strict description: Enable strict schema validation user_location: anyOf: - $ref: '#/components/schemas/UserLocationParam' - type: 'null' description: Parameters for the user's location. Used to provide more relevant search results. type: object required: - type - name title: WebSearchToolParam description: 'Web search tool definition. Supported on models that declare web search as a system tool (e.g., Amazon Nova 2 via ``nova_grounding``).' WebSearchToolRequestErrorParam: properties: error_code: type: string enum: - invalid_tool_input - unavailable - max_uses_exceeded - too_many_requests - query_too_long - request_too_large title: Error Code description: Error code. type: type: string const: web_search_tool_result_error title: Type description: Type discriminator. type: object required: - error_code - type title: WebSearchToolRequestErrorParam description: Web search tool request error parameter. WebSearchToolResultBlock: properties: type: type: string const: web_search_tool_result title: Type description: Content block type. Always `web_search_tool_result`. tool_use_id: type: string title: Tool Use Id description: ID of the tool use this result corresponds to. content: anyOf: - $ref: '#/components/schemas/WebSearchToolResultError' - items: $ref: '#/components/schemas/WebSearchResultBlock' type: array title: Content description: Search results or error. caller: anyOf: - $ref: '#/components/schemas/DirectCaller' - $ref: '#/components/schemas/ServerToolCaller' - type: 'null' title: Caller description: Caller. additionalProperties: false type: object required: - type - tool_use_id - content title: WebSearchToolResultBlock description: Web search tool result content block. WebSearchToolResultBlockParam: properties: content: anyOf: - items: $ref: '#/components/schemas/WebSearchResultBlockParam' type: array - $ref: '#/components/schemas/WebSearchToolRequestErrorParam' title: Content description: Block content. tool_use_id: type: string title: Tool Use Id description: Tool use ID. type: type: string const: web_search_tool_result title: Type description: Type discriminator. cache_control: anyOf: - $ref: '#/components/schemas/CacheControlEphemeralParam' - type: 'null' description: Cache control breakpoint. caller: anyOf: - $ref: '#/components/schemas/DirectCaller' - $ref: '#/components/schemas/ServerToolCaller' - type: 'null' title: Caller description: Caller. type: object required: - content - tool_use_id - type title: WebSearchToolResultBlockParam description: Web search tool result block parameter. WebSearchToolResultError: properties: error_code: type: string title: Error Code description: Error code. type: type: string const: error title: Type description: Result type. Always `error`. additionalProperties: false type: object required: - error_code - type title: WebSearchToolResultError description: Web search tool result error. WebSearchUserLocation: properties: city: anyOf: - type: string - type: 'null' title: City description: User's city. country: anyOf: - type: string - type: 'null' title: Country description: User's ISO country code. region: anyOf: - type: string - type: 'null' title: Region description: User's region. timezone: anyOf: - type: string - type: 'null' title: Timezone description: User's IANA timezone. type: anyOf: - type: string const: approximate - type: 'null' title: Type description: Approximate location type. type: object title: WebSearchUserLocation description: The approximate location of the user. stdapi__types__anthropic_messages__Usage: properties: input_tokens: type: integer title: Input Tokens description: Input tokens. output_tokens: type: integer title: Output Tokens description: Output tokens. cache_creation_input_tokens: anyOf: - type: integer - type: 'null' title: Cache Creation Input Tokens description: Cache creation input tokens. cache_read_input_tokens: anyOf: - type: integer - type: 'null' title: Cache Read Input Tokens description: Cache read input tokens. cache_creation: anyOf: - $ref: '#/components/schemas/CacheCreation' - type: 'null' description: Cache creation details. inference_geo: anyOf: - type: string - type: 'null' title: Inference Geo description: Inference geographic region. server_tool_use: anyOf: - $ref: '#/components/schemas/ServerToolUsage' - type: 'null' description: Server tool usage. service_tier: anyOf: - type: string enum: - standard - priority - batch - type: 'null' title: Service Tier description: The service tier used for the request. additionalProperties: false type: object required: - input_tokens - output_tokens title: Usage description: Token usage information. stdapi__types__openai_chat_completions__AnnotationURLCitation: properties: end_index: type: integer minimum: 0.0 title: End Index description: Last character index of the URL citation in the message. start_index: type: integer minimum: 0.0 title: Start Index description: First character index of the URL citation in the message. title: type: string title: Title description: Title of the web resource. url: type: string title: Url description: URL of the web resource. additionalProperties: false type: object required: - end_index - start_index - title - url title: AnnotationURLCitation description: A URL citation when using web search. stdapi__types__openai_chat_completions__CompletionCreateParams: properties: messages: items: oneOf: - $ref: '#/components/schemas/ChatCompletionDeveloperMessageParam' - $ref: '#/components/schemas/ChatCompletionSystemMessageParam' - $ref: '#/components/schemas/ChatCompletionUserMessageParam' - $ref: '#/components/schemas/ChatCompletionAssistantMessageParam' - $ref: '#/components/schemas/ChatCompletionToolMessageParam' - $ref: '#/components/schemas/ChatCompletionFunctionMessageParam' discriminator: propertyName: role mapping: assistant: '#/components/schemas/ChatCompletionAssistantMessageParam' developer: '#/components/schemas/ChatCompletionDeveloperMessageParam' function: '#/components/schemas/ChatCompletionFunctionMessageParam' system: '#/components/schemas/ChatCompletionSystemMessageParam' tool: '#/components/schemas/ChatCompletionToolMessageParam' user: '#/components/schemas/ChatCompletionUserMessageParam' type: array minItems: 1 title: Messages description: List of messages comprising the conversation. Supports text, document, video, image, and audio depending on the model. model: type: string minLength: 1 title: Model description: Model ID to generate the response audio: anyOf: - $ref: '#/components/schemas/ChatCompletionAudioParam' - type: 'null' description: Audio output parameters. Required when `modalities=['audio']`. frequency_penalty: anyOf: - type: number - type: 'null' title: Frequency Penalty description: Penalize token repetition based on frequency. Only supported on some models. function_call: anyOf: - type: string enum: - none - auto - $ref: '#/components/schemas/FunctionToolChoiceParam' - type: 'null' title: Function Call description: Deprecated. Use `tool_choice` instead. Controls which function is called. deprecated: true functions: anyOf: - items: $ref: '#/components/schemas/LegacyFunction' type: array - type: 'null' title: Functions description: Deprecated. Use `tools` instead. List of functions the model can call. deprecated: true logit_bias: anyOf: - additionalProperties: type: integer type: object - type: 'null' title: Logit Bias description: Token likelihood modification via token ID to bias mapping. Only supported on some models. logprobs: anyOf: - type: boolean - type: 'null' title: Logprobs description: Return log probabilities of output tokens. UNSUPPORTED on this implementation. default: false max_completion_tokens: anyOf: - type: integer minimum: 1.0 - type: 'null' title: Max Completion Tokens description: Upper bound for tokens in completion, including reasoning tokens. max_tokens: anyOf: - type: integer minimum: 1.0 - type: 'null' title: Max Tokens description: Deprecated. Use `max_completion_tokens` instead. deprecated: true metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Metadata description: Key-value pairs for filtering invocation logs. modalities: anyOf: - items: type: string enum: - text - audio type: array - type: 'null' title: Modalities description: 'Output types to generate. Default: `[''text'']`. Audio is synthesized from text for text-only models.' n: anyOf: - type: integer maximum: 128.0 minimum: 1.0 - type: 'null' title: N description: Number of completion choices to generate. n>1 with streaming is UNSUPPORTED. default: 1 parallel_tool_calls: anyOf: - type: boolean - type: 'null' title: Parallel Tool Calls description: Enable parallel function calling. UNSUPPORTED on this implementation. default: true prediction: anyOf: - $ref: '#/components/schemas/ChatCompletionPredictionContentParam' - type: 'null' description: Static predicted output content. UNSUPPORTED on this implementation. presence_penalty: anyOf: - type: number - type: 'null' title: Presence Penalty description: Penalize new tokens based on prior appearance. Only supported on some models. prompt_cache_key: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Prompt Cache Key description: Cache key for similar requests. Use dot-separated 'system', 'messages', 'tools' for section-specific caching. Custom hash keys are UNSUPPORTED. prompt_cache_retention: anyOf: - type: string enum: - in-memory - 24h - 1h - 5m - type: 'null' title: Prompt Cache Retention description: 'Cache retention: `in-memory` -> 5m, `24h` -> 1h (AWS Bedrock mapping).' reasoning_effort: anyOf: - type: string enum: - none - minimal - low - medium - high - xhigh - type: 'null' title: Reasoning Effort description: 'Reasoning effort: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`. Calculated as fraction of `max_completion_tokens`: minimal=0.25x, low=0.5x, medium=0.75x, high=xhigh=max.' response_format: anyOf: - oneOf: - $ref: '#/components/schemas/ResponseFormatText' - $ref: '#/components/schemas/ResponseFormatJSONSchema' - $ref: '#/components/schemas/ResponseFormatJSONObject' discriminator: propertyName: type mapping: json_object: '#/components/schemas/ResponseFormatJSONObject' json_schema: '#/components/schemas/ResponseFormatJSONSchema' text: '#/components/schemas/ResponseFormatText' - type: 'null' title: Response Format description: Output format. Use `json_schema` for structured outputs, `json_object` for JSON mode. safety_identifier: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Safety Identifier description: Stable user identifier for usage policy detection. Recommend hashing username/email. seed: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Seed description: Seed for deterministic sampling. Not guaranteed. Only supported on some models. service_tier: anyOf: - type: string enum: - auto - default - flex - scale - priority - reserved - type: 'null' title: Service Tier description: 'Processing tier: `auto` (default), `priority` (mission-critical), `flex` (cost-efficient), `default`/`scale` (standard), `reserved`.' stop: anyOf: - type: string - items: type: string type: array - type: 'null' title: Stop description: Stop sequences. Generated text will not contain the stop sequence. store: anyOf: - type: boolean - type: 'null' title: Store description: Store the completion output. Supports text and image inputs. UNSUPPORTED on this implementation. stream_options: anyOf: - $ref: '#/components/schemas/ChatCompletionStreamOptionsParam' - type: 'null' description: 'Streaming options. Only set when `stream: true`. Only `include_usage` is supported.' temperature: anyOf: - type: number minimum: 0.0 - type: 'null' title: Temperature description: Sampling temperature. Higher values increase randomness, lower values increase determinism. Use `top_p` or `temperature`, not both. Only supported on some models. tool_choice: anyOf: - type: string enum: - none - auto - required - oneOf: - $ref: '#/components/schemas/ChatCompletionNamedToolChoiceParam' - $ref: '#/components/schemas/ChatCompletionNamedToolChoiceCustomParam' - $ref: '#/components/schemas/ChatCompletionAllowedToolChoiceParam' discriminator: propertyName: type mapping: allowed_tools: '#/components/schemas/ChatCompletionAllowedToolChoiceParam' custom: '#/components/schemas/ChatCompletionNamedToolChoiceCustomParam' function: '#/components/schemas/ChatCompletionNamedToolChoiceParam' - type: 'null' title: Tool Choice description: 'Tool selection: `none` (no tool), `auto` (model decides), `required` (must call tool), or specify a tool by name.' tools: anyOf: - items: oneOf: - $ref: '#/components/schemas/ChatCompletionFunctionToolParam' - $ref: '#/components/schemas/ChatCompletionCustomToolParam' discriminator: propertyName: type mapping: custom: '#/components/schemas/ChatCompletionCustomToolParam' function: '#/components/schemas/ChatCompletionFunctionToolParam' type: array - type: 'null' title: Tools description: List of tools the model may call (custom or function tools). top_logprobs: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Top Logprobs description: Number of most likely tokens to return at each position with log probabilities. Only supported on some models. top_p: anyOf: - type: number minimum: 0.0 - type: 'null' title: Top P description: 'Nucleus sampling: considers tokens comprising top_p probability mass. Use `temperature` or `top_p`, not both. Only supported on some models.' user: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: User description: Deprecated. Use `safety_identifier` or `prompt_cache_key` instead. End-user identifier. deprecated: true verbosity: anyOf: - type: string enum: - low - medium - high - type: 'null' title: Verbosity description: 'Response verbosity: `low`, `medium`, or `high`. UNSUPPORTED on this implementation.' web_search_options: anyOf: - $ref: '#/components/schemas/WebSearchOptions' - type: 'null' description: Web search tool options. UNSUPPORTED on this implementation. stream: type: boolean title: Stream description: Stream response data to client using server-sent events. default: false amazon-bedrock-guardrailConfig: anyOf: - $ref: '#/components/schemas/AmazonBedrockGuardrailConfigParams' - type: 'null' description: Amazon Bedrock Guardrail configuration. top_k: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Top K description: Candidate set size for sampling. Larger increases randomness, smaller increases determinism. Extra field from Qwen Chat Completion API. enable_thinking: anyOf: - type: boolean - type: 'null' title: Enable Thinking description: Enable thinking/reasoning mode. Extra field from Qwen Chat Completion API. thinking_budget: anyOf: - type: integer minimum: 0.0 - type: 'null' title: Thinking Budget description: 'Max thinking length in tokens. Requires `enable_thinking: true`. Default: model''s max chain-of-thought length. Extra field from Qwen Chat Completion API.' translation_options: anyOf: - $ref: '#/components/schemas/QwenTranslationOptions' - type: 'null' description: Translation options (source/target languages, terms, memory, domains). Extra field from Qwen Chat Completion API. UNSUPPORTED on this implementation. thinking: anyOf: - $ref: '#/components/schemas/MoonshotThinkingOptions' - type: 'null' description: Enable/disable thinking. Extra field from Moonshot Chat Completion API. additionalProperties: $ref: '#/components/schemas/JsonValue' type: object required: - messages - model title: CompletionCreateParams description: Create chat completion request following OpenAI API specification. stdapi__types__openai_chat_completions__CustomTool: properties: name: type: string title: Name description: 'The name of the custom tool to call. UNSUPPORTED on this implementation.' input: type: string title: Input description: 'The input for the custom tool call generated by the model. UNSUPPORTED on this implementation.' additionalProperties: false type: object required: - name - input title: CustomTool description: 'Custom tool call payload used within assistant tool calls. UNSUPPORTED on this implementation.' stdapi__types__openai_completions__CompletionCreateParams: properties: model: type: string maxLength: 255 minLength: 1 title: Model description: ID of the model to use. prompt: anyOf: - type: string minLength: 1 pattern: ^(?:https?://|s3://|data:|file-id:) - type: string - items: anyOf: - type: string minLength: 1 pattern: ^(?:https?://|s3://|data:|file-id:) - type: string type: array title: Prompt description: 'The prompt(s) to generate completions for: a single string or array of strings. Non-inline prompts can be a URL, S3 URI, base64 data URI, or Files API reference. Each file is forwarded using its detected modality; the model errors if unsupported. An array with exactly one text string and file prompts is sent as a single multimodal request. Other array shapes return one choice per element. Token arrays are UNSUPPORTED on this implementation.' max_tokens: anyOf: - type: integer minimum: 1.0 - type: 'null' title: Max Tokens description: The maximum number of tokens to generate. Prompt tokens plus max_tokens cannot exceed the model's context length. temperature: anyOf: - type: number maximum: 2.0 minimum: 0.0 - type: 'null' title: Temperature description: Sampling temperature. Higher values (e.g. 0.8) make output more random; lower values (e.g. 0.2) make it more focused. We generally recommend altering this or ``top_p`` but not both. top_p: anyOf: - type: number maximum: 1.0 minimum: 0.0 - type: 'null' title: Top P description: 'Nucleus sampling: the model considers only tokens within the top ``top_p`` probability mass. We generally recommend altering this or ``temperature`` but not both.' stop: anyOf: - type: string - items: type: string type: array - type: 'null' title: Stop description: Up to 4 sequences where the API will stop generating. The returned text will not contain the stop sequence. stream: anyOf: - type: boolean - type: 'null' title: Stream description: 'If true, partial completion deltas are sent as server-sent events as they become available, terminated by a ``data: [DONE]`` message.' stream_options: anyOf: - $ref: '#/components/schemas/ChatCompletionStreamOptionsParam' - type: 'null' description: Options that apply only when ``stream`` is ``True``. n: anyOf: - type: integer maximum: 128.0 minimum: 1.0 - type: 'null' title: N description: How many completions to generate for each prompt. user: anyOf: - type: string - type: 'null' title: User description: Deprecated by OpenAI in favor of ``safety_identifier``. A unique identifier representing your end-user. service_tier: anyOf: - type: string enum: - auto - default - flex - scale - priority - reserved - type: 'null' title: Service Tier description: Processing tier used for serving the request (`auto`, `priority`, `flex`). safety_identifier: anyOf: - type: string - type: 'null' title: Safety Identifier description: A stable identifier for detecting users who may be violating usage policies. Prefer a hash of username or email over the raw value. prompt_cache_key: anyOf: - type: string - type: 'null' title: Prompt Cache Key description: Controls prompt caching for similar requests to reduce costs and improve response times. Any non-empty value enables caching; a dot-separated list of 'system', 'messages', and/or 'tools' scopes it to specific prompt sections. Custom hash keys are UNSUPPORTED in this implementation. prompt_cache_retention: anyOf: - type: string enum: - in-memory - 24h - 1h - 5m - type: 'null' title: Prompt Cache Retention description: 'The retention policy for the prompt cache. OpenAI values are mapped to Bedrock: in-memory -> 5m, 24h -> 1h.' best_of: anyOf: - type: integer - type: 'null' title: Best Of description: 'Generates ``best_of`` completions server-side and returns the one with the highest log probability per token. Results cannot be streamed, and ``best_of`` must be greater than ``n``. UNSUPPORTED in this implementation.' echo: anyOf: - type: boolean - type: 'null' title: Echo description: 'Echo back the prompt in addition to the completion. UNSUPPORTED in this implementation.' frequency_penalty: anyOf: - type: number - type: 'null' title: Frequency Penalty description: 'Number between -2.0 and 2.0. Positive values penalize tokens by their existing frequency so far, reducing verbatim repetition. UNSUPPORTED in this implementation.' logit_bias: anyOf: - additionalProperties: type: number type: object - type: 'null' title: Logit Bias description: 'Maps token IDs (GPT tokenizer) to a bias value from -100 to 100 to modify their likelihood of appearing in the completion. UNSUPPORTED in this implementation.' logprobs: anyOf: - type: integer - type: 'null' title: Logprobs description: 'Include the log probabilities on the ``logprobs`` most likely output tokens (max 5), as well as the chosen tokens. UNSUPPORTED in this implementation.' presence_penalty: anyOf: - type: number - type: 'null' title: Presence Penalty description: 'Number between -2.0 and 2.0. Positive values penalize tokens that already appear in the text so far, encouraging new topics. UNSUPPORTED in this implementation.' seed: anyOf: - type: integer - type: 'null' title: Seed description: 'If specified, the system makes a best effort to sample deterministically for repeated requests with the same ``seed`` and parameters. Determinism is not guaranteed. UNSUPPORTED in this implementation.' suffix: anyOf: - type: string - type: 'null' title: Suffix description: 'The suffix that comes after a completion of inserted text (OpenAI: ``gpt-3.5-turbo-instruct`` only). UNSUPPORTED in this implementation.' additionalProperties: $ref: '#/components/schemas/JsonValue' type: object required: - model - prompt title: CompletionCreateParams description: Request body for the OpenAI completions API (``POST /v1/completions``). stdapi__types__openai_embeddings__Usage: properties: prompt_tokens: type: integer minimum: 0.0 title: Prompt Tokens description: The number of tokens used by the prompt. default: 0 total_tokens: type: integer minimum: 0.0 title: Total Tokens description: The total number of tokens used by the request. default: 0 additionalProperties: false type: object title: Usage description: Embedding usage accounting compatible with OpenAI. stdapi__types__openai_images__Usage: properties: input_tokens: type: integer minimum: 0.0 title: Input Tokens description: Number of tokens (images + text) in the input prompt. default: 0 input_tokens_details: $ref: '#/components/schemas/UsageInputTokensDetails' description: Detailed breakdown of input token usage. output_tokens: type: integer minimum: 0.0 title: Output Tokens description: Number of output tokens generated. default: 0 total_tokens: type: integer minimum: 0.0 title: Total Tokens description: Total tokens used (input + output). default: 0 additionalProperties: false type: object required: - input_tokens_details title: Usage description: Image generation token usage information. stdapi__types__openai_responses__AnnotationURLCitation: properties: end_index: type: integer title: End Index description: Last character index of URL citation. start_index: type: integer title: Start Index description: First character index of URL citation. title: type: string title: Title description: Web resource title. type: type: string const: url_citation title: Type description: URL citation type. url: type: string title: Url description: Web resource URL. additionalProperties: false type: object required: - end_index - start_index - title - type - url title: AnnotationURLCitation description: A citation for a web resource used to generate a model response. stdapi__types__openai_responses__CustomTool: properties: name: type: string title: Name description: Custom tool name. type: type: string const: custom title: Type description: Custom tool type. defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: Deferred and discovered via tool search. description: anyOf: - type: string - type: 'null' title: Description description: Tool description. format: anyOf: - oneOf: - $ref: '#/components/schemas/CustomToolInputFormatText' - $ref: '#/components/schemas/CustomToolInputFormatGrammar' discriminator: propertyName: type mapping: grammar: '#/components/schemas/CustomToolInputFormatGrammar' text: '#/components/schemas/CustomToolInputFormatText' - type: 'null' title: Format description: 'Input format. Default: unconstrained text.' type: object required: - name - type title: CustomTool description: 'A custom tool that processes input using a specified format. UNSUPPORTED on this implementation.' securitySchemes: HTTPBearer: type: http scheme: bearer APIKeyHeader: type: apiKey in: header name: x-api-key