{ "openapi": "3.1.0", "info": { "title": "AIHubMix Gateway API", "description": "Unified multi-protocol gateway. Exposes three native shapes side-by-side:\n - OpenAI (`/v1/chat/completions`, `/v1/responses`, ...)\n - Anthropic (`/v1/messages`)\n - Gemini (`/v1beta/models/{model}:generateContent`)\nEach vendor's native SDK connects directly. Gateway-only fields are\nmarked with `x-source.authority: gateway`.\n", "contact": { "name": "AIHubMix Team" }, "version": "3.5.0", "x-upstream": { "vendorSpecs": { "tag": "v1.20260826.0", "commit": "6ee8575", "installedFrom": "source" }, "sources": { "openai/official": { "version": "2026-08-26", "hash": "sha256:9045dde43bdbfa96b2fab82e0fb347e099db2c150526b7a1f52f101c41fcae0c" }, "anthropic/official": { "version": "2026-08-26", "hash": "sha256:8a277b40a80e294065179e394db585ec36c60d3e698ee0d141d18357c3654200" } }, "layers": [ { "role": "L0-base", "source": "avs://openai/official", "protocol": "openai", "authority": "official" }, { "role": "L0-base", "source": "avs://anthropic/official", "protocol": "anthropic", "authority": "official" }, { "role": "gateway-other", "source": "gateway/anthropic-mappings.yml", "protocol": "all", "authority": "gateway" }, { "role": "gateway-other", "source": "gateway/anthropic-wire-parity.yml", "protocol": "all", "authority": "gateway" }, { "role": "horizontal-auth", "source": "gateway/auth.yml", "protocol": "all", "authority": "gateway" }, { "role": "horizontal-errors", "source": "gateway/errors.yml", "protocol": "all", "authority": "gateway" }, { "role": "L3-gateway", "source": "gateway/openai-gateway.yml", "protocol": "openai", "authority": "gateway" }, { "role": "gateway-other", "source": "gateway/openai-image-mappings.yml", "protocol": "all", "authority": "gateway" }, { "role": "gateway-other", "source": "gateway/openai-mappings.yml", "protocol": "all", "authority": "gateway" }, { "role": "L2-passthrough", "source": "gateway/openai-passthrough.yml", "protocol": "openai", "authority": "gateway" }, { "role": "gateway-other", "source": "gateway/openai-responses-wire-parity.yml", "protocol": "all", "authority": "gateway" } ] } }, "servers": [ { "url": "https://aihubmix.com", "description": "Production" } ], "paths": { "/v1/chat/completions": { "post": { "operationId": "createChatCompletion", "tags": [ "OpenAI · Chat" ], "summary": "/v1/chat/completions", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChatCompletionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChatCompletionResponse" } }, "text/event-stream": { "schema": { "$ref": "#/components/schemas/CreateChatCompletionStreamResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "5XX": { "description": "Server / upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } } }, "x-source": { "from": "avs://openai/official", "authority": "official" }, "description": "**Starting a new project?** We recommend trying [Responses](/docs/api-reference/responses)\nto take advantage of the latest OpenAI platform features. Compare\n[Chat Completions with Responses](/docs/guides/responses-vs-chat-completions?api-mode=responses).\n\n---\n\nCreates a model response for the given chat conversation. Learn more in the\n[text generation](/docs/guides/text-generation), [vision](/docs/guides/vision),\nand [audio](/docs/guides/audio) guides.\n\nParameter support can differ depending on the model used to generate the\nresponse, particularly for newer reasoning models. Parameters that are only\nsupported for reasoning models are noted below. For the current state of\nunsupported parameters in reasoning models,\n[refer to the reasoning guide](/docs/guides/reasoning).\n\nReturns a chat completion object, or a streamed sequence of chat completion\nchunk objects if the request is streamed." } }, "/v1/responses": { "post": { "operationId": "createResponse", "tags": [ "OpenAI · Responses" ], "summary": "/v1/responses", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateResponse" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } }, "text/event-stream": { "schema": { "$ref": "#/components/schemas/ResponseStreamEvent" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "5XX": { "description": "Server / upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } } }, "x-source": { "from": "avs://openai/official", "authority": "official" }, "description": "Creates a model response. Provide [text](/docs/guides/text) or\n[image](/docs/guides/images) inputs to generate [text](/docs/guides/text)\nor [JSON](/docs/guides/structured-outputs) outputs. Have the model call\nyour own [custom code](/docs/guides/function-calling) or use built-in\n[tools](/docs/guides/tools) like [web search](/docs/guides/tools-web-search)\nor [file search](/docs/guides/tools-file-search) to use your own data\nas input for the model's response." } }, "/v1/completions": { "post": { "operationId": "createCompletion", "tags": [ "OpenAI · Completions" ], "summary": "/v1/completions", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCompletionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCompletionResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "5XX": { "description": "Server / upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } } }, "x-source": { "from": "avs://openai/official", "authority": "official" }, "description": "Creates a completion for the provided prompt and parameters.\n\nReturns a completion object, or a sequence of completion objects if the request is streamed." } }, "/v1/embeddings": { "post": { "operationId": "createEmbedding", "tags": [ "OpenAI · Embeddings" ], "summary": "/v1/embeddings", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEmbeddingRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEmbeddingResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "5XX": { "description": "Server / upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } } }, "x-source": { "from": "avs://openai/official", "authority": "official" }, "description": "Creates an embedding vector representing the input text." } }, "/v1/images/generations": { "post": { "operationId": "createImage", "tags": [ "OpenAI · Images" ], "summary": "/v1/images/generations", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateImageRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImagesResponse" } }, "text/event-stream": { "schema": { "$ref": "#/components/schemas/ImageGenStreamEvent" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "5XX": { "description": "Server / upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } } }, "x-source": { "from": "avs://openai/official", "authority": "official" }, "description": "Creates an image given a prompt. [Learn more](/docs/guides/images)." } }, "/v1/videos": { "post": { "tags": [ "OpenAI · Videos" ], "summary": "/v1/videos", "operationId": "createVideo", "parameters": [], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateVideoMultipartBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateVideoJsonBody" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoResource" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "5XX": { "description": "Server / upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } } }, "x-source": { "from": "avs://openai/official", "authority": "official" }, "description": "Create a new video generation job from a prompt and optional reference assets." } }, "/v1/videos/{video_id}": { "get": { "tags": [ "OpenAI · Videos" ], "summary": "/v1/videos/{video_id}", "operationId": "GetVideo", "parameters": [ { "name": "video_id", "in": "path", "description": "The identifier of the video to retrieve.", "required": true, "schema": { "example": "video_123", "type": "string" }, "x-source": { "from": "avs://openai/official", "authority": "official" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoResource" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "5XX": { "description": "Server / upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } } }, "x-source": { "from": "avs://openai/official", "authority": "official" }, "description": "Fetch the latest metadata for a generated video." }, "delete": { "tags": [ "OpenAI · Videos" ], "summary": "/v1/videos/{video_id}", "operationId": "DeleteVideo", "parameters": [ { "name": "video_id", "in": "path", "description": "The identifier of the video to delete.", "required": true, "schema": { "example": "video_123", "type": "string" }, "x-source": { "from": "avs://openai/official", "authority": "official" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletedVideoResource" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "5XX": { "description": "Server / upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } } }, "x-source": { "from": "avs://openai/official", "authority": "official" }, "description": "Permanently delete a completed or failed video and its stored assets." } }, "/v1/videos/{video_id}/content": { "get": { "tags": [ "OpenAI · Videos" ], "summary": "/v1/videos/{video_id}/content", "operationId": "RetrieveVideoContent", "parameters": [ { "name": "video_id", "in": "path", "description": "The identifier of the video whose media to download.", "required": true, "schema": { "example": "video_123", "type": "string" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, { "name": "variant", "in": "query", "description": "Which downloadable asset to return. Defaults to the MP4 video.", "required": false, "schema": { "$ref": "#/components/schemas/VideoContentVariant" }, "x-source": { "from": "avs://openai/official", "authority": "official" } } ], "responses": { "200": { "description": "The video bytes or preview asset that matches the requested variant.", "content": { "video/mp4": { "schema": { "type": "string", "format": "binary" } }, "image/webp": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "5XX": { "description": "Server / upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } } }, "x-source": { "from": "avs://openai/official", "authority": "official" }, "description": "Download the generated video bytes or a derived preview asset.\n\nStreams the rendered video content for the specified video job." } }, "/v1/videos/{video_id}/remix": { "post": { "tags": [ "OpenAI · Videos" ], "summary": "/v1/videos/{video_id}/remix", "operationId": "CreateVideoRemix", "parameters": [ { "name": "video_id", "in": "path", "description": "The identifier of the completed video to remix.", "required": true, "schema": { "example": "video_123", "type": "string" }, "x-source": { "from": "avs://openai/official", "authority": "official" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateVideoRemixBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateVideoRemixBody" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoResource" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "5XX": { "description": "Server / upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } } }, "x-source": { "from": "avs://openai/official", "authority": "official" }, "description": "Create a remix of a completed video using a refreshed prompt." } }, "/v1/audio/speech": { "post": { "operationId": "createSpeech", "tags": [ "OpenAI · Audio" ], "summary": "/v1/audio/speech", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSpeechRequest" } } } }, "responses": { "200": { "description": "OK", "headers": { "Transfer-Encoding": { "schema": { "type": "string" }, "description": "chunked" } }, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "text/event-stream": { "schema": { "$ref": "#/components/schemas/CreateSpeechResponseStreamEvent" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "5XX": { "description": "Server / upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } } }, "x-source": { "from": "avs://openai/official", "authority": "official" }, "description": "Generates audio from the input text.\n\nReturns the audio file content, or a stream of audio events." } }, "/v1/audio/transcriptions": { "post": { "operationId": "createTranscription", "tags": [ "OpenAI · Audio" ], "summary": "/v1/audio/transcriptions", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateTranscriptionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateTranscriptionResponseJson" }, { "$ref": "#/components/schemas/CreateTranscriptionResponseDiarizedJson" }, { "$ref": "#/components/schemas/CreateTranscriptionResponseVerboseJson" } ] } }, "text/event-stream": { "schema": { "$ref": "#/components/schemas/CreateTranscriptionResponseStreamEvent" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "5XX": { "description": "Server / upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } } }, "x-source": { "from": "avs://openai/official", "authority": "official" }, "description": "Transcribes audio into the input language.\n\nReturns a transcription object in `json`, `diarized_json`, or `verbose_json`\nformat, or a stream of transcript events." } }, "/v1/audio/translations": { "post": { "operationId": "createTranslation", "tags": [ "OpenAI · Audio" ], "summary": "/v1/audio/translations", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateTranslationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateTranslationResponseJson" }, { "$ref": "#/components/schemas/CreateTranslationResponseVerboseJson" } ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "5XX": { "description": "Server / upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } } }, "x-source": { "from": "avs://openai/official", "authority": "official" }, "description": "Translates audio into English." } }, "/v1/moderations": { "post": { "operationId": "createModeration", "tags": [ "OpenAI · Moderations" ], "summary": "/v1/moderations", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateModerationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateModerationResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "5XX": { "description": "Server / upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } } }, "x-source": { "from": "avs://openai/official", "authority": "official" }, "description": "Classifies if text and/or image inputs are potentially harmful. Learn\nmore in the [moderation guide](/docs/guides/moderation)." } }, "/v1/messages": { "post": { "summary": "/v1/messages", "description": "Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation.\n\nThe Messages API can be used for either single queries or stateless multi-turn conversations.\n\nLearn more about the Messages API in our [user guide](https://platform.claude.com/docs/en/get-started)", "operationId": "messages_post", "parameters": [ { "name": "anthropic-version", "in": "header", "required": false, "schema": { "type": "string", "description": "The version of the Claude API you want to use.\n\nRead more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).", "title": "Anthropic-Version" }, "description": "The version of the Claude API you want to use.\n\nRead more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, { "name": "anthropic-user-profile-id", "in": "header", "required": false, "schema": { "type": "string", "description": "The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header.", "title": "Anthropic-User-Profile-Id" }, "description": "The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header.", "x-source": { "from": "avs://anthropic/official", "authority": "official" } } ], "responses": { "200": { "description": "Message object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnthropicMessage" } }, "text/event-stream": { "schema": { "$ref": "#/components/schemas/AnthropicMessageStreamEvent" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "5XX": { "description": "Server / upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnthropicCreateMessageParams" } } }, "required": true }, "x-source": { "from": "avs://anthropic/official", "authority": "official" }, "security": [ { "gatewayAnthropicKey": [] }, { "gatewayBearer": [] } ], "tags": [ "Anthropic · Messages" ] } }, "/gemini/v1beta/models/{model}:generateContent": { "parameters": [ { "name": "model", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Gemini model name, e.g. `gemini-2.5-pro`." } ], "post": { "summary": "/gemini/v1beta/models/{model}:generateContent", "description": "Native Gemini protocol entry point. Mirrors the request and response\nshapes of `https://generativelanguage.googleapis.com` — clients may\npoint the google-genai SDK at this gateway directly.\n", "operationId": "geminiGenerateContent", "tags": [ "Gemini · GenerateContent" ], "x-source": { "from": "gemini/official", "authority": "manual" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeminiGenerateContentRequest" } } } }, "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeminiGenerateContentResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } }, "5XX": { "description": "Server / upstream error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayError" } } } } }, "security": [ { "gatewayGeminiKey": [] }, { "gatewayGeminiQuery": [] } ] }, "x-source": { "from": "gateway", "authority": "gateway" } } }, "components": { "schemas": { "AudioResponseFormat": { "description": "The format of the output, in one of these options: `json`, `text`, `srt`, `verbose_json`, `vtt`, or `diarized_json`. For `gpt-4o-transcribe` and `gpt-4o-mini-transcribe`, the only supported format is `json`. For `gpt-4o-transcribe-diarize`, the supported formats are `json`, `text`, and `diarized_json`, with `diarized_json` required to receive speaker annotations.\n", "type": "string", "enum": [ "json", "text", "srt", "verbose_json", "vtt", "diarized_json" ], "default": "json", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionAllowedTools": { "type": "object", "title": "Allowed tools", "description": "Constrains the tools available to the model to a pre-defined set.\n", "properties": { "mode": { "type": "string", "enum": [ "auto", "required" ], "description": "Constrains the tools available to the model to a pre-defined set.\n\n`auto` allows the model to pick from among the allowed tools and generate a\nmessage.\n\n`required` requires the model to call one or more of the allowed tools.\n" }, "tools": { "type": "array", "description": "A list of tool definitions that the model should be allowed to call.\n\nFor the Chat Completions API, the list of tool definitions might look like:\n```json\n[\n { \"type\": \"function\", \"function\": { \"name\": \"get_weather\" } },\n { \"type\": \"function\", \"function\": { \"name\": \"get_time\" } }\n]\n```\n", "items": { "type": "object", "description": "A tool definition that the model should be allowed to call.\n", "additionalProperties": true } } }, "required": [ "mode", "tools" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionAllowedToolsChoice": { "type": "object", "title": "Allowed tools", "description": "Constrains the tools available to the model to a pre-defined set.\n", "properties": { "type": { "type": "string", "enum": [ "allowed_tools" ], "description": "Allowed tool configuration type. Always `allowed_tools`." }, "allowed_tools": { "$ref": "#/components/schemas/ChatCompletionAllowedTools" } }, "required": [ "type", "allowed_tools" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionFunctionCallOption": { "type": "object", "description": "Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n", "properties": { "name": { "type": "string", "description": "The name of the function to call." } }, "required": [ "name" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionFunctions": { "type": "object", "deprecated": true, "properties": { "description": { "type": "string", "description": "A description of what the function does, used by the model to choose when and how to call the function." }, "name": { "type": "string", "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." }, "parameters": { "$ref": "#/components/schemas/FunctionParameters" } }, "required": [ "name" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionMessageCustomToolCall": { "type": "object", "title": "Custom tool call", "description": "A call to a custom tool created by the model.\n", "properties": { "id": { "type": "string", "description": "The ID of the tool call." }, "type": { "type": "string", "enum": [ "custom" ], "description": "The type of the tool. Always `custom`." }, "custom": { "type": "object", "description": "The custom tool that the model called.", "properties": { "name": { "type": "string", "description": "The name of the custom tool to call." }, "input": { "type": "string", "description": "The input for the custom tool call generated by the model." } }, "required": [ "name", "input" ] } }, "required": [ "id", "type", "custom" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionMessageToolCall": { "type": "object", "title": "Function tool call", "description": "A call to a function tool created by the model.\n", "properties": { "id": { "type": "string", "description": "The ID of the tool call." }, "type": { "type": "string", "enum": [ "function" ], "description": "The type of the tool. Currently, only `function` is supported." }, "function": { "type": "object", "description": "The function that the model called.", "properties": { "name": { "type": "string", "description": "The name of the function to call." }, "arguments": { "type": "string", "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." } }, "required": [ "name", "arguments" ] } }, "required": [ "id", "type", "function" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionMessageToolCallChunk": { "type": "object", "properties": { "index": { "type": "integer" }, "id": { "type": "string", "description": "The ID of the tool call." }, "type": { "type": "string", "enum": [ "function" ], "description": "The type of the tool. Currently, only `function` is supported." }, "function": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the function to call." }, "arguments": { "type": "string", "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." } } } }, "required": [ "index" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionMessageToolCalls": { "type": "array", "description": "The tool calls generated by the model, such as function calls.", "items": { "oneOf": [ { "$ref": "#/components/schemas/ChatCompletionMessageToolCall" }, { "$ref": "#/components/schemas/ChatCompletionMessageCustomToolCall" } ], "discriminator": { "propertyName": "type" } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionModeration": { "type": "object", "description": "Moderation results or errors for the request input and generated output.", "properties": { "input": { "oneOf": [ { "$ref": "#/components/schemas/ChatCompletionModerationResults" }, { "$ref": "#/components/schemas/ChatCompletionModerationError" } ], "discriminator": { "propertyName": "type" }, "description": "Moderation for the request input." }, "output": { "oneOf": [ { "$ref": "#/components/schemas/ChatCompletionModerationResults" }, { "$ref": "#/components/schemas/ChatCompletionModerationError" } ], "discriminator": { "propertyName": "type" }, "description": "Moderation for the generated output." } }, "required": [ "input", "output" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionModerationError": { "type": "object", "description": "An error produced while attempting moderation.", "properties": { "type": { "type": "string", "enum": [ "error" ], "description": "The object type, which is always `error`." }, "code": { "type": "string", "description": "The error code." }, "message": { "type": "string", "description": "The error message." } }, "required": [ "type", "code", "message" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionModerationResults": { "type": "object", "description": "Successful moderation results for the request input or generated output.", "properties": { "type": { "type": "string", "enum": [ "moderation_results" ], "description": "The object type, which is always `moderation_results`." }, "model": { "type": "string", "description": "The moderation model used to generate the results." }, "results": { "type": "array", "description": "A list of moderation results.", "items": { "$ref": "#/components/schemas/ModerationResultBody" } } }, "required": [ "type", "model", "results" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionNamedToolChoice": { "type": "object", "title": "Function tool choice", "description": "Specifies a tool the model should use. Use to force the model to call a specific function.", "properties": { "type": { "type": "string", "enum": [ "function" ], "description": "For function calling, the type is always `function`." }, "function": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the function to call." } }, "required": [ "name" ] } }, "required": [ "type", "function" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionNamedToolChoiceCustom": { "type": "object", "title": "Custom tool choice", "description": "Specifies a tool the model should use. Use to force the model to call a specific custom tool.", "properties": { "type": { "type": "string", "enum": [ "custom" ], "description": "For custom tool calling, the type is always `custom`." }, "custom": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the custom tool to call." } }, "required": [ "name" ] } }, "required": [ "type", "custom" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionRequestAssistantMessage": { "type": "object", "title": "Assistant message", "description": "Messages sent by the model in response to user messages.\n", "properties": { "content": { "anyOf": [ { "oneOf": [ { "type": "string", "description": "The contents of the assistant message.", "title": "Text content" }, { "type": "array", "description": "An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`.", "title": "Array of content parts", "items": { "$ref": "#/components/schemas/ChatCompletionRequestAssistantMessageContentPart" }, "minItems": 1 } ], "description": "The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.\n" }, { "type": "null" } ] }, "refusal": { "anyOf": [ { "type": "string", "description": "The refusal message by the assistant." }, { "type": "null" } ] }, "role": { "type": "string", "enum": [ "assistant" ], "description": "The role of the messages author, in this case `assistant`." }, "name": { "type": "string", "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." }, "audio": { "anyOf": [ { "type": "object", "description": "Data about a previous audio response from the model.\n[Learn more](/docs/guides/audio).\n", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Unique identifier for a previous audio response from the model.\n" } } }, { "type": "null" } ] }, "tool_calls": { "$ref": "#/components/schemas/ChatCompletionMessageToolCalls" }, "function_call": { "anyOf": [ { "type": "object", "deprecated": true, "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", "properties": { "arguments": { "type": "string", "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." }, "name": { "type": "string", "description": "The name of the function to call." } }, "required": [ "arguments", "name" ] }, { "type": "null" } ] }, "reasoning_content": { "type": "string", "nullable": true, "description": "Model-generated reasoning text (thinking / chain-of-thought). Streams\nindependently of `content`. Also accepted on the request side to replay\nthe previous assistant turn's reasoning in multi-turn conversations.\n", "x-source": { "from": "gateway", "authority": "gateway" }, "x-providers-default": "drop", "x-providers": { "anthropic": { "from": [ "content", "*", "thinking" ], "transform": "extract_thinking_text" }, "bedrock": { "from": [ "content", "*", "thinking" ], "transform": "extract_thinking_text" }, "deepseek": { "from": [ "choices", "0", "message", "reasoning_content" ] } } }, "reasoning_details": { "type": "array", "nullable": true, "description": "Structured reasoning trace. Each element mirrors the upstream shape\n(Anthropic thinking block / OpenAI Responses reasoning item / Gemini\nthought) — no fixed schema; branch on the `type` field.\n", "items": { "type": "object", "additionalProperties": true }, "x-source": { "from": "gateway", "authority": "gateway" }, "x-providers-default": "drop", "x-providers": { "anthropic": { "from": [ "content" ], "transform": "anthropic_thinking_to_reasoning_details" }, "bedrock": { "from": [ "content" ], "transform": "anthropic_thinking_to_reasoning_details" }, "gemini": { "from": [ "candidates", "0", "content", "parts" ], "transform": "gemini_thoughts_to_reasoning_details" } } } }, "required": [ "role" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionRequestAssistantMessageContentPart": { "oneOf": [ { "$ref": "#/components/schemas/ChatCompletionRequestMessageContentPartText" }, { "$ref": "#/components/schemas/ChatCompletionRequestMessageContentPartRefusal" } ], "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionRequestDeveloperMessage": { "type": "object", "title": "Developer message", "description": "Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, `developer` messages\nreplace the previous `system` messages.\n", "properties": { "content": { "description": "The contents of the developer message.", "oneOf": [ { "type": "string", "description": "The contents of the developer message.", "title": "Text content" }, { "type": "array", "description": "An array of content parts with a defined type. For developer messages, only type `text` is supported.", "title": "Array of content parts", "items": { "$ref": "#/components/schemas/ChatCompletionRequestMessageContentPartText" }, "minItems": 1 } ] }, "role": { "type": "string", "enum": [ "developer" ], "description": "The role of the messages author, in this case `developer`." }, "name": { "type": "string", "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." } }, "required": [ "content", "role" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionRequestFunctionMessage": { "type": "object", "title": "Function message", "deprecated": true, "properties": { "role": { "type": "string", "enum": [ "function" ], "description": "The role of the messages author, in this case `function`." }, "content": { "anyOf": [ { "type": "string", "description": "The contents of the function message." }, { "type": "null" } ] }, "name": { "type": "string", "description": "The name of the function to call." } }, "required": [ "role", "content", "name" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionRequestMessage": { "oneOf": [ { "$ref": "#/components/schemas/ChatCompletionRequestDeveloperMessage" }, { "$ref": "#/components/schemas/ChatCompletionRequestSystemMessage" }, { "$ref": "#/components/schemas/ChatCompletionRequestUserMessage" }, { "$ref": "#/components/schemas/ChatCompletionRequestAssistantMessage" }, { "$ref": "#/components/schemas/ChatCompletionRequestToolMessage" }, { "$ref": "#/components/schemas/ChatCompletionRequestFunctionMessage" } ], "discriminator": { "propertyName": "role" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionRequestMessageContentPartAudio": { "type": "object", "title": "Audio content part", "description": "Learn about [audio inputs](/docs/guides/audio).\n", "properties": { "type": { "type": "string", "enum": [ "input_audio" ], "description": "The type of the content part. Always `input_audio`." }, "input_audio": { "type": "object", "properties": { "data": { "type": "string", "description": "Base64 encoded audio data." }, "format": { "type": "string", "enum": [ "wav", "mp3" ], "description": "The format of the encoded audio data. Currently supports \"wav\" and \"mp3\".\n" } }, "required": [ "data", "format" ] }, "prompt_cache_breakpoint": { "$ref": "#/components/schemas/PromptCacheBreakpointParam" }, "cache_control": { "additionalProperties": false, "properties": { "ttl": { "description": "The time-to-live for the cache control breakpoint.\n\nThis may be one the following values:\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.", "enum": [ "5m", "1h" ], "title": "Ttl", "type": "string" }, "type": { "const": "ephemeral", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "CacheControlEphemeral", "type": "object", "description": "Anthropic prompt-cache breakpoint. When set on a content block,\neverything from the conversation start up through that block is\ncached on Anthropic's servers (5m or 1h TTL — see the `ttl` field).\nCurrently supported for Anthropic / Bedrock only; ignored by other\nproviders.\n", "x-source": { "from": "avs://anthropic/official", "authority": "official" }, "x-providers-default": "drop", "x-providers": { "anthropic": {}, "bedrock": {} } } }, "required": [ "type", "input_audio" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionRequestMessageContentPartFile": { "type": "object", "title": "File content part", "description": "Learn about [file inputs](/docs/guides/text) for text generation.\n", "properties": { "type": { "type": "string", "enum": [ "file" ], "description": "The type of the content part. Always `file`." }, "file": { "type": "object", "properties": { "filename": { "type": "string", "description": "The name of the file, used when passing the file to the model as a \nstring.\n" }, "file_data": { "type": "string", "description": "The base64 encoded file data, used when passing the file to the model \nas a string.\n" }, "file_id": { "type": "string", "description": "The ID of an uploaded file to use as input.\n" } } }, "prompt_cache_breakpoint": { "$ref": "#/components/schemas/PromptCacheBreakpointParam" }, "cache_control": { "additionalProperties": false, "properties": { "ttl": { "description": "The time-to-live for the cache control breakpoint.\n\nThis may be one the following values:\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.", "enum": [ "5m", "1h" ], "title": "Ttl", "type": "string" }, "type": { "const": "ephemeral", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "CacheControlEphemeral", "type": "object", "description": "Anthropic prompt-cache breakpoint. When set on a content block,\neverything from the conversation start up through that block is\ncached on Anthropic's servers (5m or 1h TTL — see the `ttl` field).\nCurrently supported for Anthropic / Bedrock only; ignored by other\nproviders.\n", "x-source": { "from": "avs://anthropic/official", "authority": "official" }, "x-providers-default": "drop", "x-providers": { "anthropic": {}, "bedrock": {} } } }, "required": [ "type", "file" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionRequestMessageContentPartImage": { "type": "object", "title": "Image content part", "description": "Learn about [image inputs](/docs/guides/vision).\n", "properties": { "type": { "type": "string", "enum": [ "image_url" ], "description": "The type of the content part." }, "image_url": { "type": "object", "properties": { "url": { "type": "string", "description": "Either a URL of the image or the base64 encoded image data.", "format": "uri" }, "detail": { "type": "string", "description": "Specifies the detail level of the image. Learn more in the [Vision guide](/docs/guides/vision#low-or-high-fidelity-image-understanding).", "enum": [ "auto", "low", "high" ], "default": "auto" } }, "required": [ "url" ] }, "prompt_cache_breakpoint": { "$ref": "#/components/schemas/PromptCacheBreakpointParam" }, "cache_control": { "additionalProperties": false, "properties": { "ttl": { "description": "The time-to-live for the cache control breakpoint.\n\nThis may be one the following values:\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.", "enum": [ "5m", "1h" ], "title": "Ttl", "type": "string" }, "type": { "const": "ephemeral", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "CacheControlEphemeral", "type": "object", "description": "Anthropic prompt-cache breakpoint. When set on a content block,\neverything from the conversation start up through that block is\ncached on Anthropic's servers (5m or 1h TTL — see the `ttl` field).\nCurrently supported for Anthropic / Bedrock only; ignored by other\nproviders.\n", "x-source": { "from": "avs://anthropic/official", "authority": "official" }, "x-providers-default": "drop", "x-providers": { "anthropic": {}, "bedrock": {} } } }, "required": [ "type", "image_url" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionRequestMessageContentPartRefusal": { "type": "object", "title": "Refusal content part", "properties": { "type": { "type": "string", "enum": [ "refusal" ], "description": "The type of the content part." }, "refusal": { "type": "string", "description": "The refusal message generated by the model." } }, "required": [ "type", "refusal" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionRequestMessageContentPartText": { "type": "object", "title": "Text content part", "description": "Learn about [text inputs](/docs/guides/text-generation).\n", "properties": { "type": { "type": "string", "enum": [ "text" ], "description": "The type of the content part." }, "text": { "type": "string", "description": "The text content." }, "prompt_cache_breakpoint": { "$ref": "#/components/schemas/PromptCacheBreakpointParam" }, "cache_control": { "additionalProperties": false, "properties": { "ttl": { "description": "The time-to-live for the cache control breakpoint.\n\nThis may be one the following values:\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.", "enum": [ "5m", "1h" ], "title": "Ttl", "type": "string" }, "type": { "const": "ephemeral", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "CacheControlEphemeral", "type": "object", "description": "Anthropic prompt-cache breakpoint. When set on a content block,\neverything from the conversation start up through that block is\ncached on Anthropic's servers (5m or 1h TTL — see the `ttl` field).\nCurrently supported for Anthropic / Bedrock only; ignored by other\nproviders.\n", "x-source": { "from": "avs://anthropic/official", "authority": "official" }, "x-providers-default": "drop", "x-providers": { "anthropic": {}, "bedrock": {} } } }, "required": [ "type", "text" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionRequestSystemMessage": { "type": "object", "title": "System message", "description": "Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, use `developer` messages\nfor this purpose instead.\n", "properties": { "content": { "description": "The contents of the system message.", "oneOf": [ { "type": "string", "description": "The contents of the system message.", "title": "Text content" }, { "type": "array", "description": "An array of content parts with a defined type. For system messages, only type `text` is supported.", "title": "Array of content parts", "items": { "$ref": "#/components/schemas/ChatCompletionRequestSystemMessageContentPart" }, "minItems": 1 } ] }, "role": { "type": "string", "enum": [ "system" ], "description": "The role of the messages author, in this case `system`." }, "name": { "type": "string", "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." } }, "required": [ "content", "role" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionRequestSystemMessageContentPart": { "oneOf": [ { "$ref": "#/components/schemas/ChatCompletionRequestMessageContentPartText" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionRequestToolMessage": { "type": "object", "title": "Tool message", "properties": { "role": { "type": "string", "enum": [ "tool" ], "description": "The role of the messages author, in this case `tool`." }, "content": { "oneOf": [ { "type": "string", "description": "The contents of the tool message.", "title": "Text content" }, { "type": "array", "description": "An array of content parts with a defined type. For tool messages, only type `text` is supported.", "title": "Array of content parts", "items": { "$ref": "#/components/schemas/ChatCompletionRequestToolMessageContentPart" }, "minItems": 1 } ], "description": "The contents of the tool message." }, "tool_call_id": { "type": "string", "description": "Tool call that this message is responding to." } }, "required": [ "role", "content", "tool_call_id" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionRequestToolMessageContentPart": { "oneOf": [ { "$ref": "#/components/schemas/ChatCompletionRequestMessageContentPartText" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionRequestUserMessage": { "type": "object", "title": "User message", "description": "Messages sent by an end user, containing prompts or additional context\ninformation.\n", "properties": { "content": { "description": "The contents of the user message.\n", "oneOf": [ { "type": "string", "description": "The text contents of the message.", "title": "Text content" }, { "type": "array", "description": "An array of content parts with a defined type. Supported options differ based on the [model](/docs/models) being used to generate the response. Can contain text, image, or audio inputs.", "title": "Array of content parts", "items": { "$ref": "#/components/schemas/ChatCompletionRequestUserMessageContentPart" }, "minItems": 1 } ] }, "role": { "type": "string", "enum": [ "user" ], "description": "The role of the messages author, in this case `user`." }, "name": { "type": "string", "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." } }, "required": [ "content", "role" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionRequestUserMessageContentPart": { "oneOf": [ { "$ref": "#/components/schemas/ChatCompletionRequestMessageContentPartText" }, { "$ref": "#/components/schemas/ChatCompletionRequestMessageContentPartImage" }, { "$ref": "#/components/schemas/ChatCompletionRequestMessageContentPartAudio" }, { "$ref": "#/components/schemas/ChatCompletionRequestMessageContentPartFile" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionResponseMessage": { "type": "object", "description": "A chat completion message generated by the model.", "properties": { "content": { "anyOf": [ { "type": "string", "description": "The contents of the message." }, { "type": "null" } ] }, "refusal": { "anyOf": [ { "type": "string", "description": "The refusal message generated by the model." }, { "type": "null" } ] }, "tool_calls": { "$ref": "#/components/schemas/ChatCompletionMessageToolCalls" }, "annotations": { "type": "array", "description": "Annotations for the message, when applicable, as when using the\n[web search tool](/docs/guides/tools-web-search?api-mode=chat).\n", "items": { "type": "object", "description": "A URL citation when using web search.\n", "required": [ "type", "url_citation" ], "properties": { "type": { "type": "string", "description": "The type of the URL citation. Always `url_citation`.", "enum": [ "url_citation" ] }, "url_citation": { "type": "object", "description": "A URL citation when using web search.", "required": [ "end_index", "start_index", "url", "title" ], "properties": { "end_index": { "type": "integer", "description": "The index of the last character of the URL citation in the message." }, "start_index": { "type": "integer", "description": "The index of the first character of the URL citation in the message." }, "url": { "type": "string", "format": "uri", "description": "The URL of the web resource." }, "title": { "type": "string", "description": "The title of the web resource." } } } } } }, "role": { "type": "string", "enum": [ "assistant" ], "description": "The role of the author of this message." }, "function_call": { "type": "object", "deprecated": true, "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", "properties": { "arguments": { "type": "string", "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." }, "name": { "type": "string", "description": "The name of the function to call." } }, "required": [ "name", "arguments" ] }, "audio": { "anyOf": [ { "type": "object", "description": "If the audio output modality is requested, this object contains data\nabout the audio response from the model. [Learn more](/docs/guides/audio).\n", "required": [ "id", "expires_at", "data", "transcript" ], "properties": { "id": { "type": "string", "description": "Unique identifier for this audio response." }, "expires_at": { "type": "integer", "format": "unixtime", "description": "The Unix timestamp (in seconds) for when this audio response will\nno longer be accessible on the server for use in multi-turn\nconversations.\n" }, "data": { "type": "string", "description": "Base64 encoded audio bytes generated by the model, in the format\nspecified in the request.\n" }, "transcript": { "type": "string", "description": "Transcript of the audio generated by the model." } } }, { "type": "null" } ] }, "reasoning_content": { "type": "string", "nullable": true, "description": "Model-generated reasoning text (thinking / chain-of-thought). Streams\nindependently of `content`. Also accepted on the request side to replay\nthe previous assistant turn's reasoning in multi-turn conversations.\n", "x-source": { "from": "gateway", "authority": "gateway" }, "x-providers-default": "drop", "x-providers": { "anthropic": { "from": [ "content", "*", "thinking" ], "transform": "extract_thinking_text" }, "bedrock": { "from": [ "content", "*", "thinking" ], "transform": "extract_thinking_text" }, "deepseek": { "from": [ "choices", "0", "message", "reasoning_content" ] } } }, "reasoning_details": { "type": "array", "nullable": true, "description": "Structured reasoning trace. Each element mirrors the upstream shape\n(Anthropic thinking block / OpenAI Responses reasoning item / Gemini\nthought) — no fixed schema; branch on the `type` field.\n", "items": { "type": "object", "additionalProperties": true }, "x-source": { "from": "gateway", "authority": "gateway" }, "x-providers-default": "drop", "x-providers": { "anthropic": { "from": [ "content" ], "transform": "anthropic_thinking_to_reasoning_details" }, "bedrock": { "from": [ "content" ], "transform": "anthropic_thinking_to_reasoning_details" }, "gemini": { "from": [ "candidates", "0", "content", "parts" ], "transform": "gemini_thoughts_to_reasoning_details" } } } }, "required": [ "role", "content", "refusal" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionStreamOptions": { "anyOf": [ { "description": "Options for streaming response. Only set this when you set `stream: true`.\n", "type": "object", "default": null, "properties": { "include_usage": { "type": "boolean", "description": "If set, an additional chunk will be streamed before the `data: [DONE]`\nmessage. The `usage` field on this chunk shows the token usage statistics\nfor the entire request, and the `choices` field will always be an empty\narray.\n\nAll other chunks will also include a `usage` field, but with a null\nvalue. **NOTE:** If the stream is interrupted, you may not receive the\nfinal usage chunk which contains the total token usage for the request.\n" }, "include_obfuscation": { "type": "boolean", "description": "When true, stream obfuscation will be enabled. Stream obfuscation adds\nrandom characters to an `obfuscation` field on streaming delta events to\nnormalize payload sizes as a mitigation to certain side-channel attacks.\nThese obfuscation fields are included by default, but add a small amount\nof overhead to the data stream. You can set `include_obfuscation` to\nfalse to optimize for bandwidth if you trust the network links between\nyour application and the OpenAI API.\n" } } }, { "type": "null" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionStreamResponseDelta": { "type": "object", "description": "A chat completion delta generated by streamed model responses.", "properties": { "content": { "anyOf": [ { "type": "string", "description": "The contents of the chunk message." }, { "type": "null" } ] }, "function_call": { "deprecated": true, "type": "object", "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", "properties": { "arguments": { "type": "string", "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." }, "name": { "type": "string", "description": "The name of the function to call." } } }, "tool_calls": { "type": "array", "items": { "$ref": "#/components/schemas/ChatCompletionMessageToolCallChunk" } }, "role": { "type": "string", "enum": [ "developer", "system", "user", "assistant", "tool" ], "description": "The role of the author of this message." }, "refusal": { "anyOf": [ { "type": "string", "description": "The refusal message generated by the model." }, { "type": "null" } ] } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionTokenLogprob": { "type": "object", "properties": { "token": { "description": "The token.", "type": "string" }, "logprob": { "description": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely.", "type": "number" }, "bytes": { "anyOf": [ { "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.", "type": "array", "items": { "type": "integer" } }, { "type": "null" } ] }, "top_logprobs": { "description": "List of the most likely tokens and their log probability, at this token position. The number of entries may be fewer than the requested `top_logprobs`.", "type": "array", "items": { "type": "object", "properties": { "token": { "description": "The token.", "type": "string" }, "logprob": { "description": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely.", "type": "number" }, "bytes": { "anyOf": [ { "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.", "type": "array", "items": { "type": "integer" } }, { "type": "null" } ] } }, "required": [ "token", "logprob", "bytes" ] } } }, "required": [ "token", "logprob", "bytes", "top_logprobs" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionTool": { "type": "object", "title": "Function tool", "description": "A function tool that can be used to generate a response.\n", "properties": { "type": { "type": "string", "enum": [ "function" ], "description": "The type of the tool. Currently, only `function` is supported." }, "function": { "$ref": "#/components/schemas/FunctionObject" }, "cache_control": { "additionalProperties": false, "properties": { "ttl": { "description": "The time-to-live for the cache control breakpoint.\n\nThis may be one the following values:\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.", "enum": [ "5m", "1h" ], "title": "Ttl", "type": "string" }, "type": { "const": "ephemeral", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "CacheControlEphemeral", "type": "object", "description": "Per-tool prompt-cache breakpoint. When set on a tool, everything\nfrom the conversation start up through that tool definition is\ncached. Currently supported for Anthropic / Bedrock only.\n", "x-source": { "from": "avs://anthropic/official", "authority": "official" } } }, "required": [ "type", "function" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ChatCompletionToolChoiceOption": { "description": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tool and instead generates a message.\n`auto` means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools.\nSpecifying a particular tool via `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n\n`none` is the default when no tools are present. `auto` is the default if tools are present.\n", "oneOf": [ { "type": "string", "title": "Tool choice mode", "description": "`none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools.\n", "enum": [ "none", "auto", "required" ] }, { "$ref": "#/components/schemas/ChatCompletionAllowedToolsChoice" }, { "$ref": "#/components/schemas/ChatCompletionNamedToolChoice" }, { "$ref": "#/components/schemas/ChatCompletionNamedToolChoiceCustom" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CodeInterpreterTool": { "type": "object", "title": "Code interpreter", "description": "A tool that runs Python code to help generate a response to a prompt.\n", "properties": { "type": { "type": "string", "enum": [ "code_interpreter" ], "description": "The type of the code interpreter tool. Always `code_interpreter`.\n" }, "container": { "description": "The code interpreter container. Can be a container ID or an object that\nspecifies uploaded file IDs to make available to your code, along with an\noptional `memory_limit` setting.\n", "oneOf": [ { "type": "string", "description": "The container ID." }, { "$ref": "#/components/schemas/AutoCodeInterpreterToolParam" } ] }, "allowed_callers": { "anyOf": [ { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/CallableToolAllowedCaller" }, "description": "The tool invocation context(s)." }, { "type": "null" } ] } }, "required": [ "type", "container" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CodeInterpreterToolCall": { "type": "object", "title": "Code interpreter tool call", "description": "A tool call to run code.\n", "properties": { "type": { "type": "string", "enum": [ "code_interpreter_call" ], "default": "code_interpreter_call", "description": "The type of the code interpreter tool call. Always `code_interpreter_call`.\n" }, "id": { "type": "string", "description": "The unique ID of the code interpreter tool call.\n" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete", "interpreting", "failed" ], "description": "The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`.\n" }, "container_id": { "type": "string", "description": "The ID of the container used to run the code.\n" }, "code": { "anyOf": [ { "type": "string", "description": "The code to run, or null if not available.\n" }, { "type": "null" } ] }, "outputs": { "anyOf": [ { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CodeInterpreterOutputLogs" }, { "$ref": "#/components/schemas/CodeInterpreterOutputImage" } ], "discriminator": { "propertyName": "type" } }, "discriminator": { "propertyName": "type" }, "description": "The outputs generated by the code interpreter, such as logs or images.\nCan be null if no outputs are available.\n" }, { "type": "null" } ] } }, "required": [ "type", "id", "status", "container_id", "code", "outputs" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ComparisonFilter": { "type": "object", "additionalProperties": false, "title": "Comparison Filter", "description": "A filter used to compare a specified attribute key to a given value using a defined comparison operation.\n", "properties": { "type": { "type": "string", "default": "eq", "enum": [ "eq", "ne", "gt", "gte", "lt", "lte", "in", "nin" ], "description": "Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.\n- `eq`: equals\n- `ne`: not equal\n- `gt`: greater than\n- `gte`: greater than or equal\n- `lt`: less than\n- `lte`: less than or equal\n- `in`: in\n- `nin`: not in\n" }, "key": { "type": "string", "description": "The key to compare against the value." }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "The value to compare against the attribute key; supports string, number, or boolean types." } }, "required": [ "type", "key", "value" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CompletionUsage": { "type": "object", "description": "Usage statistics for the completion request.", "properties": { "completion_tokens": { "type": "integer", "default": 0, "description": "Number of tokens in the generated completion." }, "prompt_tokens": { "type": "integer", "default": 0, "description": "Number of tokens in the prompt." }, "total_tokens": { "type": "integer", "default": 0, "description": "Total number of tokens used in the request (prompt + completion)." }, "completion_tokens_details": { "type": "object", "description": "Breakdown of tokens used in a completion.", "properties": { "accepted_prediction_tokens": { "type": "integer", "default": 0, "description": "When using Predicted Outputs, the number of tokens in the\nprediction that appeared in the completion.\n" }, "audio_tokens": { "type": "integer", "default": 0, "description": "Audio input tokens generated by the model." }, "reasoning_tokens": { "type": "integer", "default": 0, "description": "Tokens generated by the model for reasoning." }, "rejected_prediction_tokens": { "type": "integer", "default": 0, "description": "When using Predicted Outputs, the number of tokens in the\nprediction that did not appear in the completion. However, like\nreasoning tokens, these tokens are still counted in the total\ncompletion tokens for purposes of billing, output, and context window\nlimits.\n" } } }, "prompt_tokens_details": { "type": "object", "description": "Breakdown of tokens used in the prompt.", "properties": { "audio_tokens": { "type": "integer", "default": 0, "description": "Audio input tokens present in the prompt." }, "cached_tokens": { "type": "integer", "default": 0, "description": "Cached tokens present in the prompt." }, "cache_write_tokens": { "type": "integer", "default": 0, "description": "The unadjusted number of prompt tokens written to cache." } } } }, "required": [ "prompt_tokens", "completion_tokens", "total_tokens" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CompoundFilter": { "$recursiveAnchor": true, "type": "object", "additionalProperties": false, "title": "Compound Filter", "description": "Combine multiple filters using `and` or `or`.", "properties": { "type": { "type": "string", "description": "Type of operation: `and` or `or`.", "enum": [ "and", "or" ] }, "filters": { "type": "array", "description": "Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.", "items": { "oneOf": [ { "$ref": "#/components/schemas/ComparisonFilter" }, { "$recursiveRef": "#" } ], "discriminator": { "propertyName": "type" } } } }, "required": [ "type", "filters" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ComputerAction": { "oneOf": [ { "$ref": "#/components/schemas/ClickParam" }, { "$ref": "#/components/schemas/DoubleClickAction" }, { "$ref": "#/components/schemas/DragParam" }, { "$ref": "#/components/schemas/KeyPressAction" }, { "$ref": "#/components/schemas/MoveParam" }, { "$ref": "#/components/schemas/ScreenshotParam" }, { "$ref": "#/components/schemas/ScrollParam" }, { "$ref": "#/components/schemas/TypeParam" }, { "$ref": "#/components/schemas/WaitParam" } ], "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ComputerActionList": { "title": "Computer Action List", "type": "array", "description": "Flattened batched actions for `computer_use`. Each action includes an\n`type` discriminator and action-specific fields.\n", "items": { "$ref": "#/components/schemas/ComputerAction" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ComputerScreenshotImage": { "type": "object", "description": "A computer screenshot image used with the computer use tool.\n", "properties": { "type": { "type": "string", "enum": [ "computer_screenshot" ], "default": "computer_screenshot", "description": "Specifies the event type. For a computer screenshot, this property is \nalways set to `computer_screenshot`.\n" }, "image_url": { "type": "string", "format": "uri", "description": "The URL of the screenshot image." }, "file_id": { "type": "string", "description": "The identifier of an uploaded file that contains the screenshot." } }, "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ComputerToolCall": { "type": "object", "title": "Computer tool call", "description": "A tool call to a computer use tool. See the\n[computer use guide](/docs/guides/tools-computer-use) for more information.\n", "properties": { "type": { "type": "string", "description": "The type of the computer call. Always `computer_call`.", "enum": [ "computer_call" ], "default": "computer_call" }, "id": { "type": "string", "description": "The unique ID of the computer call." }, "call_id": { "type": "string", "description": "An identifier used when responding to the tool call with output.\n" }, "action": { "$ref": "#/components/schemas/ComputerAction" }, "actions": { "$ref": "#/components/schemas/ComputerActionList" }, "pending_safety_checks": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerCallSafetyCheckParam" }, "description": "The pending safety checks for the computer call.\n" }, "status": { "type": "string", "description": "The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n", "enum": [ "in_progress", "completed", "incomplete" ] } }, "required": [ "type", "id", "call_id", "pending_safety_checks", "status" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ComputerToolCallOutput": { "type": "object", "title": "Computer tool call output", "description": "The output of a computer tool call.\n", "properties": { "type": { "type": "string", "description": "The type of the computer tool call output. Always `computer_call_output`.\n", "enum": [ "computer_call_output" ], "default": "computer_call_output" }, "id": { "type": "string", "description": "The ID of the computer tool call output.\n" }, "call_id": { "type": "string", "description": "The ID of the computer tool call that produced the output.\n" }, "acknowledged_safety_checks": { "type": "array", "description": "The safety checks reported by the API that have been acknowledged by the\ndeveloper.\n", "items": { "$ref": "#/components/schemas/ComputerCallSafetyCheckParam" } }, "output": { "$ref": "#/components/schemas/ComputerScreenshotImage" }, "status": { "type": "string", "description": "The status of the message input. One of `in_progress`, `completed`, or\n`incomplete`. Populated when input items are returned via API.\n", "enum": [ "in_progress", "completed", "incomplete" ] } }, "required": [ "type", "call_id", "output" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ComputerToolCallOutputResource": { "allOf": [ { "$ref": "#/components/schemas/ComputerToolCallOutput" }, { "type": "object", "properties": { "id": { "type": "string", "description": "The unique ID of the computer call tool output.\n" }, "status": { "description": "The status of the message input. One of `in_progress`, `completed`, or\n`incomplete`. Populated when input items are returned via API.\n", "$ref": "#/components/schemas/ComputerCallOutputStatus" }, "created_by": { "type": "string", "description": "The identifier of the actor that created the item.\n" } }, "required": [ "id", "status" ] } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ConversationParam": { "description": "The conversation that this response belongs to. Items from this conversation are prepended to `input_items` for this response request.\nInput items and output items from this response are automatically added to this conversation after this response completes.\n", "default": null, "oneOf": [ { "type": "string", "title": "Conversation ID", "description": "The unique ID of the conversation.\n" }, { "$ref": "#/components/schemas/ConversationParam-2" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateChatCompletionRequest": { "allOf": [ { "$ref": "#/components/schemas/CreateModelResponseProperties" }, { "type": "object", "properties": { "messages": { "description": "A list of messages comprising the conversation so far. Depending on the\n[model](/docs/models) you use, different message types (modalities) are\nsupported, like [text](/docs/guides/text-generation),\n[images](/docs/guides/vision), and [audio](/docs/guides/audio).\n", "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/ChatCompletionRequestMessage" }, "x-providers": { "anthropic": { "transform": "split_system_from_messages" }, "bedrock": { "transform": "split_system_from_messages" }, "gemini": { "to": [ "contents" ], "transform": "openai_messages_to_gemini_contents" }, "vertex": { "to": [ "contents" ], "transform": "openai_messages_to_gemini_contents" } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "model": { "description": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "$ref": "#/components/schemas/ModelIdsShared" }, "modalities": { "$ref": "#/components/schemas/ResponseModalities" }, "verbosity": { "$ref": "#/components/schemas/Verbosity" }, "reasoning_effort": { "$ref": "#/components/schemas/ReasoningEffort" }, "max_completion_tokens": { "description": "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).\n", "type": "integer", "nullable": true }, "frequency_penalty": { "type": "number", "default": 0, "minimum": -2, "maximum": 2, "nullable": true, "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on\ntheir existing frequency in the text so far, decreasing the model's\nlikelihood to repeat the same line verbatim.\n" }, "presence_penalty": { "type": "number", "default": 0, "minimum": -2, "maximum": 2, "nullable": true, "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on\nwhether they appear in the text so far, increasing the model's likelihood\nto talk about new topics.\n" }, "web_search_options": { "type": "object", "title": "Web search", "description": "This tool searches the web for relevant results to use in a response.\nLearn more about the [web search tool](/docs/guides/tools-web-search?api-mode=chat).\n", "properties": { "user_location": { "type": "object", "nullable": true, "required": [ "type", "approximate" ], "description": "Approximate location parameters for the search.\n", "properties": { "type": { "type": "string", "description": "The type of location approximation. Always `approximate`.\n", "enum": [ "approximate" ] }, "approximate": { "$ref": "#/components/schemas/WebSearchLocation" } } }, "search_context_size": { "$ref": "#/components/schemas/WebSearchContextSize" } } }, "top_logprobs": { "description": "An integer between 0 and 20 specifying the maximum number of most likely\ntokens to return at each token position, each with an associated log\nprobability. In some cases, the number of returned tokens may be fewer than\nrequested.\n`logprobs` must be set to `true` if this parameter is used.\n", "type": "integer", "minimum": 0, "maximum": 20, "nullable": true }, "response_format": { "description": "An object specifying the format that the model must output.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n", "oneOf": [ { "$ref": "#/components/schemas/ResponseFormatText" }, { "$ref": "#/components/schemas/ResponseFormatJsonSchema" }, { "$ref": "#/components/schemas/ResponseFormatJsonObject" } ], "discriminator": { "propertyName": "type" } }, "audio": { "type": "object", "nullable": true, "description": "Parameters for audio output. Required when audio output is requested with\n`modalities: [\"audio\"]`. [Learn more](/docs/guides/audio).\n", "required": [ "voice", "format" ], "properties": { "voice": { "$ref": "#/components/schemas/VoiceIdsOrCustomVoice", "description": "The voice the model uses to respond. Supported built-in voices are\n`alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`,\n`sage`, `shimmer`, `marin`, and `cedar`. You may also provide a\ncustom voice object with an `id`, for example `{ \"id\": \"voice_1234\" }`.\n" }, "format": { "type": "string", "enum": [ "wav", "aac", "mp3", "flac", "opus", "pcm16" ], "description": "Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`,\n`opus`, or `pcm16`.\n" } } }, "store": { "type": "boolean", "default": false, "nullable": true, "description": "Whether or not to store the output of this chat completion request for\nuse in our [model distillation](/docs/guides/distillation) or\n[evals](/docs/guides/evals) products.\n\nSupports text and image inputs. Note: image inputs over 8MB will be dropped.\n" }, "moderation": { "anyOf": [ { "$ref": "#/components/schemas/ModerationParam", "description": "Configuration for running moderation on the request input and generated output.\n" }, { "type": "null" } ] }, "stream": { "description": "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](/docs/api-reference/chat/streaming)\nfor more information, along with the [streaming responses](/docs/guides/streaming-responses)\nguide for more information on how to handle the streaming events.\n", "type": "boolean", "nullable": true, "default": false }, "stop": { "$ref": "#/components/schemas/StopConfiguration" }, "logit_bias": { "type": "object", "default": null, "nullable": true, "additionalProperties": { "type": "integer" }, "description": "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the\ntokenizer) to an associated bias value from -100 to 100. Mathematically,\nthe bias is added to the logits generated by the model prior to sampling.\nThe exact effect will vary per model, but values between -1 and 1 should\ndecrease or increase likelihood of selection; values like -100 or 100\nshould result in a ban or exclusive selection of the relevant token.\n" }, "logprobs": { "description": "Whether to return log probabilities of the output tokens or not. If true,\nreturns the log probabilities of each output token returned in the\n`content` of `message`.\n", "type": "boolean", "default": false, "nullable": true }, "max_tokens": { "description": "The maximum number of [tokens](/tokenizer) that can be generated in the\nchat completion. This value can be used to control\n[costs](https://openai.com/api/pricing/) for text generated via API.\n\nThis value is now deprecated in favor of `max_completion_tokens`, and is\nnot compatible with [o-series models](/docs/guides/reasoning).\n", "type": "integer", "nullable": true, "deprecated": true, "x-providers": { "openai": { "to": [ "max_completion_tokens" ] }, "gemini": { "to": [ "generationConfig", "maxOutputTokens" ] }, "vertex": { "to": [ "generationConfig", "maxOutputTokens" ] } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "n": { "type": "integer", "minimum": 1, "maximum": 128, "default": 1, "example": 1, "nullable": true, "description": "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs." }, "prediction": { "nullable": true, "description": "Configuration for a [Predicted Output](/docs/guides/predicted-outputs),\nwhich can greatly improve response times when large parts of the model\nresponse are known ahead of time. This is most common when you are\nregenerating a file with only minor changes to most of the content.\n", "oneOf": [ { "$ref": "#/components/schemas/PredictionContent" } ] }, "seed": { "type": "integer", "minimum": -9223372036854776000, "maximum": 9223372036854776000, "nullable": true, "deprecated": true, "description": "This feature is in Beta.\nIf specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n" }, "stream_options": { "$ref": "#/components/schemas/ChatCompletionStreamOptions" }, "tools": { "type": "array", "description": "A list of tools the model may call. You can provide either\n[custom tools](/docs/guides/function-calling#custom-tools) or\n[function tools](/docs/guides/function-calling).\n", "items": { "oneOf": [ { "$ref": "#/components/schemas/ChatCompletionTool" }, { "$ref": "#/components/schemas/CustomToolChatCompletions" } ] }, "x-providers": { "anthropic": { "transform": "openai_tools_to_anthropic_tools" }, "bedrock": { "transform": "openai_tools_to_anthropic_tools" }, "gemini": { "to": [ "tools" ], "transform": "openai_tools_to_gemini_tools" }, "vertex": { "to": [ "tools" ], "transform": "openai_tools_to_gemini_tools" } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "tool_choice": { "$ref": "#/components/schemas/ChatCompletionToolChoiceOption" }, "parallel_tool_calls": { "$ref": "#/components/schemas/ParallelToolCalls" }, "function_call": { "deprecated": true, "description": "Deprecated in favor of `tool_choice`.\n\nControls which (if any) function is called by the model.\n\n`none` means the model will not call a function and instead generates a\nmessage.\n\n`auto` means the model can pick between generating a message or calling a\nfunction.\n\nSpecifying a particular function via `{\"name\": \"my_function\"}` forces the\nmodel to call that function.\n\n`none` is the default when no functions are present. `auto` is the default\nif functions are present.\n", "oneOf": [ { "type": "string", "description": "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.\n", "enum": [ "none", "auto" ] }, { "$ref": "#/components/schemas/ChatCompletionFunctionCallOption" } ] }, "functions": { "deprecated": true, "description": "Deprecated in favor of `tools`.\n\nA list of functions the model may generate JSON inputs for.\n", "type": "array", "minItems": 1, "maxItems": 128, "items": { "$ref": "#/components/schemas/ChatCompletionFunctions" } } }, "required": [ "model", "messages" ] } ], "x-source": { "from": "avs://openai/official", "authority": "official" }, "properties": { "top_k": { "type": "integer", "minimum": 0, "description": "Top-K sampling — only the K highest-probability tokens are\nconsidered. Passed through to Anthropic (pre-Claude-Opus-4.6) /\nGemini / Vertex / Cohere. Ignored by OpenAI / Azure.\n", "x-source": { "from": "gateway", "authority": "derived" }, "x-providers-default": "drop", "x-providers": { "anthropic": {}, "bedrock": {}, "cohere": {}, "gemini": { "to": [ "generationConfig", "topK" ] }, "vertex": { "to": [ "generationConfig", "topK" ] } } } } }, "CreateChatCompletionResponse": { "type": "object", "description": "Represents a chat completion response returned by model, based on the provided input.", "properties": { "id": { "type": "string", "description": "A unique identifier for the chat completion." }, "choices": { "type": "array", "description": "A list of chat completion choices. Can be more than one if `n` is greater than 1.", "items": { "type": "object", "required": [ "finish_reason", "index", "message", "logprobs" ], "properties": { "finish_reason": { "type": "string", "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.\nRead the [Model Spec](https://model-spec.openai.com/2025-12-18.html) for more.\n", "enum": [ "stop", "length", "tool_calls", "content_filter", "function_call" ] }, "index": { "type": "integer", "description": "The index of the choice in the list of choices." }, "message": { "$ref": "#/components/schemas/ChatCompletionResponseMessage" }, "logprobs": { "anyOf": [ { "description": "Log probability information for the choice.", "type": "object", "properties": { "content": { "anyOf": [ { "description": "A list of message content tokens with log probability information.", "type": "array", "items": { "$ref": "#/components/schemas/ChatCompletionTokenLogprob" } }, { "type": "null" } ] }, "refusal": { "anyOf": [ { "description": "A list of message refusal tokens with log probability information.", "type": "array", "items": { "$ref": "#/components/schemas/ChatCompletionTokenLogprob" } }, { "type": "null" } ] } }, "required": [ "content", "refusal" ] }, { "type": "null" } ] } } } }, "created": { "type": "integer", "format": "unixtime", "description": "The Unix timestamp (in seconds) of when the chat completion was created." }, "model": { "type": "string", "description": "The model used for the chat completion." }, "service_tier": { "$ref": "#/components/schemas/ServiceTier" }, "system_fingerprint": { "type": "string", "deprecated": true, "description": "This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n" }, "object": { "type": "string", "description": "The object type, which is always `chat.completion`.", "enum": [ "chat.completion" ] }, "usage": { "$ref": "#/components/schemas/CompletionUsage" }, "moderation": { "anyOf": [ { "$ref": "#/components/schemas/ChatCompletionModeration", "description": "Moderation results for the request input and generated output, if moderated\ncompletions were requested.\n" }, { "type": "null" } ] } }, "required": [ "choices", "created", "id", "model", "object" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateChatCompletionStreamResponse": { "type": "object", "description": "Represents a streamed chunk of a chat completion response returned\nby the model, based on the provided input. \n[Learn more](/docs/guides/streaming-responses).\n", "properties": { "id": { "type": "string", "description": "A unique identifier for the chat completion. Each chunk has the same ID." }, "choices": { "type": "array", "description": "A list of chat completion choices. Can contain more than one elements if `n` is greater than 1. Can also be empty for the\nlast chunk if you set `stream_options: {\"include_usage\": true}`.\n", "items": { "type": "object", "required": [ "delta", "finish_reason", "index" ], "properties": { "delta": { "$ref": "#/components/schemas/ChatCompletionStreamResponseDelta" }, "logprobs": { "description": "Log probability information for the choice.", "type": "object", "nullable": true, "properties": { "content": { "description": "A list of message content tokens with log probability information.", "type": "array", "items": { "$ref": "#/components/schemas/ChatCompletionTokenLogprob" }, "nullable": true }, "refusal": { "description": "A list of message refusal tokens with log probability information.", "type": "array", "items": { "$ref": "#/components/schemas/ChatCompletionTokenLogprob" }, "nullable": true } }, "required": [ "content", "refusal" ] }, "finish_reason": { "type": "string", "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.\n", "enum": [ "stop", "length", "tool_calls", "content_filter", "function_call" ], "nullable": true }, "index": { "type": "integer", "description": "The index of the choice in the list of choices." } } } }, "created": { "type": "integer", "format": "unixtime", "description": "The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp." }, "model": { "type": "string", "description": "The model to generate the completion." }, "service_tier": { "$ref": "#/components/schemas/ServiceTier" }, "system_fingerprint": { "type": "string", "deprecated": true, "description": "This fingerprint represents the backend configuration that the model runs with.\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n" }, "object": { "type": "string", "description": "The object type, which is always `chat.completion.chunk`.", "enum": [ "chat.completion.chunk" ] }, "usage": { "$ref": "#/components/schemas/CompletionUsage", "nullable": true, "description": "An optional field that will only be present when you set\n`stream_options: {\"include_usage\": true}` in your request. When present, it\ncontains a null value **except for the last chunk** which contains the\ntoken usage statistics for the entire request.\n\n**NOTE:** If the stream is interrupted or cancelled, you may not\nreceive the final usage chunk which contains the total token usage for\nthe request.\n" }, "moderation": { "anyOf": [ { "$ref": "#/components/schemas/ChatCompletionModeration", "description": "Moderation results for the request input and generated output. Present\non the moderation chunk when moderated completions are requested.\n" }, { "type": "null" } ] } }, "required": [ "choices", "created", "id", "model", "object" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateCompletionRequest": { "type": "object", "properties": { "model": { "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models) for descriptions of them.\n", "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "gpt-3.5-turbo-instruct", "davinci-002", "babbage-002" ] } ] }, "prompt": { "description": "The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.\n\nNote that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.\n", "default": "<|endoftext|>", "nullable": true, "oneOf": [ { "type": "string", "default": "", "example": "This is a test." }, { "type": "array", "items": { "type": "string", "default": "", "example": "This is a test." } }, { "type": "array", "minItems": 1, "items": { "type": "integer" }, "example": "[1212, 318, 257, 1332, 13]" }, { "type": "array", "minItems": 1, "items": { "type": "array", "minItems": 1, "items": { "type": "integer" } }, "example": "[[1212, 318, 257, 1332, 13]]" } ] }, "best_of": { "type": "integer", "default": 1, "minimum": 0, "maximum": 20, "nullable": true, "description": "Generates `best_of` completions server-side and returns the \"best\" (the one with the highest log probability per token). Results cannot be streamed.\n\nWhen used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.\n" }, "echo": { "type": "boolean", "default": false, "nullable": true, "description": "Echo back the prompt in addition to the completion\n" }, "frequency_penalty": { "type": "number", "default": 0, "minimum": -2, "maximum": 2, "nullable": true, "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.\n\n[See more information about frequency and presence penalties.](/docs/guides/text-generation)\n" }, "logit_bias": { "type": "object", "default": null, "nullable": true, "additionalProperties": { "type": "integer" }, "description": "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.\n\nAs an example, you can pass `{\"50256\": -100}` to prevent the <|endoftext|> token from being generated.\n" }, "logprobs": { "type": "integer", "minimum": 0, "maximum": 5, "default": null, "nullable": true, "description": "Include the log probabilities on the `logprobs` most likely output tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response.\n\nThe maximum value for `logprobs` is 5.\n" }, "max_tokens": { "type": "integer", "minimum": 0, "default": 16, "example": 16, "nullable": true, "description": "The maximum number of [tokens](/tokenizer) that can be generated in the completion.\n\nThe token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.\n" }, "n": { "type": "integer", "minimum": 1, "maximum": 128, "default": 1, "example": 1, "nullable": true, "description": "How many completions to generate for each prompt.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.\n" }, "presence_penalty": { "type": "number", "default": 0, "minimum": -2, "maximum": 2, "nullable": true, "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n\n[See more information about frequency and presence penalties.](/docs/guides/text-generation)\n" }, "seed": { "type": "integer", "format": "int64", "nullable": true, "description": "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n" }, "stop": { "$ref": "#/components/schemas/StopConfiguration" }, "stream": { "description": "Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n", "type": "boolean", "nullable": true, "default": false }, "stream_options": { "$ref": "#/components/schemas/ChatCompletionStreamOptions" }, "suffix": { "description": "The suffix that comes after a completion of inserted text.\n\nThis parameter is only supported for `gpt-3.5-turbo-instruct`.\n", "default": null, "nullable": true, "type": "string", "example": "test." }, "temperature": { "type": "number", "minimum": 0, "maximum": 2, "default": 1, "example": 1, "nullable": true, "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.\n" }, "top_p": { "type": "number", "minimum": 0, "maximum": 1, "default": 1, "example": 1, "nullable": true, "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.\n" }, "user": { "type": "string", "example": "user-1234", "description": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).\n" } }, "required": [ "model", "prompt" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateCompletionResponse": { "type": "object", "description": "Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint).\n", "properties": { "id": { "type": "string", "description": "A unique identifier for the completion." }, "choices": { "type": "array", "description": "The list of completion choices the model generated for the input prompt.", "items": { "type": "object", "required": [ "finish_reason", "index", "logprobs", "text" ], "properties": { "finish_reason": { "type": "string", "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\nor `content_filter` if content was omitted due to a flag from our content filters.\n", "enum": [ "stop", "length", "content_filter" ] }, "index": { "type": "integer" }, "logprobs": { "anyOf": [ { "type": "object", "properties": { "text_offset": { "type": "array", "items": { "type": "integer" } }, "token_logprobs": { "type": "array", "items": { "type": "number" } }, "tokens": { "type": "array", "items": { "type": "string" } }, "top_logprobs": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "number" } } } } }, { "type": "null" } ] }, "text": { "type": "string" } } } }, "created": { "type": "integer", "format": "unixtime", "description": "The Unix timestamp (in seconds) of when the completion was created." }, "model": { "type": "string", "description": "The model used for completion." }, "system_fingerprint": { "type": "string", "description": "This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n" }, "object": { "type": "string", "description": "The object type, which is always \"text_completion\"", "enum": [ "text_completion" ] }, "usage": { "$ref": "#/components/schemas/CompletionUsage" } }, "required": [ "id", "object", "created", "model", "choices" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateEmbeddingRequest": { "type": "object", "additionalProperties": false, "properties": { "input": { "description": "Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for all embedding models), cannot be an empty string, and any array must be 2048 dimensions or less. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. In addition to the per-input token limit, all embedding models enforce a maximum of 300,000 tokens summed across all inputs in a single request.\n", "example": "The quick brown fox jumped over the lazy dog", "oneOf": [ { "type": "string", "title": "string", "description": "The string that will be turned into an embedding.", "default": "", "example": "This is a test." }, { "type": "array", "title": "array", "description": "The array of strings that will be turned into an embedding.", "minItems": 1, "maxItems": 2048, "items": { "type": "string", "default": "", "example": "['This is a test.']" } }, { "type": "array", "title": "array", "description": "The array of integers that will be turned into an embedding.", "minItems": 1, "maxItems": 2048, "items": { "type": "integer" }, "example": "[1212, 318, 257, 1332, 13]" }, { "type": "array", "title": "array", "description": "The array of arrays containing integers that will be turned into an embedding.", "minItems": 1, "maxItems": 2048, "items": { "type": "array", "minItems": 1, "items": { "type": "integer" } }, "example": "[[1212, 318, 257, 1332, 13]]" } ] }, "model": { "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models) for descriptions of them.\n", "example": "text-embedding-3-small", "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "text-embedding-ada-002", "text-embedding-3-small", "text-embedding-3-large" ] } ] }, "encoding_format": { "description": "The format to return the embeddings in. Can be either `float` or [`base64`](https://pypi.org/project/pybase64/).", "example": "float", "default": "float", "type": "string", "enum": [ "float", "base64" ] }, "dimensions": { "description": "The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.\n", "type": "integer", "minimum": 1 }, "user": { "type": "string", "example": "user-1234", "description": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).\n" } }, "required": [ "model", "input" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateEmbeddingResponse": { "type": "object", "properties": { "data": { "type": "array", "description": "The list of embeddings generated by the model.", "items": { "$ref": "#/components/schemas/Embedding" } }, "model": { "type": "string", "description": "The name of the model used to generate the embedding." }, "object": { "type": "string", "description": "The object type, which is always \"list\".", "enum": [ "list" ] }, "usage": { "type": "object", "description": "The usage information for the request.", "properties": { "prompt_tokens": { "type": "integer", "description": "The number of tokens used by the prompt." }, "total_tokens": { "type": "integer", "description": "The total number of tokens used by the request." } }, "required": [ "prompt_tokens", "total_tokens" ] } }, "required": [ "object", "model", "data", "usage" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateImageRequest": { "type": "object", "properties": { "prompt": { "description": "A text description of the desired image(s). The maximum length is 32000 characters for the GPT image models, 1000 characters for `dall-e-2` and 4000 characters for `dall-e-3`.", "type": "string", "example": "A cute baby sea otter", "x-providers-default": "drop", "x-providers": { "openai": {}, "azure": {} }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "model": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "gpt-image-1.5", "dall-e-2", "dall-e-3", "gpt-image-1", "gpt-image-1-mini" ] } ], "default": "dall-e-2", "example": "gpt-image-1.5", "nullable": true, "description": "The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or a GPT image model (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`). Defaults to `dall-e-2` unless a parameter specific to the GPT image models is used.", "x-providers-default": "drop", "x-providers": { "openai": {}, "azure": {} }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "n": { "type": "integer", "minimum": 1, "maximum": 10, "default": 1, "example": 1, "nullable": true, "description": "The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported.", "x-providers-default": "drop", "x-providers": { "openai": {}, "azure": {} }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "quality": { "type": "string", "enum": [ "standard", "hd", "low", "medium", "high", "auto" ], "default": "auto", "example": "medium", "nullable": true, "description": "The quality of the image that will be generated.\n\n- `auto` (default value) will automatically select the best quality for the given model.\n- `high`, `medium` and `low` are supported for the GPT image models.\n- `hd` and `standard` are supported for `dall-e-3`.\n- `standard` is the only option for `dall-e-2`.\n", "x-providers-default": "drop", "x-providers": { "openai": {}, "azure": {} }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "response_format": { "type": "string", "enum": [ "url", "b64_json" ], "default": "url", "example": "url", "nullable": true, "description": "The format in which generated images with `dall-e-2` and `dall-e-3` are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated. This parameter isn't supported for the GPT image models, which always return base64-encoded images.", "x-providers-default": "drop", "x-providers": { "openai": {}, "azure": {} }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "output_format": { "type": "string", "enum": [ "png", "jpeg", "webp" ], "default": "png", "example": "png", "nullable": true, "description": "The format in which the generated images are returned. This parameter is only supported for the GPT image models. Must be one of `png`, `jpeg`, or `webp`.", "x-providers-default": "drop", "x-providers": { "openai": {}, "azure": {} }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "output_compression": { "type": "integer", "default": 100, "example": 100, "nullable": true, "description": "The compression level (0-100%) for the generated images. This parameter is only supported for the GPT image models with the `webp` or `jpeg` output formats, and defaults to 100.", "x-providers-default": "drop", "x-providers": { "openai": {}, "azure": {} }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "stream": { "type": "boolean", "default": false, "example": false, "nullable": true, "description": "Generate the image in streaming mode. Defaults to `false`. See the\n[Image generation guide](/docs/guides/image-generation) for more information.\nThis parameter is only supported for the GPT image models.\n", "x-providers-default": "drop", "x-providers": { "openai": {}, "azure": {} }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "partial_images": { "$ref": "#/components/schemas/PartialImages", "x-providers-default": "drop", "x-providers": { "openai": {}, "azure": {} }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "size": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "auto", "1024x1024", "1536x1024", "1024x1536", "256x256", "512x512", "1792x1024", "1024x1792" ] } ], "default": "auto", "example": "1024x1024", "nullable": true, "description": "The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.", "x-providers-default": "drop", "x-providers": { "openai": {}, "azure": {} }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "moderation": { "type": "string", "enum": [ "low", "auto" ], "default": "auto", "example": "low", "nullable": true, "description": "Control the content-moderation level for images generated by the GPT image models. Must be either `low` for less restrictive filtering or `auto` (default value).", "x-providers-default": "drop", "x-providers": { "openai": {}, "azure": {} }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "background": { "type": "string", "enum": [ "transparent", "opaque", "auto" ], "default": "auto", "example": "transparent", "nullable": true, "description": "Allows to set transparency for the background of the generated image(s).\nThis parameter is only supported for the GPT image models. Must be one of\n`transparent`, `opaque` or `auto` (default value). When `auto` is used, the\nmodel will automatically determine the best background for the image.\n\nIf `transparent`, the output format needs to support transparency, so it\nshould be set to either `png` (default value) or `webp`.\n", "x-providers-default": "drop", "x-providers": { "openai": {}, "azure": {} }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "style": { "type": "string", "enum": [ "vivid", "natural" ], "default": "vivid", "example": "vivid", "nullable": true, "description": "The style of the generated images. This parameter is only supported for `dall-e-3`. Must be one of `vivid` or `natural`. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images.", "x-providers-default": "drop", "x-providers": { "openai": {}, "azure": {} }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "user": { "type": "string", "example": "user-1234", "description": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).\n", "x-providers-default": "drop", "x-providers": { "openai": {}, "azure": {} }, "x-source": { "from": "avs://openai/official", "authority": "official" } } }, "required": [ "prompt" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateModelResponseProperties": { "allOf": [ { "$ref": "#/components/schemas/ModelResponseProperties" }, { "type": "object", "properties": { "prompt_cache_options": { "$ref": "#/components/schemas/PromptCacheOptionsParam" }, "top_logprobs": { "description": "An integer between 0 and 20 specifying the maximum number of most likely\ntokens to return at each token position, each with an associated log\nprobability. In some cases, the number of returned tokens may be fewer than\nrequested.\n", "type": "integer", "minimum": 0, "maximum": 20 } } } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateModerationRequest": { "type": "object", "properties": { "input": { "description": "Input (or inputs) to classify. Can be a single string, an array of strings, or\nan array of multi-modal input objects similar to other models.\n", "oneOf": [ { "type": "string", "description": "A string of text to classify for moderation.", "default": "", "example": "I want to kill them." }, { "type": "array", "description": "An array of strings to classify for moderation.", "items": { "type": "string", "default": "", "example": "I want to kill them." } }, { "type": "array", "description": "An array of multi-modal inputs to the moderation model.", "items": { "oneOf": [ { "type": "object", "description": "An object describing an image to classify.", "properties": { "type": { "description": "Always `image_url`.", "type": "string", "enum": [ "image_url" ] }, "image_url": { "type": "object", "description": "Contains either an image URL or a data URL for a base64 encoded image.", "properties": { "url": { "type": "string", "description": "Either a URL of the image or the base64 encoded image data.", "format": "uri", "example": "https://example.com/image.jpg" } }, "required": [ "url" ] } }, "required": [ "type", "image_url" ] }, { "type": "object", "description": "An object describing text to classify.", "properties": { "type": { "description": "Always `text`.", "type": "string", "enum": [ "text" ] }, "text": { "description": "A string of text to classify.", "type": "string", "example": "I want to kill them" } }, "required": [ "type", "text" ] } ] } } ] }, "model": { "description": "The content moderation model you would like to use. Learn more in\n[the moderation guide](/docs/guides/moderation), and learn about\navailable models [here](/docs/models#moderation).\n", "nullable": false, "default": "omni-moderation-latest", "example": "omni-moderation-2024-09-26", "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "omni-moderation-latest", "omni-moderation-2024-09-26", "text-moderation-latest", "text-moderation-stable" ] } ] } }, "required": [ "input" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateModerationResponse": { "type": "object", "description": "Represents if a given text input is potentially harmful.", "properties": { "id": { "type": "string", "description": "The unique identifier for the moderation request." }, "model": { "type": "string", "description": "The model used to generate the moderation results." }, "results": { "type": "array", "description": "A list of moderation objects.", "items": { "type": "object", "properties": { "flagged": { "type": "boolean", "description": "Whether any of the below categories are flagged." }, "categories": { "type": "object", "description": "A list of the categories, and whether they are flagged or not.", "properties": { "hate": { "type": "boolean", "description": "Content that expresses, incites, or promotes hate based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste. Hateful content aimed at non-protected groups (e.g., chess players) is harassment." }, "hate/threatening": { "type": "boolean", "description": "Hateful content that also includes violence or serious harm towards the targeted group based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste." }, "harassment": { "type": "boolean", "description": "Content that expresses, incites, or promotes harassing language towards any target." }, "harassment/threatening": { "type": "boolean", "description": "Harassment content that also includes violence or serious harm towards any target." }, "illicit": { "anyOf": [ { "type": "boolean", "description": "Content that includes instructions or advice that facilitate the planning or execution of wrongdoing, or that gives advice or instruction on how to commit illicit acts. For example, \"how to shoplift\" would fit this category." }, { "type": "null" } ] }, "illicit/violent": { "anyOf": [ { "type": "boolean", "description": "Content that includes instructions or advice that facilitate the planning or execution of wrongdoing that also includes violence, or that gives advice or instruction on the procurement of any weapon." }, { "type": "null" } ] }, "self-harm": { "type": "boolean", "description": "Content that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting, and eating disorders." }, "self-harm/intent": { "type": "boolean", "description": "Content where the speaker expresses that they are engaging or intend to engage in acts of self-harm, such as suicide, cutting, and eating disorders." }, "self-harm/instructions": { "type": "boolean", "description": "Content that encourages performing acts of self-harm, such as suicide, cutting, and eating disorders, or that gives instructions or advice on how to commit such acts." }, "sexual": { "type": "boolean", "description": "Content meant to arouse sexual excitement, such as the description of sexual activity, or that promotes sexual services (excluding sex education and wellness)." }, "sexual/minors": { "type": "boolean", "description": "Sexual content that includes an individual who is under 18 years old." }, "violence": { "type": "boolean", "description": "Content that depicts death, violence, or physical injury." }, "violence/graphic": { "type": "boolean", "description": "Content that depicts death, violence, or physical injury in graphic detail." } }, "required": [ "hate", "hate/threatening", "harassment", "harassment/threatening", "illicit", "illicit/violent", "self-harm", "self-harm/intent", "self-harm/instructions", "sexual", "sexual/minors", "violence", "violence/graphic" ] }, "category_scores": { "type": "object", "description": "A list of the categories along with their scores as predicted by model.", "properties": { "hate": { "type": "number", "description": "The score for the category 'hate'." }, "hate/threatening": { "type": "number", "description": "The score for the category 'hate/threatening'." }, "harassment": { "type": "number", "description": "The score for the category 'harassment'." }, "harassment/threatening": { "type": "number", "description": "The score for the category 'harassment/threatening'." }, "illicit": { "type": "number", "description": "The score for the category 'illicit'." }, "illicit/violent": { "type": "number", "description": "The score for the category 'illicit/violent'." }, "self-harm": { "type": "number", "description": "The score for the category 'self-harm'." }, "self-harm/intent": { "type": "number", "description": "The score for the category 'self-harm/intent'." }, "self-harm/instructions": { "type": "number", "description": "The score for the category 'self-harm/instructions'." }, "sexual": { "type": "number", "description": "The score for the category 'sexual'." }, "sexual/minors": { "type": "number", "description": "The score for the category 'sexual/minors'." }, "violence": { "type": "number", "description": "The score for the category 'violence'." }, "violence/graphic": { "type": "number", "description": "The score for the category 'violence/graphic'." } }, "required": [ "hate", "hate/threatening", "harassment", "harassment/threatening", "illicit", "illicit/violent", "self-harm", "self-harm/intent", "self-harm/instructions", "sexual", "sexual/minors", "violence", "violence/graphic" ] }, "category_applied_input_types": { "type": "object", "description": "A list of the categories along with the input type(s) that the score applies to.", "properties": { "hate": { "type": "array", "description": "The applied input type(s) for the category 'hate'.", "items": { "type": "string", "enum": [ "text" ] } }, "hate/threatening": { "type": "array", "description": "The applied input type(s) for the category 'hate/threatening'.", "items": { "type": "string", "enum": [ "text" ] } }, "harassment": { "type": "array", "description": "The applied input type(s) for the category 'harassment'.", "items": { "type": "string", "enum": [ "text" ] } }, "harassment/threatening": { "type": "array", "description": "The applied input type(s) for the category 'harassment/threatening'.", "items": { "type": "string", "enum": [ "text" ] } }, "illicit": { "type": "array", "description": "The applied input type(s) for the category 'illicit'.", "items": { "type": "string", "enum": [ "text" ] } }, "illicit/violent": { "type": "array", "description": "The applied input type(s) for the category 'illicit/violent'.", "items": { "type": "string", "enum": [ "text" ] } }, "self-harm": { "type": "array", "description": "The applied input type(s) for the category 'self-harm'.", "items": { "type": "string", "enum": [ "text", "image" ] } }, "self-harm/intent": { "type": "array", "description": "The applied input type(s) for the category 'self-harm/intent'.", "items": { "type": "string", "enum": [ "text", "image" ] } }, "self-harm/instructions": { "type": "array", "description": "The applied input type(s) for the category 'self-harm/instructions'.", "items": { "type": "string", "enum": [ "text", "image" ] } }, "sexual": { "type": "array", "description": "The applied input type(s) for the category 'sexual'.", "items": { "type": "string", "enum": [ "text", "image" ] } }, "sexual/minors": { "type": "array", "description": "The applied input type(s) for the category 'sexual/minors'.", "items": { "type": "string", "enum": [ "text" ] } }, "violence": { "type": "array", "description": "The applied input type(s) for the category 'violence'.", "items": { "type": "string", "enum": [ "text", "image" ] } }, "violence/graphic": { "type": "array", "description": "The applied input type(s) for the category 'violence/graphic'.", "items": { "type": "string", "enum": [ "text", "image" ] } } }, "required": [ "hate", "hate/threatening", "harassment", "harassment/threatening", "illicit", "illicit/violent", "self-harm", "self-harm/intent", "self-harm/instructions", "sexual", "sexual/minors", "violence", "violence/graphic" ] } }, "required": [ "flagged", "categories", "category_scores", "category_applied_input_types" ] } } }, "required": [ "id", "model", "results" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateResponse": { "allOf": [ { "$ref": "#/components/schemas/CreateModelResponseProperties" }, { "$ref": "#/components/schemas/ResponseProperties" }, { "type": "object", "properties": { "truncation": { "deprecated": true, "anyOf": [ { "type": "string", "description": "The truncation strategy to use for the model response.\n- `auto`: If the input to this Response exceeds\n the model's context window size, the model will truncate the\n response to fit the context window by dropping items from the beginning of the conversation.\n- `disabled` (default): If the input size will exceed the context window\n size for a model, the request will fail with a 400 error.\n", "enum": [ "auto", "disabled" ], "default": "disabled" }, { "type": "null" } ] }, "reasoning": { "anyOf": [ { "$ref": "#/components/schemas/Reasoning" }, { "type": "null" } ] }, "input": { "$ref": "#/components/schemas/InputParam" }, "include": { "anyOf": [ { "type": "array", "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program).", "items": { "$ref": "#/components/schemas/IncludeEnum" } }, { "type": "null" } ] }, "parallel_tool_calls": { "anyOf": [ { "type": "boolean", "description": "Whether to allow the model to run tool calls in parallel.\n", "default": true }, { "type": "null" } ] }, "store": { "anyOf": [ { "type": "boolean", "description": "Whether to store the generated model response for later retrieval via\nAPI.\n", "default": true }, { "type": "null" } ] }, "instructions": { "anyOf": [ { "type": "string", "description": "A system (or developer) message inserted into the model's context.\n\nWhen using along with `previous_response_id`, the instructions from a previous\nresponse will not be carried over to the next response. This makes it simple\nto swap out system (or developer) messages in new responses.\n" }, { "type": "null" } ] }, "moderation": { "anyOf": [ { "$ref": "#/components/schemas/ModerationParam", "description": "Configuration for running moderation on the input and output of this response.\n" }, { "type": "null" } ] }, "stream": { "anyOf": [ { "description": "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section below](/docs/api-reference/responses-streaming)\nfor more information.\n", "type": "boolean", "default": false }, { "type": "null" } ] }, "stream_options": { "$ref": "#/components/schemas/ResponseStreamOptions" }, "conversation": { "anyOf": [ { "$ref": "#/components/schemas/ConversationParam" }, { "type": "null" } ] }, "context_management": { "anyOf": [ { "type": "array", "description": "Context management configuration for this request.\n", "minItems": 1, "items": { "$ref": "#/components/schemas/ContextManagementParam" } }, { "type": "null" } ] }, "max_output_tokens": { "anyOf": [ { "description": "An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).\n", "type": "integer", "minimum": 16 }, { "type": "null" } ] } } } ], "x-source": { "from": "avs://openai/official", "authority": "official" }, "properties": { "top_k": { "type": "integer", "minimum": 0, "description": "Top-K sampling — only the K highest-probability tokens are\nconsidered. Passed through to Anthropic (pre-Claude-Opus-4.6) /\nGemini / Vertex / Cohere. Ignored by OpenAI / Azure.\n", "x-source": { "from": "gateway", "authority": "derived" }, "x-providers-default": "drop", "x-providers": { "anthropic": {}, "bedrock": {}, "cohere": {}, "gemini": { "to": [ "generationConfig", "topK" ] }, "vertex": { "to": [ "generationConfig", "topK" ] } } } } }, "CreateSpeechRequest": { "type": "object", "additionalProperties": false, "properties": { "model": { "description": "One of the available [TTS models](/docs/models#tts): `tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`, or `gpt-4o-mini-tts-2025-12-15`.\n", "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "tts-1", "tts-1-hd", "gpt-4o-mini-tts", "gpt-4o-mini-tts-2025-12-15" ] } ] }, "input": { "type": "string", "description": "The text to generate audio for. The maximum length is 4096 characters.", "maxLength": 4096 }, "instructions": { "type": "string", "description": "Control the voice of your generated audio with additional instructions. Does not work with `tts-1` or `tts-1-hd`.", "maxLength": 4096 }, "voice": { "description": "The voice to use when generating the audio. Supported built-in voices are `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice object with an `id`, for example `{ \"id\": \"voice_1234\" }`. Previews of the voices are available in the [Text to speech guide](/docs/guides/text-to-speech#voice-options).", "$ref": "#/components/schemas/VoiceIdsOrCustomVoice" }, "response_format": { "description": "The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav`, and `pcm`.", "default": "mp3", "type": "string", "enum": [ "mp3", "opus", "aac", "flac", "wav", "pcm" ] }, "speed": { "description": "The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is the default.", "type": "number", "default": 1, "minimum": 0.25, "maximum": 4 }, "stream_format": { "description": "The format to stream the audio in. Supported formats are `sse` and `audio`. `sse` is not supported for `tts-1` or `tts-1-hd`.", "type": "string", "default": "audio", "enum": [ "sse", "audio" ] } }, "required": [ "model", "input", "voice" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateSpeechResponseStreamEvent": { "anyOf": [ { "$ref": "#/components/schemas/SpeechAudioDeltaEvent" }, { "$ref": "#/components/schemas/SpeechAudioDoneEvent" } ], "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateTranscriptionRequest": { "type": "object", "additionalProperties": false, "properties": { "file": { "description": "The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.\n", "type": "string", "format": "binary" }, "model": { "description": "ID of the model to use. The options are `gpt-transcribe`, `gpt-4o-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `whisper-1` (which is powered by our open source Whisper V2 model), and `gpt-4o-transcribe-diarize`.\n", "example": "gpt-4o-transcribe", "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "whisper-1", "gpt-transcribe", "gpt-4o-transcribe", "gpt-4o-mini-transcribe", "gpt-4o-mini-transcribe-2025-12-15", "gpt-4o-transcribe-diarize" ] } ] }, "language": { "description": "The language of the input audio. Supplying the input language in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format will improve accuracy and latency.\n", "type": "string" }, "languages": { "description": "Possible languages of the input audio, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Supported by `gpt-transcribe`.\n", "type": "array", "minItems": 1, "items": { "type": "string" } }, "keywords": { "description": "Words or phrases to guide transcription of the input audio. Supported by `gpt-transcribe`.\n", "type": "array", "items": { "type": "string" } }, "prompt": { "description": "An optional text to guide the model's style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text#prompting) should match the audio language. This field is not supported when using `gpt-4o-transcribe-diarize`.\n", "type": "string" }, "response_format": { "$ref": "#/components/schemas/AudioResponseFormat" }, "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. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit.\n", "type": "number", "default": 0 }, "include": { "description": "Additional information to include in the transcription response.\n`logprobs` will return the log probabilities of the tokens in the\nresponse to understand the model's confidence in the transcription.\n`logprobs` only works with response_format set to `json` and only with\nthe models `gpt-4o-transcribe`, `gpt-4o-mini-transcribe`, and `gpt-4o-mini-transcribe-2025-12-15`. This field is not supported when using `gpt-4o-transcribe-diarize`.\n", "type": "array", "items": { "$ref": "#/components/schemas/TranscriptionInclude" } }, "timestamp_granularities": { "description": "The timestamp granularities to populate for this transcription. `response_format` must be set `verbose_json` to use timestamp granularities. Either or both of these options are supported: `word`, or `segment`. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.\nThis option is not available for `gpt-4o-transcribe-diarize`.\n", "type": "array", "items": { "type": "string", "enum": [ "word", "segment" ] }, "default": [ "segment" ] }, "stream": { "anyOf": [ { "description": "If set to true, the model response data will be streamed to the client\nas it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).\nSee the [Streaming section of the Speech-to-Text guide](/docs/guides/speech-to-text?lang=curl#streaming-transcriptions)\nfor more information.\n\nNote: Streaming is not supported for the `whisper-1` model and will be ignored.\n", "type": "boolean", "default": false }, { "type": "null" } ] }, "chunking_strategy": { "anyOf": [ { "description": "Controls how the audio is cut into chunks. When set to `\"auto\"`, the server first normalizes loudness and then uses voice activity detection (VAD) to choose boundaries. `server_vad` object can be provided to tweak VAD detection parameters manually. If unset, the audio is transcribed as a single block. Required when using `gpt-4o-transcribe-diarize` for inputs longer than 30 seconds. ", "anyOf": [ { "type": "string", "enum": [ "auto" ], "default": "auto", "description": "Automatically set chunking parameters based on the audio. Must be set to `\"auto\"`.\n" }, { "$ref": "#/components/schemas/VadConfig" } ] }, { "type": "null" } ] }, "known_speaker_names": { "description": "Optional list of speaker names that correspond to the audio samples provided in `known_speaker_references[]`. Each entry should be a short identifier (for example `customer` or `agent`). Up to 4 speakers are supported.\n", "type": "array", "maxItems": 4, "items": { "type": "string" } }, "known_speaker_references": { "description": "Optional list of audio samples (as [data URLs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs)) that contain known speaker references matching `known_speaker_names[]`. Each sample must be between 2 and 10 seconds, and can use any of the same input audio formats supported by `file`.\n", "type": "array", "maxItems": 4, "items": { "type": "string" } } }, "required": [ "file", "model" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateTranscriptionResponseDiarizedJson": { "type": "object", "description": "Represents a diarized transcription response returned by the model, including the combined transcript and speaker-segment annotations.\n", "properties": { "task": { "type": "string", "description": "The type of task that was run. Always `transcribe`.", "enum": [ "transcribe" ] }, "duration": { "type": "number", "format": "double", "description": "Duration of the input audio in seconds." }, "text": { "type": "string", "description": "The concatenated transcript text for the entire audio input." }, "segments": { "type": "array", "description": "Segments of the transcript annotated with timestamps and speaker labels.", "items": { "$ref": "#/components/schemas/TranscriptionDiarizedSegment" } }, "usage": { "type": "object", "description": "Token or duration usage statistics for the request.", "oneOf": [ { "$ref": "#/components/schemas/TranscriptTextUsageTokens", "title": "Token Usage" }, { "$ref": "#/components/schemas/TranscriptTextUsageDuration", "title": "Duration Usage" } ], "discriminator": { "propertyName": "type" } } }, "required": [ "task", "duration", "text", "segments" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateTranscriptionResponseJson": { "type": "object", "description": "Represents a transcription response returned by model, based on the provided input.", "properties": { "text": { "type": "string", "description": "The transcribed text." }, "languages": { "type": "array", "description": "The languages detected in the audio. Returned by `gpt-transcribe`. An empty array indicates that no language could be reliably detected.\n", "items": { "$ref": "#/components/schemas/TranscriptionLanguage" } }, "logprobs": { "type": "array", "optional": true, "description": "The log probabilities of the tokens in the transcription. Only returned with the models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe` if `logprobs` is added to the `include` array.\n", "items": { "type": "object", "properties": { "token": { "type": "string", "description": "The token in the transcription." }, "logprob": { "type": "number", "description": "The log probability of the token." }, "bytes": { "type": "array", "items": { "type": "number" }, "description": "The bytes of the token." } } } }, "usage": { "type": "object", "description": "Token usage statistics for the request.", "oneOf": [ { "$ref": "#/components/schemas/TranscriptTextUsageTokens", "title": "Token Usage" }, { "$ref": "#/components/schemas/TranscriptTextUsageDuration", "title": "Duration Usage" } ] } }, "required": [ "text" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateTranscriptionResponseStreamEvent": { "anyOf": [ { "$ref": "#/components/schemas/TranscriptTextSegmentEvent" }, { "$ref": "#/components/schemas/TranscriptTextDeltaEvent" }, { "$ref": "#/components/schemas/TranscriptTextDoneEvent" } ], "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateTranscriptionResponseVerboseJson": { "type": "object", "description": "Represents a verbose json transcription response returned by model, based on the provided input.", "properties": { "language": { "type": "string", "description": "The language of the input audio." }, "duration": { "type": "number", "format": "double", "description": "The duration of the input audio." }, "text": { "type": "string", "description": "The transcribed text." }, "words": { "type": "array", "description": "Extracted words and their corresponding timestamps.", "items": { "$ref": "#/components/schemas/TranscriptionWord" } }, "segments": { "type": "array", "description": "Segments of the transcribed text and their corresponding details.", "items": { "$ref": "#/components/schemas/TranscriptionSegment" } }, "usage": { "$ref": "#/components/schemas/TranscriptTextUsageDuration" } }, "required": [ "language", "duration", "text" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateTranslationRequest": { "type": "object", "additionalProperties": false, "properties": { "file": { "description": "The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.\n", "type": "string", "format": "binary" }, "model": { "description": "ID of the model to use. Only `whisper-1` (which is powered by our open source Whisper V2 model) is currently available.\n", "example": "whisper-1", "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "whisper-1" ] } ] }, "prompt": { "description": "An optional text to guide the model's style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text#prompting) should be in English.\n", "type": "string" }, "response_format": { "description": "The format of the output, in one of these options: `json`, `text`, `srt`, `verbose_json`, or `vtt`.\n", "type": "string", "enum": [ "json", "text", "srt", "verbose_json", "vtt" ], "default": "json" }, "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. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit.\n", "type": "number", "default": 0 } }, "required": [ "file", "model" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateTranslationResponseJson": { "type": "object", "properties": { "text": { "type": "string" } }, "required": [ "text" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateTranslationResponseVerboseJson": { "type": "object", "properties": { "language": { "type": "string", "description": "The language of the output translation (always `english`)." }, "duration": { "type": "number", "format": "double", "description": "The duration of the input audio." }, "text": { "type": "string", "description": "The translated text." }, "segments": { "type": "array", "description": "Segments of the translated text and their corresponding details.", "items": { "$ref": "#/components/schemas/TranscriptionSegment" } } }, "required": [ "language", "duration", "text" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CustomToolCall": { "type": "object", "title": "Custom tool call", "description": "A call to a custom tool created by the model.\n", "properties": { "type": { "type": "string", "enum": [ "custom_tool_call" ], "description": "The type of the custom tool call. Always `custom_tool_call`.\n" }, "id": { "type": "string", "description": "The unique ID of the custom tool call in the OpenAI platform.\n" }, "call_id": { "type": "string", "description": "An identifier used to map this custom tool call to a tool call output.\n" }, "caller": { "anyOf": [ { "$ref": "#/components/schemas/ToolCallCaller" }, { "type": "null" } ] }, "namespace": { "type": "string", "description": "The namespace of the custom tool being called.\n" }, "name": { "type": "string", "description": "The name of the custom tool being called.\n" }, "input": { "type": "string", "description": "The input for the custom tool call generated by the model.\n" } }, "required": [ "type", "call_id", "name", "input" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CustomToolCallOutput": { "type": "object", "title": "Custom tool call output", "description": "The output of a custom tool call from your code, being sent back to the model.\n", "properties": { "type": { "type": "string", "enum": [ "custom_tool_call_output" ], "description": "The type of the custom tool call output. Always `custom_tool_call_output`.\n" }, "id": { "type": "string", "description": "The unique ID of the custom tool call output in the OpenAI platform.\n" }, "call_id": { "type": "string", "description": "The call ID, used to map this custom tool call output to a custom tool call.\n" }, "caller": { "anyOf": [ { "$ref": "#/components/schemas/ToolCallCallerParam" }, { "type": "null" } ] }, "output": { "description": "The output from the custom tool call generated by your code.\nCan be a string or an list of output content.\n", "oneOf": [ { "type": "string", "description": "A string of the output of the custom tool call.\n", "title": "string output" }, { "type": "array", "items": { "$ref": "#/components/schemas/FunctionAndCustomToolCallOutput" }, "title": "output content list", "description": "Text, image, or file output of the custom tool call.\n" } ] } }, "required": [ "type", "call_id", "output" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CustomToolCallOutputResource": { "title": "ResponseCustomToolCallOutputItem", "allOf": [ { "$ref": "#/components/schemas/CustomToolCallOutput" }, { "type": "object", "properties": { "id": { "type": "string", "description": "The unique ID of the custom tool call output item.\n" }, "status": { "description": "The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n", "$ref": "#/components/schemas/FunctionCallOutputStatusEnum" }, "created_by": { "type": "string", "description": "The identifier of the actor that created the item.\n" } }, "required": [ "id", "status" ] } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CustomToolChatCompletions": { "type": "object", "title": "Custom tool", "description": "A custom tool that processes input using a specified format.\n", "properties": { "type": { "type": "string", "enum": [ "custom" ], "description": "The type of the custom tool. Always `custom`." }, "custom": { "type": "object", "title": "Custom tool properties", "description": "Properties of the custom tool.\n", "properties": { "name": { "type": "string", "description": "The name of the custom tool, used to identify it in tool calls." }, "description": { "type": "string", "description": "Optional description of the custom tool, used to provide more context.\n" }, "format": { "description": "The input format for the custom tool. Default is unconstrained text.\n", "oneOf": [ { "type": "object", "title": "Text format", "description": "Unconstrained free-form text.", "properties": { "type": { "type": "string", "enum": [ "text" ], "description": "Unconstrained text format. Always `text`." } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "title": "Grammar format", "description": "A grammar defined by the user.", "properties": { "type": { "type": "string", "enum": [ "grammar" ], "description": "Grammar format. Always `grammar`." }, "grammar": { "type": "object", "title": "Grammar format", "description": "Your chosen grammar.", "properties": { "definition": { "type": "string", "description": "The grammar definition." }, "syntax": { "type": "string", "description": "The syntax of the grammar definition. One of `lark` or `regex`.", "enum": [ "lark", "regex" ] } }, "required": [ "definition", "syntax" ] } }, "required": [ "type", "grammar" ], "additionalProperties": false } ] } }, "required": [ "name" ] } }, "required": [ "type", "custom" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "EasyInputMessage": { "type": "object", "title": "Input message", "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role. Messages with the\n`assistant` role are presumed to have been generated by the model in previous\ninteractions.\n", "properties": { "role": { "type": "string", "description": "The role of the message input. One of `user`, `assistant`, `system`, or\n`developer`.\n", "enum": [ "user", "assistant", "system", "developer" ] }, "content": { "description": "Text, image, or audio input to the model, used to generate a response.\nCan also contain previous assistant responses.\n", "oneOf": [ { "type": "string", "title": "Text input", "description": "A text input to the model.\n" }, { "$ref": "#/components/schemas/InputMessageContentList" } ] }, "phase": { "anyOf": [ { "$ref": "#/components/schemas/MessagePhase" }, { "type": "null" } ] }, "type": { "type": "string", "description": "The type of the message input. Always `message`.\n", "enum": [ "message" ] } }, "required": [ "role", "content" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "Embedding": { "type": "object", "description": "Represents an embedding vector returned by embedding endpoint.\n", "properties": { "index": { "type": "integer", "description": "The index of the embedding in the list of embeddings." }, "embedding": { "type": "array", "description": "The embedding vector, which is a list of floats. The length of vector depends on the model as listed in the [embedding guide](/docs/guides/embeddings).\n", "items": { "type": "number", "format": "float" } }, "object": { "type": "string", "description": "The object type, which is always \"embedding\".", "enum": [ "embedding" ] } }, "required": [ "index", "object", "embedding" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FilePath": { "type": "object", "title": "File path", "description": "A path to a file.\n", "properties": { "type": { "type": "string", "description": "The type of the file path. Always `file_path`.\n", "enum": [ "file_path" ] }, "file_id": { "type": "string", "description": "The ID of the file.\n" }, "index": { "type": "integer", "description": "The index of the file in the list of files.\n" } }, "required": [ "type", "file_id", "index" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FileSearchToolCall": { "type": "object", "title": "File search tool call", "description": "The results of a file search tool call. See the\n[file search guide](/docs/guides/tools-file-search) for more information.\n", "properties": { "id": { "type": "string", "description": "The unique ID of the file search tool call.\n" }, "type": { "type": "string", "enum": [ "file_search_call" ], "description": "The type of the file search tool call. Always `file_search_call`.\n" }, "status": { "type": "string", "description": "The status of the file search tool call. One of `in_progress`,\n`searching`, `incomplete` or `failed`,\n", "enum": [ "in_progress", "searching", "completed", "incomplete", "failed" ] }, "queries": { "type": "array", "items": { "type": "string" }, "description": "The queries used to search for files.\n" }, "results": { "anyOf": [ { "type": "array", "description": "The results of the file search tool call.\n", "items": { "type": "object", "properties": { "file_id": { "type": "string", "description": "The unique ID of the file.\n" }, "text": { "type": "string", "description": "The text that was retrieved from the file.\n" }, "filename": { "type": "string", "description": "The name of the file.\n" }, "attributes": { "$ref": "#/components/schemas/VectorStoreFileAttributes" }, "score": { "type": "number", "format": "float", "description": "The relevance score of the file - a value between 0 and 1.\n" } } } }, { "type": "null" } ] } }, "required": [ "id", "type", "status", "queries" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionAndCustomToolCallOutput": { "oneOf": [ { "$ref": "#/components/schemas/InputTextContent" }, { "$ref": "#/components/schemas/InputImageContent" }, { "$ref": "#/components/schemas/InputFileContent" } ], "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionObject": { "type": "object", "properties": { "description": { "type": "string", "description": "A description of what the function does, used by the model to choose when and how to call the function." }, "name": { "type": "string", "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." }, "parameters": { "$ref": "#/components/schemas/FunctionParameters" }, "strict": { "anyOf": [ { "type": "boolean", "default": false, "description": "Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](/docs/guides/function-calling)." }, { "type": "null" } ] } }, "required": [ "name" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionParameters": { "type": "object", "description": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", "additionalProperties": true, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionToolCall": { "type": "object", "title": "Function tool call", "description": "A tool call to run a function. See the \n[function calling guide](/docs/guides/function-calling) for more information.\n", "properties": { "id": { "type": "string", "description": "The unique ID of the function tool call.\n" }, "type": { "type": "string", "enum": [ "function_call" ], "description": "The type of the function tool call. Always `function_call`.\n" }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model.\n" }, "caller": { "anyOf": [ { "$ref": "#/components/schemas/ToolCallCaller" }, { "type": "null" } ] }, "namespace": { "type": "string", "description": "The namespace of the function to run.\n" }, "name": { "type": "string", "description": "The name of the function to run.\n" }, "arguments": { "type": "string", "description": "A JSON string of the arguments to pass to the function.\n" }, "status": { "type": "string", "description": "The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n", "enum": [ "in_progress", "completed", "incomplete" ] } }, "required": [ "type", "call_id", "name", "arguments" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionToolCallOutput": { "type": "object", "title": "Function tool call output", "description": "The output of a function tool call.\n", "properties": { "id": { "type": "string", "description": "The unique ID of the function tool call output. Populated when this item\nis returned via API.\n" }, "type": { "type": "string", "enum": [ "function_call_output" ], "description": "The type of the function tool call output. Always `function_call_output`.\n" }, "call_id": { "type": "string", "description": "The unique ID of the function tool call generated by the model.\n" }, "name": { "type": "string", "description": "The name of the tool that produced the output.\n" }, "namespace": { "type": "string", "description": "The namespace of the tool that produced the output.\n" }, "caller": { "anyOf": [ { "$ref": "#/components/schemas/ToolCallCallerParam" }, { "type": "null" } ] }, "output": { "description": "The output from the function call generated by your code.\nCan be a string or an list of output content.\n", "oneOf": [ { "type": "string", "description": "A string of the output of the function call.\n", "title": "string output" }, { "type": "array", "items": { "$ref": "#/components/schemas/FunctionAndCustomToolCallOutput" }, "title": "output content list", "description": "Text, image, or file output of the function call.\n" } ] }, "status": { "type": "string", "description": "The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n", "enum": [ "in_progress", "completed", "incomplete" ] } }, "required": [ "type", "call_id", "output" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionToolCallOutputResource": { "allOf": [ { "$ref": "#/components/schemas/FunctionToolCallOutput" }, { "type": "object", "properties": { "id": { "type": "string", "description": "The unique ID of the function call tool output.\n" }, "status": { "description": "The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n", "$ref": "#/components/schemas/FunctionCallOutputStatusEnum" }, "created_by": { "type": "string", "description": "The identifier of the actor that created the item.\n" } }, "required": [ "id", "status" ] } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "Image": { "type": "object", "description": "Represents the content or the URL of an image generated by the OpenAI API.", "properties": { "b64_json": { "type": "string", "description": "The base64-encoded JSON of the generated image. Returned by default for the GPT image models, and only present if `response_format` is set to `b64_json` for `dall-e-2` and `dall-e-3`." }, "url": { "type": "string", "format": "uri", "description": "When using `dall-e-2` or `dall-e-3`, the URL of the generated image if `response_format` is set to `url` (default value). Unsupported for the GPT image models." }, "revised_prompt": { "type": "string", "description": "For `dall-e-3` only, the revised prompt that was used to generate the image." } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ImageGenCompletedEvent": { "type": "object", "description": "Emitted when image generation has completed and the final image is available.\n", "properties": { "type": { "type": "string", "description": "The type of the event. Always `image_generation.completed`.\n", "enum": [ "image_generation.completed" ] }, "b64_json": { "type": "string", "description": "Base64-encoded image data, suitable for rendering as an image.\n" }, "created_at": { "type": "integer", "format": "unixtime", "description": "The Unix timestamp when the event was created.\n" }, "size": { "type": "string", "description": "The size of the generated image.\n", "enum": [ "1024x1024", "1024x1536", "1536x1024", "auto" ] }, "quality": { "type": "string", "description": "The quality setting for the generated image.\n", "enum": [ "low", "medium", "high", "auto" ] }, "background": { "type": "string", "description": "The background setting for the generated image.\n", "enum": [ "transparent", "opaque", "auto" ] }, "output_format": { "type": "string", "description": "The output format for the generated image.\n", "enum": [ "png", "webp", "jpeg" ] }, "usage": { "$ref": "#/components/schemas/ImagesUsage" } }, "required": [ "type", "b64_json", "created_at", "size", "quality", "background", "output_format", "usage" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ImageGenPartialImageEvent": { "type": "object", "description": "Emitted when a partial image is available during image generation streaming.\n", "properties": { "type": { "type": "string", "description": "The type of the event. Always `image_generation.partial_image`.\n", "enum": [ "image_generation.partial_image" ] }, "b64_json": { "type": "string", "description": "Base64-encoded partial image data, suitable for rendering as an image.\n" }, "created_at": { "type": "integer", "format": "unixtime", "description": "The Unix timestamp when the event was created.\n" }, "size": { "type": "string", "description": "The size of the requested image.\n", "enum": [ "1024x1024", "1024x1536", "1536x1024", "auto" ] }, "quality": { "type": "string", "description": "The quality setting for the requested image.\n", "enum": [ "low", "medium", "high", "auto" ] }, "background": { "type": "string", "description": "The background setting for the requested image.\n", "enum": [ "transparent", "opaque", "auto" ] }, "output_format": { "type": "string", "description": "The output format for the requested image.\n", "enum": [ "png", "webp", "jpeg" ] }, "partial_image_index": { "type": "integer", "description": "0-based index for the partial image (streaming).\n" } }, "required": [ "type", "b64_json", "created_at", "size", "quality", "background", "output_format", "partial_image_index" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ImageGenStreamEvent": { "anyOf": [ { "$ref": "#/components/schemas/ImageGenPartialImageEvent" }, { "$ref": "#/components/schemas/ImageGenCompletedEvent" } ], "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ImageGenTool": { "type": "object", "title": "Image generation tool", "description": "A tool that generates images using the GPT image models.\n", "properties": { "type": { "type": "string", "enum": [ "image_generation" ], "description": "The type of the image generation tool. Always `image_generation`.\n" }, "model": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "gpt-image-1", "gpt-image-1-mini", "gpt-image-1.5" ], "description": "The image generation model to use. Default: `gpt-image-1`.\n", "default": "gpt-image-1" } ] }, "quality": { "type": "string", "enum": [ "low", "medium", "high", "auto" ], "description": "The quality of the generated image. One of `low`, `medium`, `high`,\nor `auto`. Default: `auto`.\n", "default": "auto" }, "size": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "1024x1024", "1024x1536", "1536x1024", "auto" ] } ], "description": "The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.", "default": "auto" }, "output_format": { "type": "string", "enum": [ "png", "webp", "jpeg" ], "description": "The output format of the generated image. One of `png`, `webp`, or\n`jpeg`. Default: `png`.\n", "default": "png" }, "output_compression": { "type": "integer", "minimum": 0, "maximum": 100, "description": "Compression level for the output image. Default: 100.\n", "default": 100 }, "moderation": { "type": "string", "enum": [ "auto", "low" ], "description": "Moderation level for the generated image. Default: `auto`.\n", "default": "auto" }, "background": { "type": "string", "enum": [ "transparent", "opaque", "auto" ], "description": "Background type for the generated image. One of `transparent`,\n`opaque`, or `auto`. Default: `auto`.\n", "default": "auto" }, "input_fidelity": { "anyOf": [ { "$ref": "#/components/schemas/InputFidelity" }, { "type": "null" } ] }, "input_image_mask": { "type": "object", "description": "Optional mask for inpainting. Contains `image_url`\n(string, optional) and `file_id` (string, optional).\n", "properties": { "image_url": { "type": "string", "description": "Base64-encoded mask image.\n" }, "file_id": { "type": "string", "description": "File ID for the mask image.\n" } }, "required": [], "additionalProperties": false }, "partial_images": { "type": "integer", "minimum": 0, "maximum": 3, "description": "Number of partial images to generate in streaming mode, from 0 (default value) to 3.\n", "default": 0 }, "action": { "description": "Whether to generate a new image or edit an existing image. Default: `auto`.\n", "$ref": "#/components/schemas/ImageGenActionEnum" } }, "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ImageGenToolCall": { "type": "object", "title": "Image generation call", "description": "An image generation request made by the model.\n", "properties": { "type": { "type": "string", "enum": [ "image_generation_call" ], "description": "The type of the image generation call. Always `image_generation_call`.\n" }, "id": { "type": "string", "description": "The unique ID of the image generation call.\n" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "generating", "failed" ], "description": "The status of the image generation call.\n" }, "result": { "anyOf": [ { "type": "string", "description": "The generated image encoded in base64.\n" }, { "type": "null" } ] } }, "required": [ "type", "id", "status", "result" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ImagesResponse": { "type": "object", "title": "Image generation response", "description": "The response from the image generation endpoint.", "properties": { "created": { "type": "integer", "format": "unixtime", "description": "The Unix timestamp (in seconds) of when the image was created." }, "data": { "type": "array", "description": "The list of generated images.", "items": { "$ref": "#/components/schemas/Image" } }, "background": { "type": "string", "description": "The background parameter used for the image generation. Either `transparent` or `opaque`.", "enum": [ "transparent", "opaque" ] }, "output_format": { "type": "string", "description": "The output format of the image generation. Either `png`, `webp`, or `jpeg`.", "enum": [ "png", "webp", "jpeg" ] }, "size": { "type": "string", "description": "The size of the image generated. Either `1024x1024`, `1024x1536`, or `1536x1024`.", "enum": [ "1024x1024", "1024x1536", "1536x1024" ] }, "quality": { "type": "string", "description": "The quality of the image generated. Either `low`, `medium`, or `high`.", "enum": [ "low", "medium", "high" ] }, "usage": { "$ref": "#/components/schemas/ImageGenUsage" } }, "required": [ "created" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ImagesUsage": { "type": "object", "description": "For the GPT image models only, the token usage information for the image generation.\n", "required": [ "total_tokens", "input_tokens", "output_tokens", "input_tokens_details" ], "properties": { "total_tokens": { "type": "integer", "description": "The total number of tokens (images and text) used for the image generation.\n" }, "input_tokens": { "type": "integer", "description": "The number of tokens (images and text) in the input prompt." }, "output_tokens": { "type": "integer", "description": "The number of image tokens in the output image." }, "input_tokens_details": { "type": "object", "description": "The input tokens detailed information for the image generation.", "required": [ "text_tokens", "image_tokens" ], "properties": { "text_tokens": { "type": "integer", "description": "The number of text tokens in the input prompt." }, "image_tokens": { "type": "integer", "description": "The number of image tokens in the input prompt." } } } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "InputContent": { "oneOf": [ { "$ref": "#/components/schemas/InputTextContent" }, { "$ref": "#/components/schemas/InputImageContent" }, { "$ref": "#/components/schemas/InputFileContent" } ], "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "InputItem": { "oneOf": [ { "$ref": "#/components/schemas/EasyInputMessage" }, { "type": "object", "title": "Item", "description": "An item representing part of the context for the response to be\ngenerated by the model. Can contain text, images, and audio inputs,\nas well as previous assistant responses and tool call outputs.\n", "$ref": "#/components/schemas/Item" }, { "$ref": "#/components/schemas/CompactionTriggerItemParam" }, { "$ref": "#/components/schemas/ItemReferenceParam" }, { "$ref": "#/components/schemas/ProgramItemParam" }, { "$ref": "#/components/schemas/ProgramOutputItemParam" } ], "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "InputMessage": { "type": "object", "title": "Input message", "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role.\n", "properties": { "type": { "type": "string", "description": "The type of the message input. Always set to `message`.\n", "enum": [ "message" ] }, "role": { "type": "string", "description": "The role of the message input. One of `user`, `system`, or `developer`.\n", "enum": [ "user", "system", "developer" ] }, "status": { "type": "string", "description": "The status of item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n", "enum": [ "in_progress", "completed", "incomplete" ] }, "content": { "$ref": "#/components/schemas/InputMessageContentList" } }, "required": [ "role", "content" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "InputMessageContentList": { "type": "array", "title": "Input item content list", "description": "A list of one or many input items to the model, containing different content \ntypes.\n", "items": { "$ref": "#/components/schemas/InputContent" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "InputParam": { "description": "Text, image, or file inputs to the model, used to generate a response.\n\nLearn more:\n- [Text inputs and outputs](/docs/guides/text)\n- [Image inputs](/docs/guides/images)\n- [File inputs](/docs/guides/pdf-files)\n- [Conversation state](/docs/guides/conversation-state)\n- [Function calling](/docs/guides/function-calling)\n", "oneOf": [ { "type": "string", "title": "Text input", "description": "A text input to the model, equivalent to a text input with the\n`user` role.\n" }, { "type": "array", "title": "Input item list", "description": "A list of one or many input items to the model, containing\ndifferent content types.\n", "items": { "$ref": "#/components/schemas/InputItem" } } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "Item": { "type": "object", "description": "Content item used to generate a response.\n", "oneOf": [ { "$ref": "#/components/schemas/InputMessage" }, { "$ref": "#/components/schemas/OutputMessage" }, { "$ref": "#/components/schemas/FileSearchToolCall" }, { "$ref": "#/components/schemas/ComputerToolCall" }, { "$ref": "#/components/schemas/ComputerCallOutputItemParam" }, { "$ref": "#/components/schemas/WebSearchToolCall" }, { "$ref": "#/components/schemas/FunctionToolCall" }, { "$ref": "#/components/schemas/FunctionCallOutputItemParam" }, { "$ref": "#/components/schemas/ToolSearchCallItemParam" }, { "$ref": "#/components/schemas/ToolSearchOutputItemParam" }, { "$ref": "#/components/schemas/AdditionalToolsItemParam" }, { "$ref": "#/components/schemas/ReasoningItem" }, { "$ref": "#/components/schemas/CompactionSummaryItemParam" }, { "$ref": "#/components/schemas/ImageGenToolCall" }, { "$ref": "#/components/schemas/CodeInterpreterToolCall" }, { "$ref": "#/components/schemas/LocalShellToolCall" }, { "$ref": "#/components/schemas/LocalShellToolCallOutput" }, { "$ref": "#/components/schemas/FunctionShellCallItemParam" }, { "$ref": "#/components/schemas/FunctionShellCallOutputItemParam" }, { "$ref": "#/components/schemas/ApplyPatchToolCallItemParam" }, { "$ref": "#/components/schemas/ApplyPatchToolCallOutputItemParam" }, { "$ref": "#/components/schemas/MCPListTools" }, { "$ref": "#/components/schemas/MCPApprovalRequest" }, { "$ref": "#/components/schemas/MCPApprovalResponse" }, { "$ref": "#/components/schemas/MCPToolCall" }, { "$ref": "#/components/schemas/CustomToolCallOutput" }, { "$ref": "#/components/schemas/CustomToolCall" } ], "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "LocalShellToolCall": { "type": "object", "title": "Local shell call", "description": "A tool call to run a command on the local shell.\n", "properties": { "type": { "type": "string", "enum": [ "local_shell_call" ], "description": "The type of the local shell call. Always `local_shell_call`.\n" }, "id": { "type": "string", "description": "The unique ID of the local shell call.\n" }, "call_id": { "type": "string", "description": "The unique ID of the local shell tool call generated by the model.\n" }, "action": { "$ref": "#/components/schemas/LocalShellExecAction" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "description": "The status of the local shell call.\n" } }, "required": [ "type", "id", "call_id", "action", "status" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "LocalShellToolCallOutput": { "type": "object", "title": "Local shell call output", "description": "The output of a local shell tool call.\n", "properties": { "type": { "type": "string", "enum": [ "local_shell_call_output" ], "description": "The type of the local shell tool call output. Always `local_shell_call_output`.\n" }, "id": { "type": "string", "description": "The unique ID of the local shell tool call generated by the model.\n" }, "output": { "type": "string", "description": "A JSON string of the output of the local shell tool call.\n" }, "status": { "anyOf": [ { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`.\n" }, { "type": "null" } ] } }, "required": [ "id", "type", "call_id", "output" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "MCPApprovalRequest": { "type": "object", "title": "MCP approval request", "description": "A request for human approval of a tool invocation.\n", "properties": { "type": { "type": "string", "enum": [ "mcp_approval_request" ], "description": "The type of the item. Always `mcp_approval_request`.\n" }, "id": { "type": "string", "description": "The unique ID of the approval request.\n" }, "server_label": { "type": "string", "description": "The label of the MCP server making the request.\n" }, "name": { "type": "string", "description": "The name of the tool to run.\n" }, "arguments": { "type": "string", "description": "A JSON string of arguments for the tool.\n" } }, "required": [ "type", "id", "server_label", "name", "arguments" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "MCPApprovalResponse": { "type": "object", "title": "MCP approval response", "description": "A response to an MCP approval request.\n", "properties": { "type": { "type": "string", "enum": [ "mcp_approval_response" ], "description": "The type of the item. Always `mcp_approval_response`.\n" }, "id": { "anyOf": [ { "type": "string", "description": "The unique ID of the approval response\n" }, { "type": "null" } ] }, "approval_request_id": { "type": "string", "description": "The ID of the approval request being answered.\n" }, "approve": { "type": "boolean", "description": "Whether the request was approved.\n" }, "reason": { "anyOf": [ { "type": "string", "description": "Optional reason for the decision.\n" }, { "type": "null" } ] } }, "required": [ "type", "request_id", "approve", "approval_request_id" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "MCPApprovalResponseResource": { "type": "object", "title": "MCP approval response", "description": "A response to an MCP approval request.\n", "properties": { "type": { "type": "string", "enum": [ "mcp_approval_response" ], "description": "The type of the item. Always `mcp_approval_response`.\n" }, "id": { "type": "string", "description": "The unique ID of the approval response\n" }, "approval_request_id": { "type": "string", "description": "The ID of the approval request being answered.\n" }, "approve": { "type": "boolean", "description": "Whether the request was approved.\n" }, "reason": { "anyOf": [ { "type": "string", "description": "Optional reason for the decision.\n" }, { "type": "null" } ] } }, "required": [ "type", "id", "request_id", "approve", "approval_request_id" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "MCPListTools": { "type": "object", "title": "MCP list tools", "description": "A list of tools available on an MCP server.\n", "properties": { "type": { "type": "string", "enum": [ "mcp_list_tools" ], "description": "The type of the item. Always `mcp_list_tools`.\n" }, "id": { "type": "string", "description": "The unique ID of the list.\n" }, "server_label": { "type": "string", "description": "The label of the MCP server.\n" }, "tools": { "type": "array", "items": { "$ref": "#/components/schemas/MCPListToolsTool" }, "description": "The tools available on the server.\n" }, "error": { "anyOf": [ { "type": "string", "description": "Error message if the server could not list tools.\n" }, { "type": "null" } ] } }, "required": [ "type", "id", "server_label", "tools" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "MCPListToolsTool": { "type": "object", "title": "MCP list tools tool", "description": "A tool available on an MCP server.\n", "properties": { "name": { "type": "string", "description": "The name of the tool.\n" }, "description": { "anyOf": [ { "type": "string", "description": "The description of the tool.\n" }, { "type": "null" } ] }, "input_schema": { "type": "object", "description": "The JSON schema describing the tool's input.\n" }, "annotations": { "anyOf": [ { "type": "object", "description": "Additional annotations about the tool.\n" }, { "type": "null" } ] } }, "required": [ "name", "input_schema" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "MCPTool": { "type": "object", "title": "MCP tool", "description": "Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp).\n", "properties": { "type": { "type": "string", "enum": [ "mcp" ], "description": "The type of the MCP tool. Always `mcp`." }, "server_label": { "type": "string", "description": "A label for this MCP server, used to identify it in tool calls.\n" }, "server_url": { "type": "string", "format": "uri", "description": "The URL for the MCP server. One of `server_url`, `connector_id`, or\n`tunnel_id` must be provided.\n" }, "connector_id": { "type": "string", "enum": [ "connector_dropbox", "connector_gmail", "connector_googlecalendar", "connector_googledrive", "connector_microsoftteams", "connector_outlookcalendar", "connector_outlookemail", "connector_sharepoint" ], "description": "Identifier for service connectors, like those available in ChatGPT. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more\nabout service connectors [here](/docs/guides/tools-remote-mcp#connectors).\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`\n" }, "tunnel_id": { "type": "string", "pattern": "^tunnel_[a-z0-9]{32}$", "description": "The Secure MCP Tunnel ID to use instead of a direct server URL. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided.\n" }, "authorization": { "type": "string", "description": "An OAuth access token that can be used with a remote MCP server, either\nwith a custom MCP server URL or a service connector. Your application\nmust handle the OAuth authorization flow and provide the token here.\n" }, "server_description": { "type": "string", "description": "Optional description of the MCP server, used to provide more context.\n" }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional HTTP headers to send to the MCP server. Use for authentication\nor other purposes.\n" }, { "type": "null" } ] }, "allowed_tools": { "anyOf": [ { "description": "List of allowed tool names or a filter object.\n", "oneOf": [ { "type": "array", "title": "MCP allowed tools", "description": "A string array of allowed tool names", "items": { "type": "string" } }, { "$ref": "#/components/schemas/MCPToolFilter" } ] }, { "type": "null" } ] }, "allowed_callers": { "anyOf": [ { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/CallableToolAllowedCaller" }, "description": "The tool invocation context(s)." }, { "type": "null" } ] }, "require_approval": { "anyOf": [ { "description": "Specify which of the MCP server's tools require approval.", "oneOf": [ { "type": "object", "title": "MCP tool approval filter", "description": "Specify which of the MCP server's tools require approval. Can be\n`always`, `never`, or a filter object associated with tools\nthat require approval.\n", "properties": { "always": { "$ref": "#/components/schemas/MCPToolFilter" }, "never": { "$ref": "#/components/schemas/MCPToolFilter" } }, "additionalProperties": false }, { "type": "string", "title": "MCP tool approval setting", "description": "Specify a single approval policy for all tools. One of `always` or\n`never`. When set to `always`, all tools will require approval. When\nset to `never`, all tools will not require approval.\n", "enum": [ "always", "never" ] } ], "default": "always" }, { "type": "null" } ] }, "defer_loading": { "type": "boolean", "description": "Whether this MCP tool is deferred and discovered via tool search.\n" } }, "required": [ "type", "server_label" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "MCPToolCall": { "type": "object", "title": "MCP tool call", "description": "An invocation of a tool on an MCP server.\n", "properties": { "type": { "type": "string", "enum": [ "mcp_call" ], "description": "The type of the item. Always `mcp_call`.\n" }, "id": { "type": "string", "description": "The unique ID of the tool call.\n" }, "server_label": { "type": "string", "description": "The label of the MCP server running the tool.\n" }, "name": { "type": "string", "description": "The name of the tool that was run.\n" }, "arguments": { "type": "string", "description": "A JSON string of the arguments passed to the tool.\n" }, "output": { "anyOf": [ { "type": "string", "description": "The output from the tool call.\n" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string", "description": "The error from the tool call, if any.\n" }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/MCPToolCallStatus", "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.\n" }, "approval_request_id": { "anyOf": [ { "type": "string", "description": "Unique identifier for the MCP tool call approval request.\nInclude this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.\n" }, { "type": "null" } ] } }, "required": [ "type", "id", "server_label", "name", "arguments" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "MCPToolFilter": { "type": "object", "title": "MCP tool filter", "description": "A filter object to specify which tools are allowed.\n", "properties": { "tool_names": { "type": "array", "title": "MCP allowed tools", "items": { "type": "string" }, "description": "List of allowed tool names." }, "read_only": { "type": "boolean", "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n" } }, "required": [], "additionalProperties": false, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "MessagePhase": { "type": "string", "description": "Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`).\nFor models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend\nphase on all assistant messages — dropping it can degrade performance. Not used for user messages.\n", "enum": [ "commentary", "final_answer" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "Metadata": { "anyOf": [ { "type": "object", "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "additionalProperties": { "type": "string" } }, { "type": "null" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ModelIdsResponses": { "example": "gpt-5.1", "anyOf": [ { "$ref": "#/components/schemas/ModelIdsShared" }, { "type": "string", "title": "ResponsesOnlyModel", "enum": [ "o1-pro", "o1-pro-2025-03-19", "o3-pro", "o3-pro-2025-06-10", "o3-deep-research", "o3-deep-research-2025-06-26", "o4-mini-deep-research", "o4-mini-deep-research-2025-06-26", "computer-use-preview", "computer-use-preview-2025-03-11", "gpt-5-codex", "gpt-5-pro", "gpt-5-pro-2025-10-06", "gpt-5.1-codex-max" ] } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ModelIdsShared": { "example": "gpt-5.4", "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "gpt-5.6-sol", "gpt-5.6-terra", "gpt-5.6-luna", "gpt-5.5", "gpt-5.4", "gpt-5.4-mini", "gpt-5.4-nano", "gpt-5.4-mini-2026-03-17", "gpt-5.4-nano-2026-03-17", "gpt-5.3-chat-latest", "gpt-5.2", "gpt-5.2-2025-12-11", "gpt-5.2-chat-latest", "gpt-5.2-pro", "gpt-5.2-pro-2025-12-11", "gpt-5.1", "gpt-5.1-2025-11-13", "gpt-5.1-codex", "gpt-5.1-mini", "gpt-5.1-chat-latest", "gpt-5", "gpt-5-mini", "gpt-5-nano", "gpt-5-2025-08-07", "gpt-5-mini-2025-08-07", "gpt-5-nano-2025-08-07", "gpt-5-chat-latest", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-4.1-2025-04-14", "gpt-4.1-mini-2025-04-14", "gpt-4.1-nano-2025-04-14", "o4-mini", "o4-mini-2025-04-16", "o3", "o3-2025-04-16", "o3-mini", "o3-mini-2025-01-31", "o1", "o1-2024-12-17", "o1-preview", "o1-preview-2024-09-12", "o1-mini", "o1-mini-2024-09-12", "gpt-4o", "gpt-4o-2024-11-20", "gpt-4o-2024-08-06", "gpt-4o-2024-05-13", "gpt-4o-audio-preview", "gpt-4o-audio-preview-2024-10-01", "gpt-4o-audio-preview-2024-12-17", "gpt-4o-audio-preview-2025-06-03", "gpt-4o-mini-audio-preview", "gpt-4o-mini-audio-preview-2024-12-17", "gpt-4o-search-preview", "gpt-4o-mini-search-preview", "gpt-4o-search-preview-2025-03-11", "gpt-4o-mini-search-preview-2025-03-11", "chatgpt-4o-latest", "codex-mini-latest", "gpt-4o-mini", "gpt-4o-mini-2024-07-18", "gpt-4-turbo", "gpt-4-turbo-2024-04-09", "gpt-4-0125-preview", "gpt-4-turbo-preview", "gpt-4-1106-preview", "gpt-4-vision-preview", "gpt-4", "gpt-4-0314", "gpt-4-0613", "gpt-4-32k", "gpt-4-32k-0314", "gpt-4-32k-0613", "gpt-3.5-turbo", "gpt-3.5-turbo-16k", "gpt-3.5-turbo-0301", "gpt-3.5-turbo-0613", "gpt-3.5-turbo-1106", "gpt-3.5-turbo-0125", "gpt-3.5-turbo-16k-0613" ] } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ModelResponseProperties": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "top_logprobs": { "anyOf": [ { "description": "An integer between 0 and 20 specifying the maximum number of most likely\ntokens to return at each token position, each with an associated log\nprobability. In some cases, the number of returned tokens may be fewer than\nrequested.\n", "type": "integer", "minimum": 0, "maximum": 20 }, { "type": "null" } ] }, "temperature": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 2, "default": 1, "example": 1, "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both.\n" }, { "type": "null" } ], "x-providers": { "gemini": { "to": [ "generationConfig", "temperature" ] }, "vertex": { "to": [ "generationConfig", "temperature" ] } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "top_p": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1, "default": 1, "example": 1, "description": "An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability\nmass. So 0.1 means only the tokens comprising the top 10% probability mass\nare considered.\n\nWe generally recommend altering this or `temperature` but not both.\n" }, { "type": "null" } ], "x-providers": { "gemini": { "to": [ "generationConfig", "topP" ] }, "vertex": { "to": [ "generationConfig", "topP" ] } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "user": { "type": "string", "example": "user-1234", "deprecated": true, "description": "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\nA stable identifier for your end-users.\nUsed to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n" }, "safety_identifier": { "anyOf": [ { "type": "string", "maxLength": 64, "example": "safety-identifier-1234", "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n" }, { "type": "null" } ] }, "prompt_cache_key": { "anyOf": [ { "type": "string", "example": "prompt-cache-key-1234", "description": "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching).\n" }, { "type": "null" } ] }, "service_tier": { "$ref": "#/components/schemas/ServiceTier" }, "prompt_cache_retention": { "deprecated": true, "anyOf": [ { "type": "string", "enum": [ "in_memory", "24h" ], "description": "Deprecated. Use `prompt_cache_options.ttl` instead.\n\nThe retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](/docs/guides/prompt-caching#prompt-cache-retention).\nThis field expresses a maximum retention policy, while\n`prompt_cache_options.ttl` expresses a minimum cache lifetime. The two\nfields are independent and do not interact.\nFor `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.\n\nFor older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy:\n - Organizations without ZDR enabled default to `24h`.\n - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified.\n" }, { "type": "null" } ] } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "OutputContent": { "oneOf": [ { "$ref": "#/components/schemas/OutputTextContent" }, { "$ref": "#/components/schemas/RefusalContent" }, { "$ref": "#/components/schemas/ReasoningTextContent" } ], "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "OutputItem": { "oneOf": [ { "$ref": "#/components/schemas/OutputMessage" }, { "$ref": "#/components/schemas/FileSearchToolCall" }, { "$ref": "#/components/schemas/FunctionToolCall" }, { "$ref": "#/components/schemas/FunctionToolCallOutputResource" }, { "$ref": "#/components/schemas/WebSearchToolCall" }, { "$ref": "#/components/schemas/ComputerToolCall" }, { "$ref": "#/components/schemas/ComputerToolCallOutputResource" }, { "$ref": "#/components/schemas/ReasoningItem" }, { "$ref": "#/components/schemas/Program" }, { "$ref": "#/components/schemas/ProgramOutput" }, { "$ref": "#/components/schemas/ToolSearchCall" }, { "$ref": "#/components/schemas/ToolSearchOutput" }, { "$ref": "#/components/schemas/AdditionalTools" }, { "$ref": "#/components/schemas/CompactionBody" }, { "$ref": "#/components/schemas/ImageGenToolCall" }, { "$ref": "#/components/schemas/CodeInterpreterToolCall" }, { "$ref": "#/components/schemas/LocalShellToolCall" }, { "$ref": "#/components/schemas/LocalShellToolCallOutput" }, { "$ref": "#/components/schemas/FunctionShellCall" }, { "$ref": "#/components/schemas/FunctionShellCallOutput" }, { "$ref": "#/components/schemas/ApplyPatchToolCall" }, { "$ref": "#/components/schemas/ApplyPatchToolCallOutput" }, { "$ref": "#/components/schemas/MCPToolCall" }, { "$ref": "#/components/schemas/MCPListTools" }, { "$ref": "#/components/schemas/MCPApprovalRequest" }, { "$ref": "#/components/schemas/MCPApprovalResponseResource" }, { "$ref": "#/components/schemas/CustomToolCall" }, { "$ref": "#/components/schemas/CustomToolCallOutputResource" } ], "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "OutputMessage": { "type": "object", "title": "Output message", "description": "An output message from the model.\n", "properties": { "id": { "type": "string", "description": "The unique ID of the output message.\n" }, "type": { "type": "string", "description": "The type of the output message. Always `message`.\n", "enum": [ "message" ] }, "role": { "type": "string", "description": "The role of the output message. Always `assistant`.\n", "enum": [ "assistant" ] }, "content": { "type": "array", "description": "The content of the output message.\n", "items": { "$ref": "#/components/schemas/OutputMessageContent" } }, "phase": { "anyOf": [ { "$ref": "#/components/schemas/MessagePhase" }, { "type": "null" } ] }, "status": { "type": "string", "description": "The status of the message input. One of `in_progress`, `completed`, or\n`incomplete`. Populated when input items are returned via API.\n", "enum": [ "in_progress", "completed", "incomplete" ] } }, "required": [ "id", "type", "role", "content", "status" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "OutputMessageContent": { "oneOf": [ { "$ref": "#/components/schemas/OutputTextContent" }, { "$ref": "#/components/schemas/RefusalContent" } ], "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ParallelToolCalls": { "description": "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "type": "boolean", "default": true, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "PartialImages": { "anyOf": [ { "type": "integer", "maximum": 3, "minimum": 0, "default": 0, "example": 1, "description": "The number of partial images to generate. This parameter is used for\nstreaming responses that return partial images. Value must be between 0 and 3.\nWhen set to 0, the response will be a single image sent in one streaming event.\n\nNote that the final image may be sent before the full number of partial images\nare generated if the full image is generated more quickly.\n" }, { "type": "null" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "PredictionContent": { "type": "object", "title": "Static Content", "description": "Static predicted output content, such as the content of a text file that is\nbeing regenerated.\n", "required": [ "type", "content" ], "properties": { "type": { "type": "string", "enum": [ "content" ], "description": "The type of the predicted content you want to provide. This type is\ncurrently always `content`.\n" }, "content": { "description": "The content that should be matched when generating a model response.\nIf generated tokens would match this content, the entire model response\ncan be returned much more quickly.\n", "oneOf": [ { "type": "string", "title": "Text content", "description": "The content used for a Predicted Output. This is often the\ntext of a file you are regenerating with minor changes.\n" }, { "type": "array", "description": "An array of content parts with a defined type. Supported options differ based on the [model](/docs/models) being used to generate the response. Can contain text inputs.", "title": "Array of content parts", "items": { "$ref": "#/components/schemas/ChatCompletionRequestMessageContentPartText" }, "minItems": 1 } ] } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "Prompt": { "anyOf": [ { "type": "object", "description": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique identifier of the prompt template to use." }, "version": { "anyOf": [ { "type": "string", "description": "Optional version of the prompt template." }, { "type": "null" } ] }, "variables": { "$ref": "#/components/schemas/ResponsePromptVariables" } } }, { "type": "null" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "Reasoning": { "type": "object", "description": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", "title": "Reasoning", "properties": { "mode": { "$ref": "#/components/schemas/ReasoningModeEnum", "description": "Controls the reasoning execution mode for the request.\n\nWhen returned on a response, this is the effective execution mode.\n" }, "effort": { "$ref": "#/components/schemas/ReasoningEffort" }, "summary": { "anyOf": [ { "type": "string", "description": "A summary of the reasoning performed by the model. This can be\nuseful for debugging and understanding the model's reasoning process.\nOne of `auto`, `concise`, or `detailed`.\n\n`concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`.\n", "enum": [ "auto", "concise", "detailed" ] }, { "type": "null" } ] }, "context": { "anyOf": [ { "type": "string", "description": "Controls which reasoning items are rendered back to the model on later turns.\nIf omitted or set to `auto`, the model determines the context mode. The\n`gpt-5.6` model family defaults to `all_turns`; earlier models default to\n`current_turn`.\n\nWhen returned on a response, this is the effective reasoning context mode\nused for the response.\n", "enum": [ "auto", "current_turn", "all_turns" ] }, { "type": "null" } ] }, "generate_summary": { "anyOf": [ { "type": "string", "deprecated": true, "description": "**Deprecated:** use `summary` instead.\n\nA summary of the reasoning performed by the model. This can be\nuseful for debugging and understanding the model's reasoning process.\nOne of `auto`, `concise`, or `detailed`.\n", "enum": [ "auto", "concise", "detailed" ] }, { "type": "null" } ] } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ReasoningEffort": { "anyOf": [ { "type": "string", "enum": [ "none", "minimal", "low", "medium", "high", "xhigh", "max" ], "default": "medium", "description": "Constrains effort on reasoning for reasoning models. Currently supported\nvalues are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.\nReducing reasoning effort can result in faster responses and fewer tokens\nused on reasoning in a response. Not all reasoning models support every\nvalue. See the\n[reasoning guide](https://platform.openai.com/docs/guides/reasoning)\nfor model-specific support.\n" }, { "type": "null" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ReasoningItem": { "type": "object", "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](/docs/guides/conversation-state).\n", "title": "Reasoning", "properties": { "type": { "type": "string", "description": "The type of the object. Always `reasoning`.\n", "enum": [ "reasoning" ] }, "id": { "type": "string", "description": "The unique identifier of the reasoning content.\n" }, "encrypted_content": { "anyOf": [ { "type": "string", "description": "The encrypted content of the reasoning item. This is populated by default\nfor reasoning items returned by `POST /v1/responses` and WebSocket\n`response.create` requests.\n" }, { "type": "null" } ] }, "summary": { "type": "array", "description": "Reasoning summary content.\n", "items": { "$ref": "#/components/schemas/SummaryTextContent" } }, "content": { "type": "array", "description": "Reasoning text content.\n", "items": { "$ref": "#/components/schemas/ReasoningTextContent" } }, "status": { "type": "string", "description": "The status of the item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.\n", "enum": [ "in_progress", "completed", "incomplete" ] } }, "required": [ "id", "summary", "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "Response": { "title": "The response object", "allOf": [ { "$ref": "#/components/schemas/ResponseModelResponseProperties" }, { "$ref": "#/components/schemas/ResponseProperties" }, { "type": "object", "properties": { "truncation": { "anyOf": [ { "type": "string", "description": "The truncation strategy to use for the model response.\n- `auto`: If the input to this Response exceeds\n the model's context window size, the model will truncate the\n response to fit the context window by dropping items from the beginning of the conversation.\n- `disabled` (default): If the input size will exceed the context window\n size for a model, the request will fail with a 400 error.\n", "enum": [ "auto", "disabled" ], "default": "disabled" }, { "type": "null" } ] }, "id": { "type": "string", "description": "Unique identifier for this Response.\n" }, "object": { "type": "string", "description": "The object type of this resource - always set to `response`.\n", "enum": [ "response" ] }, "status": { "type": "string", "description": "The status of the response generation. One of `completed`, `failed`,\n`in_progress`, `cancelled`, `queued`, or `incomplete`.\n", "enum": [ "completed", "failed", "in_progress", "cancelled", "queued", "incomplete" ] }, "created_at": { "type": "number", "format": "unixtime", "description": "Unix timestamp (in seconds) of when this Response was created.\n" }, "completed_at": { "anyOf": [ { "type": "number", "format": "unixtime", "description": "Unix timestamp (in seconds) of when this Response was completed.\nOnly present when the status is `completed`.\n" }, { "type": "null" } ] }, "error": { "$ref": "#/components/schemas/ResponseError" }, "incomplete_details": { "anyOf": [ { "type": "object", "description": "Details about why the response is incomplete.\n", "properties": { "reason": { "type": "string", "description": "The reason why the response is incomplete.", "enum": [ "max_output_tokens", "content_filter" ] } } }, { "type": "null" } ] }, "output": { "type": "array", "description": "An array of content items generated by the model.\n\n- The length and order of items in the `output` array is dependent\n on the model's response.\n- Rather than accessing the first item in the `output` array and\n assuming it's an `assistant` message with the content generated by\n the model, you might consider using the `output_text` property where\n supported in SDKs.\n", "items": { "$ref": "#/components/schemas/OutputItem" } }, "reasoning": { "anyOf": [ { "$ref": "#/components/schemas/Reasoning" }, { "type": "null" } ] }, "instructions": { "anyOf": [ { "description": "A system (or developer) message inserted into the model's context.\n\nWhen using along with `previous_response_id`, the instructions from a previous\nresponse will not be carried over to the next response. This makes it simple\nto swap out system (or developer) messages in new responses.\n", "oneOf": [ { "type": "string", "description": "A text input to the model, equivalent to a text input with the\n`developer` role.\n" }, { "type": "array", "title": "Input item list", "description": "A list of one or many input items to the model, containing\ndifferent content types.\n", "items": { "$ref": "#/components/schemas/InputItem" } } ] }, { "type": "null" } ] }, "output_text": { "anyOf": [ { "type": "string", "description": "SDK-only convenience property that contains the aggregated text output\nfrom all `output_text` items in the `output` array, if any are present.\nSupported in the Python and JavaScript SDKs.\n" }, { "type": "null" } ] }, "usage": { "$ref": "#/components/schemas/ResponseUsage" }, "prompt_cache_options": { "$ref": "#/components/schemas/PromptCacheOptions" }, "moderation": { "anyOf": [ { "$ref": "#/components/schemas/Moderation", "description": "Moderation results for the response input and output, if moderated completions were requested.\n" }, { "type": "null" } ] }, "parallel_tool_calls": { "type": "boolean", "description": "Whether to allow the model to run tool calls in parallel.\n", "default": true }, "conversation": { "anyOf": [ { "default": null, "$ref": "#/components/schemas/ResponseConversation" }, { "type": "null" } ] }, "max_output_tokens": { "anyOf": [ { "description": "An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).\n", "type": "integer" }, { "type": "null" } ] } }, "required": [ "id", "object", "created_at", "error", "incomplete_details", "instructions", "model", "tools", "output", "parallel_tool_calls", "metadata", "tool_choice", "temperature", "top_p" ] } ], "example": { "id": "resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41", "object": "response", "created_at": 1741476777, "status": "completed", "completed_at": 1741476778, "error": null, "incomplete_details": null, "instructions": null, "max_output_tokens": null, "model": "gpt-4o-2024-08-06", "output": [ { "type": "message", "id": "msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41", "status": "completed", "role": "assistant", "content": [ { "type": "output_text", "text": "The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background.", "annotations": [] } ] } ], "parallel_tool_calls": true, "previous_response_id": null, "reasoning": { "effort": null, "summary": null, "context": null }, "store": true, "temperature": 1, "text": { "format": { "type": "text" } }, "tool_choice": "auto", "tools": [], "top_p": 1, "truncation": "disabled", "usage": { "input_tokens": 328, "input_tokens_details": { "cached_tokens": 0, "cache_write_tokens": 0 }, "output_tokens": 52, "output_tokens_details": { "reasoning_tokens": 0 }, "total_tokens": 380 }, "user": null, "metadata": {} }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseAudioDeltaEvent": { "type": "object", "description": "Emitted when there is a partial audio response.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.audio.delta`.\n", "enum": [ "response.audio.delta" ] }, "sequence_number": { "type": "integer", "description": "A sequence number for this chunk of the stream response.\n" }, "delta": { "type": "string", "description": "A chunk of Base64 encoded response audio bytes.\n" } }, "required": [ "type", "delta", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseAudioDoneEvent": { "type": "object", "description": "Emitted when the audio response is complete.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.audio.done`.\n", "enum": [ "response.audio.done" ] }, "sequence_number": { "type": "integer", "description": "The sequence number of the delta.\n" } }, "required": [ "type", "sequence_number", "response_id" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseAudioTranscriptDeltaEvent": { "type": "object", "description": "Emitted when there is a partial transcript of audio.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.audio.transcript.delta`.\n", "enum": [ "response.audio.transcript.delta" ] }, "delta": { "type": "string", "description": "The partial transcript of the audio response.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." } }, "required": [ "type", "response_id", "delta", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseAudioTranscriptDoneEvent": { "type": "object", "description": "Emitted when the full audio transcript is completed.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.audio.transcript.done`.\n", "enum": [ "response.audio.transcript.done" ] }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." } }, "required": [ "type", "response_id", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseCodeInterpreterCallCodeDeltaEvent": { "type": "object", "description": "Emitted when a partial code snippet is streamed by the code interpreter.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.code_interpreter_call_code.delta`.", "enum": [ "response.code_interpreter_call_code.delta" ] }, "output_index": { "type": "integer", "description": "The index of the output item in the response for which the code is being streamed." }, "item_id": { "type": "string", "description": "The unique identifier of the code interpreter tool call item." }, "delta": { "type": "string", "description": "The partial code snippet being streamed by the code interpreter." }, "sequence_number": { "type": "integer", "description": "The sequence number of this event, used to order streaming events." } }, "required": [ "type", "output_index", "item_id", "delta", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseCodeInterpreterCallCodeDoneEvent": { "type": "object", "description": "Emitted when the code snippet is finalized by the code interpreter.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.code_interpreter_call_code.done`.", "enum": [ "response.code_interpreter_call_code.done" ] }, "output_index": { "type": "integer", "description": "The index of the output item in the response for which the code is finalized." }, "item_id": { "type": "string", "description": "The unique identifier of the code interpreter tool call item." }, "code": { "type": "string", "description": "The final code snippet output by the code interpreter." }, "sequence_number": { "type": "integer", "description": "The sequence number of this event, used to order streaming events." } }, "required": [ "type", "output_index", "item_id", "code", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseCodeInterpreterCallCompletedEvent": { "type": "object", "description": "Emitted when the code interpreter call is completed.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.code_interpreter_call.completed`.", "enum": [ "response.code_interpreter_call.completed" ] }, "output_index": { "type": "integer", "description": "The index of the output item in the response for which the code interpreter call is completed." }, "item_id": { "type": "string", "description": "The unique identifier of the code interpreter tool call item." }, "sequence_number": { "type": "integer", "description": "The sequence number of this event, used to order streaming events." } }, "required": [ "type", "output_index", "item_id", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseCodeInterpreterCallInProgressEvent": { "type": "object", "description": "Emitted when a code interpreter call is in progress.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.code_interpreter_call.in_progress`.", "enum": [ "response.code_interpreter_call.in_progress" ] }, "output_index": { "type": "integer", "description": "The index of the output item in the response for which the code interpreter call is in progress." }, "item_id": { "type": "string", "description": "The unique identifier of the code interpreter tool call item." }, "sequence_number": { "type": "integer", "description": "The sequence number of this event, used to order streaming events." } }, "required": [ "type", "output_index", "item_id", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseCodeInterpreterCallInterpretingEvent": { "type": "object", "description": "Emitted when the code interpreter is actively interpreting the code snippet.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.code_interpreter_call.interpreting`.", "enum": [ "response.code_interpreter_call.interpreting" ] }, "output_index": { "type": "integer", "description": "The index of the output item in the response for which the code interpreter is interpreting code." }, "item_id": { "type": "string", "description": "The unique identifier of the code interpreter tool call item." }, "sequence_number": { "type": "integer", "description": "The sequence number of this event, used to order streaming events." } }, "required": [ "type", "output_index", "item_id", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseCompletedEvent": { "type": "object", "description": "Emitted when the model response is complete.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.completed`.\n", "enum": [ "response.completed" ] }, "response": { "$ref": "#/components/schemas/Response", "description": "Properties of the completed response.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number for this event." } }, "required": [ "type", "response", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseContentPartAddedEvent": { "type": "object", "description": "Emitted when a new content part is added.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.content_part.added`.\n", "enum": [ "response.content_part.added" ] }, "item_id": { "type": "string", "description": "The ID of the output item that the content part was added to.\n" }, "output_index": { "type": "integer", "description": "The index of the output item that the content part was added to.\n" }, "content_index": { "type": "integer", "description": "The index of the content part that was added.\n" }, "part": { "$ref": "#/components/schemas/OutputContent", "description": "The content part that was added.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." } }, "required": [ "type", "item_id", "output_index", "content_index", "part", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseContentPartDoneEvent": { "type": "object", "description": "Emitted when a content part is done.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.content_part.done`.\n", "enum": [ "response.content_part.done" ] }, "item_id": { "type": "string", "description": "The ID of the output item that the content part was added to.\n" }, "output_index": { "type": "integer", "description": "The index of the output item that the content part was added to.\n" }, "content_index": { "type": "integer", "description": "The index of the content part that is done.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." }, "part": { "$ref": "#/components/schemas/OutputContent", "description": "The content part that is done.\n" } }, "required": [ "type", "item_id", "output_index", "content_index", "part", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseCreatedEvent": { "type": "object", "description": "An event that is emitted when a response is created.\n", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.created`.\n", "enum": [ "response.created" ] }, "response": { "$ref": "#/components/schemas/Response", "description": "The response that was created.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number for this event." } }, "required": [ "type", "response", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseCustomToolCallInputDeltaEvent": { "title": "ResponseCustomToolCallInputDelta", "type": "object", "description": "Event representing a delta (partial update) to the input of a custom tool call.\n", "properties": { "type": { "type": "string", "enum": [ "response.custom_tool_call_input.delta" ], "description": "The event type identifier." }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." }, "output_index": { "type": "integer", "description": "The index of the output this delta applies to." }, "item_id": { "type": "string", "description": "Unique identifier for the API item associated with this event." }, "delta": { "type": "string", "description": "The incremental input data (delta) for the custom tool call." } }, "required": [ "type", "output_index", "item_id", "delta", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseCustomToolCallInputDoneEvent": { "title": "ResponseCustomToolCallInputDone", "type": "object", "description": "Event indicating that input for a custom tool call is complete.\n", "properties": { "type": { "type": "string", "enum": [ "response.custom_tool_call_input.done" ], "description": "The event type identifier." }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." }, "output_index": { "type": "integer", "description": "The index of the output this event applies to." }, "item_id": { "type": "string", "description": "Unique identifier for the API item associated with this event." }, "input": { "type": "string", "description": "The complete input data for the custom tool call." } }, "required": [ "type", "output_index", "item_id", "input", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseError": { "anyOf": [ { "type": "object", "description": "An error object returned when the model fails to generate a Response.\n", "properties": { "code": { "$ref": "#/components/schemas/ResponseErrorCode" }, "message": { "type": "string", "description": "A human-readable description of the error.\n" } }, "required": [ "code", "message" ] }, { "type": "null" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseErrorCode": { "type": "string", "description": "The error code for the response.\n", "enum": [ "server_error", "rate_limit_exceeded", "invalid_prompt", "data_residency_mismatch", "bio_policy", "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" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseErrorEvent": { "type": "object", "description": "Emitted when an error occurs.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `error`.\n", "enum": [ "error" ] }, "code": { "anyOf": [ { "type": "string", "description": "The error code.\n" }, { "type": "null" } ] }, "message": { "type": "string", "description": "The error message.\n" }, "param": { "anyOf": [ { "type": "string", "description": "The error parameter.\n" }, { "type": "null" } ] }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." } }, "required": [ "type", "code", "message", "param", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseFailedEvent": { "type": "object", "description": "An event that is emitted when a response fails.\n", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.failed`.\n", "enum": [ "response.failed" ] }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." }, "response": { "$ref": "#/components/schemas/Response", "description": "The response that failed.\n" } }, "required": [ "type", "response", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseFileSearchCallCompletedEvent": { "type": "object", "description": "Emitted when a file search call is completed (results found).", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.file_search_call.completed`.\n", "enum": [ "response.file_search_call.completed" ] }, "output_index": { "type": "integer", "description": "The index of the output item that the file search call is initiated.\n" }, "item_id": { "type": "string", "description": "The ID of the output item that the file search call is initiated.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." } }, "required": [ "type", "output_index", "item_id", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseFileSearchCallInProgressEvent": { "type": "object", "description": "Emitted when a file search call is initiated.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.file_search_call.in_progress`.\n", "enum": [ "response.file_search_call.in_progress" ] }, "output_index": { "type": "integer", "description": "The index of the output item that the file search call is initiated.\n" }, "item_id": { "type": "string", "description": "The ID of the output item that the file search call is initiated.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." } }, "required": [ "type", "output_index", "item_id", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseFileSearchCallSearchingEvent": { "type": "object", "description": "Emitted when a file search is currently searching.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.file_search_call.searching`.\n", "enum": [ "response.file_search_call.searching" ] }, "output_index": { "type": "integer", "description": "The index of the output item that the file search call is searching.\n" }, "item_id": { "type": "string", "description": "The ID of the output item that the file search call is initiated.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." } }, "required": [ "type", "output_index", "item_id", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseFormatJsonObject": { "type": "object", "title": "JSON object", "description": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n", "properties": { "type": { "type": "string", "description": "The type of response format being defined. Always `json_object`.", "enum": [ "json_object" ] } }, "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseFormatJsonSchema": { "type": "object", "title": "JSON schema", "description": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "properties": { "type": { "type": "string", "description": "The type of response format being defined. Always `json_schema`.", "enum": [ "json_schema" ] }, "json_schema": { "type": "object", "title": "JSON schema", "description": "Structured Outputs configuration options, including a JSON Schema.\n", "properties": { "description": { "type": "string", "description": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n" }, "name": { "type": "string", "description": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n" }, "schema": { "$ref": "#/components/schemas/ResponseFormatJsonSchemaSchema" }, "strict": { "anyOf": [ { "type": "boolean", "default": false, "description": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n" }, { "type": "null" } ] } }, "required": [ "name" ] } }, "required": [ "type", "json_schema" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseFormatJsonSchemaSchema": { "type": "object", "title": "JSON schema", "description": "The schema for the response format, described as a JSON Schema object.\nLearn how to build JSON schemas [here](https://json-schema.org/).\n", "additionalProperties": true, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseFormatText": { "type": "object", "title": "Text", "description": "Default response format. Used to generate text responses.\n", "properties": { "type": { "type": "string", "description": "The type of response format being defined. Always `text`.", "enum": [ "text" ] } }, "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseFunctionCallArgumentsDeltaEvent": { "type": "object", "description": "Emitted when there is a partial function-call arguments delta.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.function_call_arguments.delta`.\n", "enum": [ "response.function_call_arguments.delta" ] }, "item_id": { "type": "string", "description": "The ID of the output item that the function-call arguments delta is added to.\n" }, "output_index": { "type": "integer", "description": "The index of the output item that the function-call arguments delta is added to.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." }, "delta": { "type": "string", "description": "The function-call arguments delta that is added.\n" } }, "required": [ "type", "item_id", "output_index", "delta", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseFunctionCallArgumentsDoneEvent": { "type": "object", "description": "Emitted when function-call arguments are finalized.", "properties": { "type": { "type": "string", "enum": [ "response.function_call_arguments.done" ] }, "item_id": { "type": "string", "description": "The ID of the item." }, "name": { "type": "string", "description": "The name of the function that was called." }, "output_index": { "type": "integer", "description": "The index of the output item." }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." }, "arguments": { "type": "string", "description": "The function-call arguments." } }, "required": [ "type", "item_id", "name", "output_index", "arguments", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseImageGenCallCompletedEvent": { "type": "object", "title": "ResponseImageGenCallCompletedEvent", "description": "Emitted when an image generation tool call has completed and the final image is available.\n", "properties": { "type": { "type": "string", "enum": [ "response.image_generation_call.completed" ], "description": "The type of the event. Always 'response.image_generation_call.completed'." }, "output_index": { "type": "integer", "description": "The index of the output item in the response's output array." }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." }, "item_id": { "type": "string", "description": "The unique identifier of the image generation item being processed." } }, "required": [ "type", "output_index", "item_id", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseImageGenCallGeneratingEvent": { "type": "object", "title": "ResponseImageGenCallGeneratingEvent", "description": "Emitted when an image generation tool call is actively generating an image (intermediate state).\n", "properties": { "type": { "type": "string", "enum": [ "response.image_generation_call.generating" ], "description": "The type of the event. Always 'response.image_generation_call.generating'." }, "output_index": { "type": "integer", "description": "The index of the output item in the response's output array." }, "item_id": { "type": "string", "description": "The unique identifier of the image generation item being processed." }, "sequence_number": { "type": "integer", "description": "The sequence number of the image generation item being processed." } }, "required": [ "type", "output_index", "item_id", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseImageGenCallInProgressEvent": { "type": "object", "title": "ResponseImageGenCallInProgressEvent", "description": "Emitted when an image generation tool call is in progress.\n", "properties": { "type": { "type": "string", "enum": [ "response.image_generation_call.in_progress" ], "description": "The type of the event. Always 'response.image_generation_call.in_progress'." }, "output_index": { "type": "integer", "description": "The index of the output item in the response's output array." }, "item_id": { "type": "string", "description": "The unique identifier of the image generation item being processed." }, "sequence_number": { "type": "integer", "description": "The sequence number of the image generation item being processed." } }, "required": [ "type", "output_index", "item_id", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseImageGenCallPartialImageEvent": { "type": "object", "title": "ResponseImageGenCallPartialImageEvent", "description": "Emitted when a partial image is available during image generation streaming.\n", "properties": { "type": { "type": "string", "enum": [ "response.image_generation_call.partial_image" ], "description": "The type of the event. Always 'response.image_generation_call.partial_image'." }, "output_index": { "type": "integer", "description": "The index of the output item in the response's output array." }, "item_id": { "type": "string", "description": "The unique identifier of the image generation item being processed." }, "sequence_number": { "type": "integer", "description": "The sequence number of the image generation item being processed." }, "partial_image_index": { "type": "integer", "description": "0-based index for the partial image (backend is 1-based, but this is 0-based for the user)." }, "partial_image_b64": { "type": "string", "description": "Base64-encoded partial image data, suitable for rendering as an image." } }, "required": [ "type", "output_index", "item_id", "sequence_number", "partial_image_index", "partial_image_b64" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseInProgressEvent": { "type": "object", "description": "Emitted when the response is in progress.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.in_progress`.\n", "enum": [ "response.in_progress" ] }, "response": { "$ref": "#/components/schemas/Response", "description": "The response that is in progress.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." } }, "required": [ "type", "response", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseIncompleteEvent": { "type": "object", "description": "An event that is emitted when a response finishes as incomplete.\n", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.incomplete`.\n", "enum": [ "response.incomplete" ] }, "response": { "$ref": "#/components/schemas/Response", "description": "The response that was incomplete.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." } }, "required": [ "type", "response", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseLogProb": { "type": "object", "description": "A logprob is the logarithmic probability that the model assigns to producing \na particular token at a given position in the sequence. Less-negative (higher) \nlogprob values indicate greater model confidence in that token choice.\n", "properties": { "token": { "description": "A possible text token.", "type": "string" }, "logprob": { "description": "The log probability of this token.\n", "type": "number" }, "top_logprobs": { "description": "The log probabilities of up to 20 of the most likely tokens.\n", "type": "array", "items": { "type": "object", "properties": { "token": { "description": "A possible text token.", "type": "string" }, "logprob": { "description": "The log probability of this token.", "type": "number" } } } } }, "required": [ "token", "logprob" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseMCPCallArgumentsDeltaEvent": { "type": "object", "title": "ResponseMCPCallArgumentsDeltaEvent", "description": "Emitted when there is a delta (partial update) to the arguments of an MCP tool call.\n", "properties": { "type": { "type": "string", "enum": [ "response.mcp_call_arguments.delta" ], "description": "The type of the event. Always 'response.mcp_call_arguments.delta'." }, "output_index": { "type": "integer", "description": "The index of the output item in the response's output array." }, "item_id": { "type": "string", "description": "The unique identifier of the MCP tool call item being processed." }, "delta": { "type": "string", "description": "A JSON string containing the partial update to the arguments for the MCP tool call.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." } }, "required": [ "type", "output_index", "item_id", "delta", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseMCPCallArgumentsDoneEvent": { "type": "object", "title": "ResponseMCPCallArgumentsDoneEvent", "description": "Emitted when the arguments for an MCP tool call are finalized.\n", "properties": { "type": { "type": "string", "enum": [ "response.mcp_call_arguments.done" ], "description": "The type of the event. Always 'response.mcp_call_arguments.done'." }, "output_index": { "type": "integer", "description": "The index of the output item in the response's output array." }, "item_id": { "type": "string", "description": "The unique identifier of the MCP tool call item being processed." }, "arguments": { "type": "string", "description": "A JSON string containing the finalized arguments for the MCP tool call.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." } }, "required": [ "type", "output_index", "item_id", "arguments", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseMCPCallCompletedEvent": { "type": "object", "title": "ResponseMCPCallCompletedEvent", "description": "Emitted when an MCP tool call has completed successfully.\n", "properties": { "type": { "type": "string", "enum": [ "response.mcp_call.completed" ], "description": "The type of the event. Always 'response.mcp_call.completed'." }, "item_id": { "type": "string", "description": "The ID of the MCP tool call item that completed." }, "output_index": { "type": "integer", "description": "The index of the output item that completed." }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." } }, "required": [ "type", "item_id", "output_index", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseMCPCallFailedEvent": { "type": "object", "title": "ResponseMCPCallFailedEvent", "description": "Emitted when an MCP tool call has failed.\n", "properties": { "type": { "type": "string", "enum": [ "response.mcp_call.failed" ], "description": "The type of the event. Always 'response.mcp_call.failed'." }, "item_id": { "type": "string", "description": "The ID of the MCP tool call item that failed." }, "output_index": { "type": "integer", "description": "The index of the output item that failed." }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." } }, "required": [ "type", "item_id", "output_index", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseMCPCallInProgressEvent": { "type": "object", "title": "ResponseMCPCallInProgressEvent", "description": "Emitted when an MCP tool call is in progress.\n", "properties": { "type": { "type": "string", "enum": [ "response.mcp_call.in_progress" ], "description": "The type of the event. Always 'response.mcp_call.in_progress'." }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." }, "output_index": { "type": "integer", "description": "The index of the output item in the response's output array." }, "item_id": { "type": "string", "description": "The unique identifier of the MCP tool call item being processed." } }, "required": [ "type", "output_index", "item_id", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseMCPListToolsCompletedEvent": { "type": "object", "title": "ResponseMCPListToolsCompletedEvent", "description": "Emitted when the list of available MCP tools has been successfully retrieved.\n", "properties": { "type": { "type": "string", "enum": [ "response.mcp_list_tools.completed" ], "description": "The type of the event. Always 'response.mcp_list_tools.completed'." }, "item_id": { "type": "string", "description": "The ID of the MCP tool call item that produced this output." }, "output_index": { "type": "integer", "description": "The index of the output item that was processed." }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." } }, "required": [ "type", "item_id", "output_index", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseMCPListToolsFailedEvent": { "type": "object", "title": "ResponseMCPListToolsFailedEvent", "description": "Emitted when the attempt to list available MCP tools has failed.\n", "properties": { "type": { "type": "string", "enum": [ "response.mcp_list_tools.failed" ], "description": "The type of the event. Always 'response.mcp_list_tools.failed'." }, "item_id": { "type": "string", "description": "The ID of the MCP tool call item that failed." }, "output_index": { "type": "integer", "description": "The index of the output item that failed." }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." } }, "required": [ "type", "item_id", "output_index", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseMCPListToolsInProgressEvent": { "type": "object", "title": "ResponseMCPListToolsInProgressEvent", "description": "Emitted when the system is in the process of retrieving the list of available MCP tools.\n", "properties": { "type": { "type": "string", "enum": [ "response.mcp_list_tools.in_progress" ], "description": "The type of the event. Always 'response.mcp_list_tools.in_progress'." }, "item_id": { "type": "string", "description": "The ID of the MCP tool call item that is being processed." }, "output_index": { "type": "integer", "description": "The index of the output item that is being processed." }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." } }, "required": [ "type", "item_id", "output_index", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseModalities": { "anyOf": [ { "type": "array", "description": "Output types that you would like the model to generate.\nMost models are capable of generating text, which is the default:\n\n`[\"text\"]`\n\nThe `gpt-4o-audio-preview` model can also be used to\n[generate audio](/docs/guides/audio). To request that this model generate\nboth text and audio responses, you can use:\n\n`[\"text\", \"audio\"]`\n", "items": { "type": "string", "enum": [ "text", "audio" ] } }, { "type": "null" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseOutputItemAddedEvent": { "type": "object", "description": "Emitted when a new output item is added.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.output_item.added`.\n", "enum": [ "response.output_item.added" ] }, "output_index": { "type": "integer", "description": "The index of the output item that was added.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event.\n" }, "item": { "$ref": "#/components/schemas/OutputItem", "description": "The output item that was added.\n" } }, "required": [ "type", "output_index", "item", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseOutputItemDoneEvent": { "type": "object", "description": "Emitted when an output item is marked done.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.output_item.done`.\n", "enum": [ "response.output_item.done" ] }, "output_index": { "type": "integer", "description": "The index of the output item that was marked done.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event.\n" }, "item": { "$ref": "#/components/schemas/OutputItem", "description": "The output item that was marked done.\n" } }, "required": [ "type", "output_index", "item", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseOutputTextAnnotationAddedEvent": { "type": "object", "title": "ResponseOutputTextAnnotationAddedEvent", "description": "Emitted when an annotation is added to output text content.\n", "properties": { "type": { "type": "string", "enum": [ "response.output_text.annotation.added" ], "description": "The type of the event. Always 'response.output_text.annotation.added'." }, "item_id": { "type": "string", "description": "The unique identifier of the item to which the annotation is being added." }, "output_index": { "type": "integer", "description": "The index of the output item in the response's output array." }, "content_index": { "type": "integer", "description": "The index of the content part within the output item." }, "annotation_index": { "type": "integer", "description": "The index of the annotation within the content part." }, "sequence_number": { "type": "integer", "description": "The sequence number of this event." }, "annotation": { "type": "object", "description": "The annotation object being added. (See annotation schema for details.)" } }, "required": [ "type", "item_id", "output_index", "content_index", "annotation_index", "annotation", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponsePromptVariables": { "anyOf": [ { "type": "object", "title": "Prompt Variables", "description": "Optional map of values to substitute in for variables in your\nprompt. The substitution values can either be strings, or other\nResponse input types like images or files.\n", "additionalProperties": { "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/InputTextContent" }, { "$ref": "#/components/schemas/InputImageContent" }, { "$ref": "#/components/schemas/InputFileContent" } ] } }, { "type": "null" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseProperties": { "type": "object", "properties": { "previous_response_id": { "anyOf": [ { "type": "string", "description": "The unique ID of the previous response to the model. Use this to\ncreate multi-turn conversations. Learn more about\n[conversation state](/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.\n" }, { "type": "null" } ] }, "model": { "description": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "$ref": "#/components/schemas/ModelIdsResponses" }, "background": { "anyOf": [ { "type": "boolean", "description": "Whether to run the model response in the background.\n[Learn more](/docs/guides/background).\n", "default": false }, { "type": "null" } ] }, "max_tool_calls": { "anyOf": [ { "description": "The maximum number of total calls to built-in tools that can be processed in a response. This maximum number applies across all built-in tool calls, not per individual tool. Any further attempts to call a tool by the model will be ignored.\n", "type": "integer" }, { "type": "null" } ] }, "text": { "$ref": "#/components/schemas/ResponseTextParam" }, "tools": { "$ref": "#/components/schemas/ToolsArray" }, "tool_choice": { "$ref": "#/components/schemas/ToolChoiceParam" }, "prompt": { "$ref": "#/components/schemas/Prompt" } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseQueuedEvent": { "type": "object", "title": "ResponseQueuedEvent", "description": "Emitted when a response is queued and waiting to be processed.\n", "properties": { "type": { "type": "string", "enum": [ "response.queued" ], "description": "The type of the event. Always 'response.queued'." }, "response": { "$ref": "#/components/schemas/Response", "description": "The full response object that is queued." }, "sequence_number": { "type": "integer", "description": "The sequence number for this event." } }, "required": [ "type", "response", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseReasoningSummaryPartAddedEvent": { "type": "object", "description": "Emitted when a new reasoning summary part is added.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.reasoning_summary_part.added`.\n", "enum": [ "response.reasoning_summary_part.added" ] }, "item_id": { "type": "string", "description": "The ID of the item this summary part is associated with.\n" }, "output_index": { "type": "integer", "description": "The index of the output item this summary part is associated with.\n" }, "summary_index": { "type": "integer", "description": "The index of the summary part within the reasoning summary.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event.\n" }, "part": { "type": "object", "description": "The summary part that was added.\n", "properties": { "type": { "type": "string", "description": "The type of the summary part. Always `summary_text`.", "enum": [ "summary_text" ] }, "text": { "type": "string", "description": "The text of the summary part." } }, "required": [ "type", "text" ] } }, "required": [ "type", "item_id", "output_index", "summary_index", "part", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseReasoningSummaryPartDoneEvent": { "type": "object", "description": "Emitted when a reasoning summary part is completed.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.reasoning_summary_part.done`.\n", "enum": [ "response.reasoning_summary_part.done" ] }, "item_id": { "type": "string", "description": "The ID of the item this summary part is associated with.\n" }, "output_index": { "type": "integer", "description": "The index of the output item this summary part is associated with.\n" }, "summary_index": { "type": "integer", "description": "The index of the summary part within the reasoning summary.\n" }, "status": { "type": "string", "description": "The completion status of the summary part. Omitted when the part completed\nnormally and set to `incomplete` when generation was interrupted.\n", "enum": [ "incomplete" ] }, "sequence_number": { "type": "integer", "description": "The sequence number of this event.\n" }, "part": { "type": "object", "description": "The completed summary part.\n", "properties": { "type": { "type": "string", "description": "The type of the summary part. Always `summary_text`.", "enum": [ "summary_text" ] }, "text": { "type": "string", "description": "The text of the summary part." } }, "required": [ "type", "text" ] } }, "required": [ "type", "item_id", "output_index", "summary_index", "part", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseReasoningSummaryTextDeltaEvent": { "type": "object", "description": "Emitted when a delta is added to a reasoning summary text.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.reasoning_summary_text.delta`.\n", "enum": [ "response.reasoning_summary_text.delta" ] }, "item_id": { "type": "string", "description": "The ID of the item this summary text delta is associated with.\n" }, "output_index": { "type": "integer", "description": "The index of the output item this summary text delta is associated with.\n" }, "summary_index": { "type": "integer", "description": "The index of the summary part within the reasoning summary.\n" }, "delta": { "type": "string", "description": "The text delta that was added to the summary.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event.\n" } }, "required": [ "type", "item_id", "output_index", "summary_index", "delta", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseReasoningSummaryTextDoneEvent": { "type": "object", "description": "Emitted when a reasoning summary text is completed.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.reasoning_summary_text.done`.\n", "enum": [ "response.reasoning_summary_text.done" ] }, "item_id": { "type": "string", "description": "The ID of the item this summary text is associated with.\n" }, "output_index": { "type": "integer", "description": "The index of the output item this summary text is associated with.\n" }, "summary_index": { "type": "integer", "description": "The index of the summary part within the reasoning summary.\n" }, "text": { "type": "string", "description": "The full text of the completed reasoning summary.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event.\n" } }, "required": [ "type", "item_id", "output_index", "summary_index", "text", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseReasoningTextDeltaEvent": { "type": "object", "description": "Emitted when a delta is added to a reasoning text.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.reasoning_text.delta`.\n", "enum": [ "response.reasoning_text.delta" ] }, "item_id": { "type": "string", "description": "The ID of the item this reasoning text delta is associated with.\n" }, "output_index": { "type": "integer", "description": "The index of the output item this reasoning text delta is associated with.\n" }, "content_index": { "type": "integer", "description": "The index of the reasoning content part this delta is associated with.\n" }, "delta": { "type": "string", "description": "The text delta that was added to the reasoning content.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event.\n" } }, "required": [ "type", "item_id", "output_index", "content_index", "delta", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseReasoningTextDoneEvent": { "type": "object", "description": "Emitted when a reasoning text is completed.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.reasoning_text.done`.\n", "enum": [ "response.reasoning_text.done" ] }, "item_id": { "type": "string", "description": "The ID of the item this reasoning text is associated with.\n" }, "output_index": { "type": "integer", "description": "The index of the output item this reasoning text is associated with.\n" }, "content_index": { "type": "integer", "description": "The index of the reasoning content part.\n" }, "text": { "type": "string", "description": "The full text of the completed reasoning content.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event.\n" } }, "required": [ "type", "item_id", "output_index", "content_index", "text", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseRefusalDeltaEvent": { "type": "object", "description": "Emitted when there is a partial refusal text.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.refusal.delta`.\n", "enum": [ "response.refusal.delta" ] }, "item_id": { "type": "string", "description": "The ID of the output item that the refusal text is added to.\n" }, "output_index": { "type": "integer", "description": "The index of the output item that the refusal text is added to.\n" }, "content_index": { "type": "integer", "description": "The index of the content part that the refusal text is added to.\n" }, "delta": { "type": "string", "description": "The refusal text that is added.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event.\n" } }, "required": [ "type", "item_id", "output_index", "content_index", "delta", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseRefusalDoneEvent": { "type": "object", "description": "Emitted when refusal text is finalized.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.refusal.done`.\n", "enum": [ "response.refusal.done" ] }, "item_id": { "type": "string", "description": "The ID of the output item that the refusal text is finalized.\n" }, "output_index": { "type": "integer", "description": "The index of the output item that the refusal text is finalized.\n" }, "content_index": { "type": "integer", "description": "The index of the content part that the refusal text is finalized.\n" }, "refusal": { "type": "string", "description": "The refusal text that is finalized.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of this event.\n" } }, "required": [ "type", "item_id", "output_index", "content_index", "refusal", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseStreamEvent": { "anyOf": [ { "$ref": "#/components/schemas/ResponseAudioDeltaEvent" }, { "$ref": "#/components/schemas/ResponseAudioDoneEvent" }, { "$ref": "#/components/schemas/ResponseAudioTranscriptDeltaEvent" }, { "$ref": "#/components/schemas/ResponseAudioTranscriptDoneEvent" }, { "$ref": "#/components/schemas/ResponseCodeInterpreterCallCodeDeltaEvent" }, { "$ref": "#/components/schemas/ResponseCodeInterpreterCallCodeDoneEvent" }, { "$ref": "#/components/schemas/ResponseCodeInterpreterCallCompletedEvent" }, { "$ref": "#/components/schemas/ResponseCodeInterpreterCallInProgressEvent" }, { "$ref": "#/components/schemas/ResponseCodeInterpreterCallInterpretingEvent" }, { "$ref": "#/components/schemas/ResponseCompletedEvent" }, { "$ref": "#/components/schemas/ResponseContentPartAddedEvent" }, { "$ref": "#/components/schemas/ResponseContentPartDoneEvent" }, { "$ref": "#/components/schemas/ResponseCreatedEvent" }, { "$ref": "#/components/schemas/ResponseErrorEvent" }, { "$ref": "#/components/schemas/ResponseFileSearchCallCompletedEvent" }, { "$ref": "#/components/schemas/ResponseFileSearchCallInProgressEvent" }, { "$ref": "#/components/schemas/ResponseFileSearchCallSearchingEvent" }, { "$ref": "#/components/schemas/ResponseFunctionCallArgumentsDeltaEvent" }, { "$ref": "#/components/schemas/ResponseFunctionCallArgumentsDoneEvent" }, { "$ref": "#/components/schemas/ResponseInProgressEvent" }, { "$ref": "#/components/schemas/ResponseFailedEvent" }, { "$ref": "#/components/schemas/ResponseIncompleteEvent" }, { "$ref": "#/components/schemas/ResponseOutputItemAddedEvent" }, { "$ref": "#/components/schemas/ResponseOutputItemDoneEvent" }, { "$ref": "#/components/schemas/ResponseReasoningSummaryPartAddedEvent" }, { "$ref": "#/components/schemas/ResponseReasoningSummaryPartDoneEvent" }, { "$ref": "#/components/schemas/ResponseReasoningSummaryTextDeltaEvent" }, { "$ref": "#/components/schemas/ResponseReasoningSummaryTextDoneEvent" }, { "$ref": "#/components/schemas/ResponseReasoningTextDeltaEvent" }, { "$ref": "#/components/schemas/ResponseReasoningTextDoneEvent" }, { "$ref": "#/components/schemas/ResponseRefusalDeltaEvent" }, { "$ref": "#/components/schemas/ResponseRefusalDoneEvent" }, { "$ref": "#/components/schemas/ResponseTextDeltaEvent" }, { "$ref": "#/components/schemas/ResponseTextDoneEvent" }, { "$ref": "#/components/schemas/ResponseWebSearchCallCompletedEvent" }, { "$ref": "#/components/schemas/ResponseWebSearchCallInProgressEvent" }, { "$ref": "#/components/schemas/ResponseWebSearchCallSearchingEvent" }, { "$ref": "#/components/schemas/ResponseImageGenCallCompletedEvent" }, { "$ref": "#/components/schemas/ResponseImageGenCallGeneratingEvent" }, { "$ref": "#/components/schemas/ResponseImageGenCallInProgressEvent" }, { "$ref": "#/components/schemas/ResponseImageGenCallPartialImageEvent" }, { "$ref": "#/components/schemas/ResponseMCPCallArgumentsDeltaEvent" }, { "$ref": "#/components/schemas/ResponseMCPCallArgumentsDoneEvent" }, { "$ref": "#/components/schemas/ResponseMCPCallCompletedEvent" }, { "$ref": "#/components/schemas/ResponseMCPCallFailedEvent" }, { "$ref": "#/components/schemas/ResponseMCPCallInProgressEvent" }, { "$ref": "#/components/schemas/ResponseMCPListToolsCompletedEvent" }, { "$ref": "#/components/schemas/ResponseMCPListToolsFailedEvent" }, { "$ref": "#/components/schemas/ResponseMCPListToolsInProgressEvent" }, { "$ref": "#/components/schemas/ResponseOutputTextAnnotationAddedEvent" }, { "$ref": "#/components/schemas/ResponseQueuedEvent" }, { "$ref": "#/components/schemas/ResponseCustomToolCallInputDeltaEvent" }, { "$ref": "#/components/schemas/ResponseCustomToolCallInputDoneEvent" } ], "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseStreamOptions": { "anyOf": [ { "description": "Options for streaming responses. Only set this when you set `stream: true`.\n", "type": "object", "default": null, "properties": { "include_obfuscation": { "type": "boolean", "description": "When true, stream obfuscation will be enabled. Stream obfuscation adds\nrandom characters to an `obfuscation` field on streaming delta events to\nnormalize payload sizes as a mitigation to certain side-channel attacks.\nThese obfuscation fields are included by default, but add a small amount\nof overhead to the data stream. You can set `include_obfuscation` to\nfalse to optimize for bandwidth if you trust the network links between\nyour application and the OpenAI API.\n" } } }, { "type": "null" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseTextDeltaEvent": { "type": "object", "description": "Emitted when there is an additional text delta.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.output_text.delta`.\n", "enum": [ "response.output_text.delta" ] }, "item_id": { "type": "string", "description": "The ID of the output item that the text delta was added to.\n" }, "output_index": { "type": "integer", "description": "The index of the output item that the text delta was added to.\n" }, "content_index": { "type": "integer", "description": "The index of the content part that the text delta was added to.\n" }, "delta": { "type": "string", "description": "The text delta that was added.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number for this event." }, "logprobs": { "type": "array", "description": "The log probabilities of the tokens in the delta.\n", "items": { "$ref": "#/components/schemas/ResponseLogProb" } } }, "required": [ "type", "item_id", "output_index", "content_index", "delta", "sequence_number", "logprobs" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseTextDoneEvent": { "type": "object", "description": "Emitted when text content is finalized.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.output_text.done`.\n", "enum": [ "response.output_text.done" ] }, "item_id": { "type": "string", "description": "The ID of the output item that the text content is finalized.\n" }, "output_index": { "type": "integer", "description": "The index of the output item that the text content is finalized.\n" }, "content_index": { "type": "integer", "description": "The index of the content part that the text content is finalized.\n" }, "text": { "type": "string", "description": "The text content that is finalized.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number for this event." }, "logprobs": { "type": "array", "description": "The log probabilities of the tokens in the delta.\n", "items": { "$ref": "#/components/schemas/ResponseLogProb" } } }, "required": [ "type", "item_id", "output_index", "content_index", "text", "sequence_number", "logprobs" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseTextParam": { "type": "object", "description": "Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](/docs/guides/text)\n- [Structured Outputs](/docs/guides/structured-outputs)\n", "properties": { "format": { "$ref": "#/components/schemas/TextResponseFormatConfiguration" }, "verbosity": { "$ref": "#/components/schemas/Verbosity" } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseUsage": { "type": "object", "description": "Represents token usage details including input tokens, output tokens,\na breakdown of output tokens, and the total tokens used.\n", "properties": { "input_tokens": { "type": "integer", "description": "The number of input tokens." }, "input_tokens_details": { "type": "object", "description": "A detailed breakdown of the input tokens.", "properties": { "cached_tokens": { "type": "integer", "description": "The number of tokens that were retrieved from the cache. \n[More on prompt caching](/docs/guides/prompt-caching).\n" }, "cache_write_tokens": { "type": "integer", "description": "The number of input tokens that were written to the cache." } }, "required": [ "cached_tokens", "cache_write_tokens" ] }, "output_tokens": { "type": "integer", "description": "The number of output tokens." }, "output_tokens_details": { "type": "object", "description": "A detailed breakdown of the output tokens.", "properties": { "reasoning_tokens": { "type": "integer", "description": "The number of reasoning tokens." } }, "required": [ "reasoning_tokens" ] }, "total_tokens": { "type": "integer", "description": "The total number of tokens used." } }, "required": [ "input_tokens", "input_tokens_details", "output_tokens", "output_tokens_details", "total_tokens" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseWebSearchCallCompletedEvent": { "type": "object", "description": "Emitted when a web search call is completed.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.web_search_call.completed`.\n", "enum": [ "response.web_search_call.completed" ] }, "output_index": { "type": "integer", "description": "The index of the output item that the web search call is associated with.\n" }, "item_id": { "type": "string", "description": "Unique ID for the output item associated with the web search call.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of the web search call being processed." } }, "required": [ "type", "output_index", "item_id", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseWebSearchCallInProgressEvent": { "type": "object", "description": "Emitted when a web search call is initiated.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.web_search_call.in_progress`.\n", "enum": [ "response.web_search_call.in_progress" ] }, "output_index": { "type": "integer", "description": "The index of the output item that the web search call is associated with.\n" }, "item_id": { "type": "string", "description": "Unique ID for the output item associated with the web search call.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of the web search call being processed." } }, "required": [ "type", "output_index", "item_id", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseWebSearchCallSearchingEvent": { "type": "object", "description": "Emitted when a web search call is executing.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `response.web_search_call.searching`.\n", "enum": [ "response.web_search_call.searching" ] }, "output_index": { "type": "integer", "description": "The index of the output item that the web search call is associated with.\n" }, "item_id": { "type": "string", "description": "Unique ID for the output item associated with the web search call.\n" }, "sequence_number": { "type": "integer", "description": "The sequence number of the web search call being processed." } }, "required": [ "type", "output_index", "item_id", "sequence_number" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ServiceTier": { "anyOf": [ { "type": "string", "description": "Specifies the processing type used for serving the request.\n - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier.\n - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request.\n - When not set, the default behavior is 'auto'.\n\n When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.\n", "enum": [ "auto", "default", "flex", "scale", "priority", "fast" ], "default": "auto" }, { "type": "null" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "SpeechAudioDeltaEvent": { "type": "object", "description": "Emitted for each chunk of audio data generated during speech synthesis.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `speech.audio.delta`.\n", "enum": [ "speech.audio.delta" ] }, "audio": { "type": "string", "description": "A chunk of Base64-encoded audio data.\n" } }, "required": [ "type", "audio" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "SpeechAudioDoneEvent": { "type": "object", "description": "Emitted when the speech synthesis is complete and all audio has been streamed.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `speech.audio.done`.\n", "enum": [ "speech.audio.done" ] }, "usage": { "type": "object", "description": "Token usage statistics for the request.\n", "properties": { "input_tokens": { "type": "integer", "description": "Number of input tokens in the prompt." }, "output_tokens": { "type": "integer", "description": "Number of output tokens generated." }, "total_tokens": { "type": "integer", "description": "Total number of tokens used (input + output)." } }, "required": [ "input_tokens", "output_tokens", "total_tokens" ] } }, "required": [ "type", "usage" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "StopConfiguration": { "description": "Not supported with latest reasoning models `o3` and `o4-mini`.\n\nUp to 4 sequences where the API will stop generating further tokens. The\nreturned text will not contain the stop sequence.\n", "default": null, "nullable": true, "oneOf": [ { "type": "string", "default": "<|endoftext|>", "example": "\n", "nullable": true }, { "type": "array", "minItems": 1, "maxItems": 4, "items": { "type": "string", "example": "[\"\\n\"]" } } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "TextResponseFormatConfiguration": { "description": "An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs, \nwhich ensures the model will match your supplied JSON schema. Learn more in the \n[Structured Outputs guide](/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.\n", "oneOf": [ { "$ref": "#/components/schemas/ResponseFormatText" }, { "$ref": "#/components/schemas/TextResponseFormatJsonSchema" }, { "$ref": "#/components/schemas/ResponseFormatJsonObject" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "TextResponseFormatJsonSchema": { "type": "object", "title": "JSON schema", "description": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n", "properties": { "type": { "type": "string", "description": "The type of response format being defined. Always `json_schema`.", "enum": [ "json_schema" ] }, "description": { "type": "string", "description": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n" }, "name": { "type": "string", "description": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n" }, "schema": { "$ref": "#/components/schemas/ResponseFormatJsonSchemaSchema" }, "strict": { "anyOf": [ { "type": "boolean", "default": false, "description": "Whether to enable strict schema adherence when generating the output.\nIf set to true, the model will always follow the exact schema defined\nin the `schema` field. Only a subset of JSON Schema is supported when\n`strict` is `true`. To learn more, read the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n" }, { "type": "null" } ] } }, "required": [ "type", "schema", "name" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "Tool": { "description": "A tool that can be used to generate a response.\n", "discriminator": { "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/FunctionTool" }, { "$ref": "#/components/schemas/FileSearchTool" }, { "$ref": "#/components/schemas/ComputerTool" }, { "$ref": "#/components/schemas/ComputerUsePreviewTool" }, { "$ref": "#/components/schemas/WebSearchTool" }, { "$ref": "#/components/schemas/MCPTool" }, { "$ref": "#/components/schemas/CodeInterpreterTool" }, { "$ref": "#/components/schemas/ProgrammaticToolCallingParam" }, { "$ref": "#/components/schemas/ImageGenTool" }, { "$ref": "#/components/schemas/LocalShellToolParam" }, { "$ref": "#/components/schemas/FunctionShellToolParam" }, { "$ref": "#/components/schemas/CustomToolParam" }, { "$ref": "#/components/schemas/NamespaceToolParam" }, { "$ref": "#/components/schemas/ToolSearchToolParam" }, { "$ref": "#/components/schemas/WebSearchPreviewTool" }, { "$ref": "#/components/schemas/ApplyPatchToolParam" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ToolChoiceAllowed": { "type": "object", "title": "Allowed tools", "description": "Constrains the tools available to the model to a pre-defined set.\n", "properties": { "type": { "type": "string", "enum": [ "allowed_tools" ], "description": "Allowed tool configuration type. Always `allowed_tools`." }, "mode": { "type": "string", "enum": [ "auto", "required" ], "description": "Constrains the tools available to the model to a pre-defined set.\n\n`auto` allows the model to pick from among the allowed tools and generate a\nmessage.\n\n`required` requires the model to call one or more of the allowed tools.\n" }, "tools": { "type": "array", "description": "A list of tool definitions that the model should be allowed to call.\n\nFor the Responses API, the list of tool definitions might look like:\n```json\n[\n { \"type\": \"function\", \"name\": \"get_weather\" },\n { \"type\": \"mcp\", \"server_label\": \"deepwiki\" },\n { \"type\": \"image_generation\" }\n]\n```\n", "items": { "type": "object", "description": "A tool definition that the model should be allowed to call.\n", "additionalProperties": true } } }, "required": [ "type", "mode", "tools" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ToolChoiceCustom": { "type": "object", "title": "Custom tool", "description": "Use this option to force the model to call a specific custom tool.\n", "properties": { "type": { "type": "string", "enum": [ "custom" ], "description": "For custom tool calling, the type is always `custom`." }, "name": { "type": "string", "description": "The name of the custom tool to call." } }, "required": [ "type", "name" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ToolChoiceFunction": { "type": "object", "title": "Function tool", "description": "Use this option to force the model to call a specific function.\n", "properties": { "type": { "type": "string", "enum": [ "function" ], "description": "For function calling, the type is always `function`." }, "name": { "type": "string", "description": "The name of the function to call." } }, "required": [ "type", "name" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ToolChoiceMCP": { "type": "object", "title": "MCP tool", "description": "Use this option to force the model to call a specific tool on a remote MCP server.\n", "properties": { "type": { "type": "string", "enum": [ "mcp" ], "description": "For MCP tools, the type is always `mcp`." }, "server_label": { "type": "string", "description": "The label of the MCP server to use.\n" }, "name": { "anyOf": [ { "type": "string", "description": "The name of the tool to call on the server.\n" }, { "type": "null" } ] } }, "required": [ "type", "server_label" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ToolChoiceOptions": { "type": "string", "title": "Tool choice mode", "description": "Controls which (if any) tool is called by the model.\n\n`none` means the model will not call any tool and instead generates a message.\n\n`auto` means the model can pick between generating a message or calling one or\nmore tools.\n\n`required` means the model must call one or more tools.\n", "enum": [ "none", "auto", "required" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ToolChoiceParam": { "description": "How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call.\n", "oneOf": [ { "$ref": "#/components/schemas/ToolChoiceOptions" }, { "$ref": "#/components/schemas/ToolChoiceAllowed" }, { "$ref": "#/components/schemas/ToolChoiceTypes" }, { "$ref": "#/components/schemas/ToolChoiceFunction" }, { "$ref": "#/components/schemas/ToolChoiceMCP" }, { "$ref": "#/components/schemas/ToolChoiceCustom" }, { "$ref": "#/components/schemas/SpecificProgrammaticToolCallingParam" }, { "$ref": "#/components/schemas/SpecificApplyPatchParam" }, { "$ref": "#/components/schemas/SpecificFunctionShellParam" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ToolChoiceTypes": { "type": "object", "title": "Hosted tool", "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](/docs/guides/tools).\n", "properties": { "type": { "type": "string", "description": "The type of hosted tool the model should to use. Learn more about\n[built-in tools](/docs/guides/tools).\n\nAllowed values are:\n- `file_search`\n- `web_search_preview`\n- `computer`\n- `computer_use_preview`\n- `computer_use`\n- `code_interpreter`\n- `image_generation`\n", "enum": [ "file_search", "web_search_preview", "computer", "computer_use_preview", "computer_use", "web_search_preview_2025_03_11", "image_generation", "code_interpreter" ] } }, "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ToolsArray": { "type": "array", "description": "An array of tools the model may call while generating a response. You\ncan specify which tool to use by setting the `tool_choice` parameter.\n\nWe support the following categories of tools:\n- **Built-in tools**: Tools that are provided by OpenAI that extend the\n model's capabilities, like [web search](/docs/guides/tools-web-search)\n or [file search](/docs/guides/tools-file-search). Learn more about\n [built-in tools](/docs/guides/tools).\n- **MCP Tools**: Integrations with third-party systems via custom MCP servers\n or predefined connectors such as Google Drive and SharePoint. Learn more about\n [MCP Tools](/docs/guides/tools-connectors-mcp).\n- **Function calls (custom tools)**: Functions that are defined by you,\n enabling the model to call your own code with strongly typed arguments\n and outputs. Learn more about\n [function calling](/docs/guides/function-calling). You can also use\n custom tools to call your own code.\n", "items": { "$ref": "#/components/schemas/Tool" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "TranscriptTextDeltaEvent": { "type": "object", "description": "Emitted when there is an additional text delta. This is also the first event emitted when the transcription starts. Only emitted when you [create a transcription](/docs/api-reference/audio/create-transcription) with the `Stream` parameter set to `true`.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `transcript.text.delta`.\n", "enum": [ "transcript.text.delta" ] }, "delta": { "type": "string", "description": "The text delta that was additionally transcribed.\n" }, "logprobs": { "type": "array", "description": "The log probabilities of the delta. Only included if you [create a transcription](/docs/api-reference/audio/create-transcription) with the `include[]` parameter set to `logprobs`.\n", "items": { "type": "object", "properties": { "token": { "type": "string", "description": "The token that was used to generate the log probability.\n" }, "logprob": { "type": "number", "description": "The log probability of the token.\n" }, "bytes": { "type": "array", "items": { "type": "integer" }, "description": "The bytes that were used to generate the log probability.\n" } } } }, "segment_id": { "type": "string", "description": "Identifier of the diarized segment that this delta belongs to. Only present when using `gpt-4o-transcribe-diarize`.\n" } }, "required": [ "type", "delta" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "TranscriptTextDoneEvent": { "type": "object", "description": "Emitted when the transcription is complete. Contains the complete transcription text. Only emitted when you [create a transcription](/docs/api-reference/audio/create-transcription) with the `Stream` parameter set to `true`.", "properties": { "type": { "type": "string", "description": "The type of the event. Always `transcript.text.done`.\n", "enum": [ "transcript.text.done" ] }, "text": { "type": "string", "description": "The text that was transcribed.\n" }, "languages": { "type": "array", "description": "The languages detected in the audio. Returned by `gpt-transcribe`. An empty array indicates that no language could be reliably detected.\n", "items": { "$ref": "#/components/schemas/TranscriptionLanguage" } }, "logprobs": { "type": "array", "description": "The log probabilities of the individual tokens in the transcription. Only included if you [create a transcription](/docs/api-reference/audio/create-transcription) with the `include[]` parameter set to `logprobs`.\n", "items": { "type": "object", "properties": { "token": { "type": "string", "description": "The token that was used to generate the log probability.\n" }, "logprob": { "type": "number", "description": "The log probability of the token.\n" }, "bytes": { "type": "array", "items": { "type": "integer" }, "description": "The bytes that were used to generate the log probability.\n" } } } }, "usage": { "$ref": "#/components/schemas/TranscriptTextUsageTokens" } }, "required": [ "type", "text" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "TranscriptTextSegmentEvent": { "type": "object", "description": "Emitted when a diarized transcription returns a completed segment with speaker information. Only emitted when you [create a transcription](/docs/api-reference/audio/create-transcription) with `stream` set to `true` and `response_format` set to `diarized_json`.\n", "properties": { "type": { "type": "string", "description": "The type of the event. Always `transcript.text.segment`.", "enum": [ "transcript.text.segment" ] }, "id": { "type": "string", "description": "Unique identifier for the segment." }, "start": { "type": "number", "format": "double", "description": "Start timestamp of the segment in seconds." }, "end": { "type": "number", "format": "double", "description": "End timestamp of the segment in seconds." }, "text": { "type": "string", "description": "Transcript text for this segment." }, "speaker": { "type": "string", "description": "Speaker label for this segment." } }, "required": [ "type", "id", "start", "end", "text", "speaker" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "TranscriptTextUsageDuration": { "type": "object", "title": "Duration Usage", "description": "Usage statistics for models billed by audio input duration.", "properties": { "type": { "type": "string", "enum": [ "duration" ], "description": "The type of the usage object. Always `duration` for this variant." }, "seconds": { "type": "number", "format": "double", "description": "Duration of the input audio in seconds." } }, "required": [ "type", "seconds" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "TranscriptTextUsageTokens": { "type": "object", "title": "Token Usage", "description": "Usage statistics for models billed by token usage.", "properties": { "type": { "type": "string", "enum": [ "tokens" ], "description": "The type of the usage object. Always `tokens` for this variant." }, "input_tokens": { "type": "integer", "description": "Number of input tokens billed for this request." }, "input_token_details": { "type": "object", "description": "Details about the input tokens billed for this request.", "properties": { "text_tokens": { "type": "integer", "description": "Number of text tokens billed for this request." }, "audio_tokens": { "type": "integer", "description": "Number of audio tokens billed for this request." } } }, "output_tokens": { "type": "integer", "description": "Number of output tokens generated." }, "total_tokens": { "type": "integer", "description": "Total number of tokens used (input + output)." } }, "required": [ "type", "input_tokens", "output_tokens", "total_tokens" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "TranscriptionDiarizedSegment": { "type": "object", "description": "A segment of diarized transcript text with speaker metadata.", "properties": { "type": { "type": "string", "description": "The type of the segment. Always `transcript.text.segment`.\n", "enum": [ "transcript.text.segment" ] }, "id": { "type": "string", "description": "Unique identifier for the segment." }, "start": { "type": "number", "format": "double", "description": "Start timestamp of the segment in seconds." }, "end": { "type": "number", "format": "double", "description": "End timestamp of the segment in seconds." }, "text": { "type": "string", "description": "Transcript text for this segment." }, "speaker": { "type": "string", "description": "Speaker label for this segment. When known speakers are provided, the label matches `known_speaker_names[]`. Otherwise speakers are labeled sequentially using capital letters (`A`, `B`, ...).\n" } }, "required": [ "type", "id", "start", "end", "text", "speaker" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "TranscriptionInclude": { "type": "string", "enum": [ "logprobs" ], "default": [], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "TranscriptionLanguage": { "type": "object", "description": "A language detected in transcribed audio.", "properties": { "code": { "type": "string", "description": "The code of a language detected in the audio." } }, "required": [ "code" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "TranscriptionSegment": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the segment." }, "seek": { "type": "integer", "description": "Seek offset of the segment." }, "start": { "type": "number", "format": "double", "description": "Start time of the segment in seconds." }, "end": { "type": "number", "format": "double", "description": "End time of the segment in seconds." }, "text": { "type": "string", "description": "Text content of the segment." }, "tokens": { "type": "array", "items": { "type": "integer" }, "description": "Array of token IDs for the text content." }, "temperature": { "type": "number", "format": "float", "description": "Temperature parameter used for generating the segment." }, "avg_logprob": { "type": "number", "format": "float", "description": "Average logprob of the segment. If the value is lower than -1, consider the logprobs failed." }, "compression_ratio": { "type": "number", "format": "float", "description": "Compression ratio of the segment. If the value is greater than 2.4, consider the compression failed." }, "no_speech_prob": { "type": "number", "format": "float", "description": "Probability of no speech in the segment. If the value is higher than 1.0 and the `avg_logprob` is below -1, consider this segment silent." } }, "required": [ "id", "seek", "start", "end", "text", "tokens", "temperature", "avg_logprob", "compression_ratio", "no_speech_prob" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "TranscriptionWord": { "type": "object", "properties": { "word": { "type": "string", "description": "The text content of the word." }, "start": { "type": "number", "format": "double", "description": "Start time of the word in seconds." }, "end": { "type": "number", "format": "double", "description": "End time of the word in seconds." } }, "required": [ "word", "start", "end" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "VadConfig": { "type": "object", "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "server_vad" ], "description": "Must be set to `server_vad` to enable manual chunking using server side VAD." }, "prefix_padding_ms": { "type": "integer", "default": 300, "description": "Amount of audio to include before the VAD detected speech (in \nmilliseconds).\n" }, "silence_duration_ms": { "type": "integer", "default": 200, "description": "Duration of silence to detect speech stop (in milliseconds).\nWith shorter values the model will respond more quickly, \nbut may jump in on short pauses from the user.\n" }, "threshold": { "type": "number", "default": 0.5, "description": "Sensitivity threshold (0.0 to 1.0) for voice activity detection. A \nhigher threshold will require louder audio to activate the model, and \nthus might perform better in noisy environments.\n" } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "VectorStoreFileAttributes": { "anyOf": [ { "type": "object", "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard. Keys are strings\nwith a maximum length of 64 characters. Values are strings with a maximum\nlength of 512 characters, booleans, or numbers.\n", "maxProperties": 16, "propertyNames": { "type": "string", "maxLength": 64 }, "additionalProperties": { "oneOf": [ { "type": "string", "maxLength": 512 }, { "type": "number" }, { "type": "boolean" } ] } }, { "type": "null" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "Verbosity": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high" ], "default": "medium", "description": "Constrains the verbosity of the model's response. Lower values will result in\nmore concise responses, while higher values will result in more verbose responses.\nCurrently supported values are `low`, `medium`, and `high`. The default is\n`medium`.\n" }, { "type": "null" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "VoiceIdsOrCustomVoice": { "title": "Voice", "description": "A built-in voice name or a custom voice reference.\n", "anyOf": [ { "$ref": "#/components/schemas/VoiceIdsShared" }, { "type": "object", "description": "Custom voice reference.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The custom voice ID, e.g. `voice_1234`.", "example": "voice_1234" } } } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "VoiceIdsShared": { "example": "ash", "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "alloy", "ash", "ballad", "coral", "echo", "sage", "shimmer", "verse", "marin", "cedar" ] } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "WebSearchActionFind": { "type": "object", "title": "Find action", "description": "Action type \"find_in_page\": Searches for a pattern within a loaded page.\n", "properties": { "type": { "type": "string", "enum": [ "find_in_page" ], "description": "The action type.\n" }, "url": { "type": "string", "format": "uri", "description": "The URL of the page searched for the pattern.\n" }, "pattern": { "type": "string", "description": "The pattern or text to search for within the page.\n" } }, "required": [ "type", "url", "pattern" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "WebSearchActionOpenPage": { "type": "object", "title": "Open page action", "description": "Action type \"open_page\" - Opens a specific URL from search results.\n", "properties": { "type": { "type": "string", "enum": [ "open_page" ], "description": "The action type.\n" }, "url": { "description": "The URL opened by the model.\n", "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] } }, "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "WebSearchActionSearch": { "type": "object", "title": "Search action", "description": "Action type \"search\" - Performs a web search query.\n", "properties": { "type": { "type": "string", "enum": [ "search" ], "description": "The action type.\n" }, "query": { "type": "string", "deprecated": true, "description": "The search query.\n" }, "queries": { "type": "array", "title": "Search queries", "description": "The search queries.\n", "items": { "type": "string", "description": "A search query.\n" } }, "sources": { "type": "array", "title": "Web search sources", "description": "The sources used in the search.\n", "items": { "type": "object", "title": "Web search source", "description": "A source used in the search.\n", "properties": { "type": { "type": "string", "enum": [ "url" ], "description": "The type of source. Always `url`.\n" }, "url": { "type": "string", "format": "uri", "description": "The URL of the source.\n" } }, "required": [ "type", "url" ] } } }, "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "WebSearchApproximateLocation": { "anyOf": [ { "type": "object", "title": "Web search approximate location", "description": "The approximate location of the user.\n", "properties": { "type": { "type": "string", "enum": [ "approximate" ], "description": "The type of location approximation. Always `approximate`.", "default": "approximate" }, "country": { "anyOf": [ { "type": "string", "description": "The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`." }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string", "description": "Free text input for the region of the user, e.g. `California`." }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "description": "Free text input for the city of the user, e.g. `San Francisco`." }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string", "description": "The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`." }, { "type": "null" } ] } } }, { "type": "null" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "WebSearchContextSize": { "type": "string", "description": "High level guidance for the amount of context window space to use for the \nsearch. One of `low`, `medium`, or `high`. `medium` is the default.\n", "enum": [ "low", "medium", "high" ], "default": "medium", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "WebSearchLocation": { "type": "object", "title": "Web search location", "description": "Approximate location parameters for the search.", "properties": { "country": { "type": "string", "description": "The two-letter \n[ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user,\ne.g. `US`.\n" }, "region": { "type": "string", "description": "Free text input for the region of the user, e.g. `California`.\n" }, "city": { "type": "string", "description": "Free text input for the city of the user, e.g. `San Francisco`.\n" }, "timezone": { "type": "string", "description": "The [IANA timezone](https://timeapi.io/documentation/iana-timezones) \nof the user, e.g. `America/Los_Angeles`.\n" } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "WebSearchTool": { "type": "object", "title": "Web search", "description": "Search the Internet for sources related to the prompt. Learn more about the\n[web search tool](/docs/guides/tools-web-search).\n", "properties": { "type": { "type": "string", "enum": [ "web_search", "web_search_2025_08_26" ], "description": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.", "default": "web_search" }, "filters": { "anyOf": [ { "type": "object", "description": "Filters for the search.\n", "properties": { "allowed_domains": { "anyOf": [ { "type": "array", "title": "Allowed domains for the search.", "description": "Allowed domains for the search. If not provided, all domains are allowed.\nSubdomains of the provided domains are allowed as well.\n\nExample: `[\"pubmed.ncbi.nlm.nih.gov\"]`\n", "items": { "type": "string", "description": "Allowed domain for the search." }, "default": [] }, { "type": "null" } ] } } }, { "type": "null" } ] }, "user_location": { "$ref": "#/components/schemas/WebSearchApproximateLocation" }, "search_context_size": { "type": "string", "enum": [ "low", "medium", "high" ], "default": "medium", "description": "High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default." } }, "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "WebSearchToolCall": { "type": "object", "title": "Web search tool call", "description": "The results of a web search tool call. See the\n[web search guide](/docs/guides/tools-web-search) for more information.\n", "properties": { "id": { "type": "string", "description": "The unique ID of the web search tool call.\n" }, "type": { "type": "string", "enum": [ "web_search_call" ], "description": "The type of the web search tool call. Always `web_search_call`.\n" }, "status": { "type": "string", "description": "The status of the web search tool call.\n", "enum": [ "in_progress", "searching", "completed", "failed" ] }, "action": { "type": "object", "description": "An object describing the specific action taken in this web search call.\nIncludes details on how the model used the web (search, open_page, find_in_page).\n", "oneOf": [ { "$ref": "#/components/schemas/WebSearchActionSearch" }, { "$ref": "#/components/schemas/WebSearchActionOpenPage" }, { "$ref": "#/components/schemas/WebSearchActionFind" } ], "discriminator": { "propertyName": "type" } } }, "required": [ "id", "type", "status", "action" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ModerationInputType": { "type": "string", "enum": [ "text", "image" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ModerationResultBody": { "properties": { "type": { "type": "string", "enum": [ "moderation_result" ], "description": "The object type, which was always `moderation_result` for successful moderation results.", "default": "moderation_result" }, "model": { "type": "string", "description": "The moderation model that produced this result." }, "flagged": { "type": "boolean", "description": "A boolean indicating whether the content was flagged by any category." }, "categories": { "additionalProperties": { "type": "boolean" }, "type": "object", "description": "A dictionary of moderation categories to booleans, True if the input is flagged under this category." }, "category_scores": { "additionalProperties": { "type": "number" }, "type": "object", "description": "A dictionary of moderation categories to scores." }, "category_applied_input_types": { "additionalProperties": { "items": { "$ref": "#/components/schemas/ModerationInputType" }, "type": "array" }, "type": "object", "description": "Which modalities of input are reflected by the score for each category." } }, "type": "object", "required": [ "type", "model", "flagged", "categories", "category_scores", "category_applied_input_types" ], "title": "Moderation result", "description": "A moderation result produced for the response input or output.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "PromptCacheTTLEnum": { "type": "string", "enum": [ "30m" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "PromptCacheModeEnum": { "type": "string", "enum": [ "implicit", "explicit" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "PromptCacheOptionsParam": { "properties": { "ttl": { "$ref": "#/components/schemas/PromptCacheTTLEnum", "description": "The minimum lifetime applied to every implicit and explicit cache breakpoint written by the request. Defaults to `30m`, which is currently the only supported value. The backend may retain cache entries for longer." }, "mode": { "$ref": "#/components/schemas/PromptCacheModeEnum", "description": "Controls whether OpenAI automatically creates an implicit cache breakpoint. Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint and writes up to the latest three explicit breakpoints in the request. With `explicit`, OpenAI does not create an implicit breakpoint and writes up to the latest four explicit breakpoints. If there are no explicit breakpoints, the request does not use prompt caching." } }, "type": "object", "required": [], "title": "Prompt cache options", "description": "Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](/docs/guides/prompt-caching) for current details.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "PromptCacheBreakpointParam": { "properties": { "mode": { "type": "string", "enum": [ "explicit" ], "description": "The breakpoint mode. Always `explicit`.", "default": "explicit" } }, "type": "object", "required": [ "mode" ], "title": "Prompt cache breakpoint", "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ModerationMode": { "type": "string", "enum": [ "score", "block" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ModerationConfigParam": { "properties": { "mode": { "$ref": "#/components/schemas/ModerationMode" } }, "type": "object", "required": [ "mode" ], "description": "The moderation policy for the response input.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ModerationPolicyParam": { "properties": { "input": { "anyOf": [ { "$ref": "#/components/schemas/ModerationConfigParam", "description": "The moderation policy for the response input." }, { "type": "null" } ] }, "output": { "anyOf": [ { "$ref": "#/components/schemas/ModerationConfigParam", "description": "The moderation policy for the response output." }, { "type": "null" } ] } }, "type": "object", "required": [], "description": "The policy to apply to moderated response input and output.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ModerationParam": { "properties": { "model": { "type": "string", "description": "The moderation model to use for moderated completions, e.g. 'omni-moderation-latest'." }, "policy": { "anyOf": [ { "$ref": "#/components/schemas/ModerationPolicyParam", "description": "The policy to apply to moderated response input and output." }, { "type": "null" } ] } }, "type": "object", "required": [ "model" ], "description": "Configuration for running moderation on the input and output of this response.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "SkillReferenceParam": { "properties": { "type": { "type": "string", "enum": [ "skill_reference" ], "description": "References a skill created with the /v1/skills endpoint.", "default": "skill_reference" }, "skill_id": { "type": "string", "maxLength": 64, "minLength": 1, "description": "The ID of the referenced skill." }, "version": { "type": "string", "description": "Optional skill version. Use a positive integer or 'latest'. Omit for default." } }, "type": "object", "required": [ "type", "skill_id" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "InlineSkillSourceParam": { "properties": { "type": { "type": "string", "enum": [ "base64" ], "description": "The type of the inline skill source. Must be `base64`.", "default": "base64" }, "media_type": { "type": "string", "enum": [ "application/zip" ], "description": "The media type of the inline skill payload. Must be `application/zip`.", "default": "application/zip" }, "data": { "type": "string", "maxLength": 70254592, "minLength": 1, "description": "Base64-encoded skill zip bundle." } }, "type": "object", "required": [ "type", "media_type", "data" ], "description": "Inline skill payload", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "InlineSkillParam": { "properties": { "type": { "type": "string", "enum": [ "inline" ], "description": "Defines an inline skill for this request.", "default": "inline" }, "name": { "type": "string", "description": "The name of the skill." }, "description": { "type": "string", "description": "The description of the skill." }, "source": { "$ref": "#/components/schemas/InlineSkillSourceParam", "description": "Inline skill payload" } }, "type": "object", "required": [ "type", "name", "description", "source" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ContainerNetworkPolicyDisabledParam": { "properties": { "type": { "type": "string", "enum": [ "disabled" ], "description": "Disable outbound network access. Always `disabled`.", "default": "disabled" } }, "type": "object", "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ContainerNetworkPolicyDomainSecretParam": { "properties": { "domain": { "type": "string", "minLength": 1, "description": "The domain associated with the secret." }, "name": { "type": "string", "minLength": 1, "description": "The name of the secret to inject for the domain." }, "value": { "type": "string", "maxLength": 10485760, "minLength": 1, "description": "The secret value to inject for the domain." } }, "type": "object", "required": [ "domain", "name", "value" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ContainerNetworkPolicyAllowlistParam": { "properties": { "type": { "type": "string", "enum": [ "allowlist" ], "description": "Allow outbound network access only to specified domains. Always `allowlist`.", "default": "allowlist" }, "allowed_domains": { "items": { "type": "string" }, "type": "array", "minItems": 1, "description": "A list of allowed domains when type is `allowlist`." }, "domain_secrets": { "items": { "$ref": "#/components/schemas/ContainerNetworkPolicyDomainSecretParam" }, "type": "array", "minItems": 1, "description": "Optional domain-scoped secrets for allowlisted domains." } }, "type": "object", "required": [ "type", "allowed_domains" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "IncludeEnum": { "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" ], "description": "Specify additional output data to include in the model response. Currently supported values are:\n- `web_search_call.results`: Include the search results of the web search tool call.\n- `web_search_call.action.sources`: Include the sources of the web search tool call.\n- `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.\n- `computer_call_output.output.image_url`: Include image urls from the computer call output.\n- `file_search_call.results`: Include the search results of the file search tool call.\n- `message.input_image.image_url`: Include image urls from the input message.\n- `message.output_text.logprobs`: Include logprobs with assistant messages.\n- `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program).", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "MessageRole": { "type": "string", "enum": [ "unknown", "user", "assistant", "system", "critic", "discriminator", "developer", "tool" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "PromptCacheBreakpointConfig": { "properties": { "mode": { "type": "string", "enum": [ "explicit" ], "description": "The breakpoint mode. Always `explicit`.", "default": "explicit" } }, "type": "object", "required": [ "mode" ], "title": "Prompt cache breakpoint", "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "InputTextContent": { "properties": { "type": { "type": "string", "enum": [ "input_text" ], "description": "The type of the input item. Always `input_text`.", "default": "input_text" }, "text": { "type": "string", "description": "The text input to the model." }, "prompt_cache_breakpoint": { "$ref": "#/components/schemas/PromptCacheBreakpointConfig" }, "cache_control": { "additionalProperties": false, "properties": { "ttl": { "description": "The time-to-live for the cache control breakpoint.\n\nThis may be one the following values:\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.", "enum": [ "5m", "1h" ], "title": "Ttl", "type": "string" }, "type": { "const": "ephemeral", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "CacheControlEphemeral", "type": "object", "description": "Anthropic prompt-cache breakpoint. When set on a content block,\neverything from the conversation start up through that block is\ncached on Anthropic's servers (5m or 1h TTL — see the `ttl` field).\nCurrently supported for Anthropic / Bedrock only; ignored by other\nproviders.\n", "x-source": { "from": "avs://anthropic/official", "authority": "official" }, "x-providers-default": "drop", "x-providers": { "anthropic": {}, "bedrock": {} } } }, "type": "object", "required": [ "type", "text" ], "title": "Input text", "description": "A text input to the model.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FileCitationBody": { "properties": { "type": { "type": "string", "enum": [ "file_citation" ], "description": "The type of the file citation. Always `file_citation`.", "default": "file_citation" }, "file_id": { "type": "string", "description": "The ID of the file." }, "index": { "type": "integer", "description": "The index of the file in the list of files." }, "filename": { "type": "string", "description": "The filename of the file cited." } }, "type": "object", "required": [ "type", "file_id", "index", "filename" ], "title": "File citation", "description": "A citation to a file.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "UrlCitationBody": { "properties": { "type": { "type": "string", "enum": [ "url_citation" ], "description": "The type of the URL citation. Always `url_citation`.", "default": "url_citation" }, "url": { "type": "string", "format": "uri", "description": "The URL of the web resource." }, "start_index": { "type": "integer", "description": "The index of the first character of the URL citation in the message." }, "end_index": { "type": "integer", "description": "The index of the last character of the URL citation in the message." }, "title": { "type": "string", "description": "The title of the web resource." } }, "type": "object", "required": [ "type", "url", "start_index", "end_index", "title" ], "title": "URL citation", "description": "A citation for a web resource used to generate a model response.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ContainerFileCitationBody": { "properties": { "type": { "type": "string", "enum": [ "container_file_citation" ], "description": "The type of the container file citation. Always `container_file_citation`.", "default": "container_file_citation" }, "container_id": { "type": "string", "description": "The ID of the container file." }, "file_id": { "type": "string", "description": "The ID of the file." }, "start_index": { "type": "integer", "description": "The index of the first character of the container file citation in the message." }, "end_index": { "type": "integer", "description": "The index of the last character of the container file citation in the message." }, "filename": { "type": "string", "description": "The filename of the container file cited." } }, "type": "object", "required": [ "type", "container_id", "file_id", "start_index", "end_index", "filename" ], "title": "Container file citation", "description": "A citation for a container file used to generate a model response.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "Annotation": { "oneOf": [ { "$ref": "#/components/schemas/FileCitationBody" }, { "$ref": "#/components/schemas/UrlCitationBody" }, { "$ref": "#/components/schemas/ContainerFileCitationBody" }, { "$ref": "#/components/schemas/FilePath" } ], "description": "An annotation that applies to a span of output text.", "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "TopLogProb": { "properties": { "token": { "type": "string" }, "logprob": { "type": "number" }, "bytes": { "items": { "type": "integer" }, "type": "array" } }, "type": "object", "required": [ "token", "logprob", "bytes" ], "title": "Top log probability", "description": "The top log probability of a token.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "LogProb": { "properties": { "token": { "type": "string" }, "logprob": { "type": "number" }, "bytes": { "items": { "type": "integer" }, "type": "array" }, "top_logprobs": { "items": { "$ref": "#/components/schemas/TopLogProb" }, "type": "array" } }, "type": "object", "required": [ "token", "logprob", "bytes", "top_logprobs" ], "title": "Log probability", "description": "The log probability of a token.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "OutputTextContent": { "properties": { "type": { "type": "string", "enum": [ "output_text" ], "description": "The type of the output text. Always `output_text`.", "default": "output_text" }, "text": { "type": "string", "description": "The text output from the model." }, "annotations": { "items": { "$ref": "#/components/schemas/Annotation" }, "type": "array", "description": "The annotations of the text output." }, "logprobs": { "items": { "$ref": "#/components/schemas/LogProb" }, "type": "array" } }, "type": "object", "required": [ "type", "text", "annotations", "logprobs" ], "title": "Output text", "description": "A text output from the model.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "SummaryTextContent": { "properties": { "type": { "type": "string", "enum": [ "summary_text" ], "description": "The type of the object. Always `summary_text`.", "default": "summary_text" }, "text": { "type": "string", "description": "A summary of the reasoning output from the model so far." } }, "type": "object", "required": [ "type", "text" ], "title": "Summary text", "description": "A summary text from the model.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ReasoningTextContent": { "properties": { "type": { "type": "string", "enum": [ "reasoning_text" ], "description": "The type of the reasoning text. Always `reasoning_text`.", "default": "reasoning_text" }, "text": { "type": "string", "description": "The reasoning text from the model." } }, "type": "object", "required": [ "type", "text" ], "title": "Reasoning text", "description": "Reasoning text from the model.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "RefusalContent": { "properties": { "type": { "type": "string", "enum": [ "refusal" ], "description": "The type of the refusal. Always `refusal`.", "default": "refusal" }, "refusal": { "type": "string", "description": "The refusal explanation from the model." } }, "type": "object", "required": [ "type", "refusal" ], "title": "Refusal", "description": "A refusal from the model.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ImageDetail": { "type": "string", "enum": [ "low", "high", "auto", "original" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "InputImageContent": { "properties": { "type": { "type": "string", "enum": [ "input_image" ], "description": "The type of the input item. Always `input_image`.", "default": "input_image" }, "image_url": { "anyOf": [ { "type": "string", "format": "uri", "description": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL." }, { "type": "null" } ] }, "file_id": { "anyOf": [ { "type": "string", "description": "The ID of the file to be sent to the model." }, { "type": "null" } ] }, "detail": { "$ref": "#/components/schemas/ImageDetail", "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." }, "prompt_cache_breakpoint": { "$ref": "#/components/schemas/PromptCacheBreakpointConfig" }, "cache_control": { "additionalProperties": false, "properties": { "ttl": { "description": "The time-to-live for the cache control breakpoint.\n\nThis may be one the following values:\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.", "enum": [ "5m", "1h" ], "title": "Ttl", "type": "string" }, "type": { "const": "ephemeral", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "CacheControlEphemeral", "type": "object", "description": "Anthropic prompt-cache breakpoint. When set on a content block,\neverything from the conversation start up through that block is\ncached on Anthropic's servers (5m or 1h TTL — see the `ttl` field).\nCurrently supported for Anthropic / Bedrock only; ignored by other\nproviders.\n", "x-source": { "from": "avs://anthropic/official", "authority": "official" }, "x-providers-default": "drop", "x-providers": { "anthropic": {}, "bedrock": {} } } }, "type": "object", "required": [ "type", "detail" ], "title": "Input image", "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FileInputDetail": { "type": "string", "enum": [ "auto", "low", "high" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "InputFileContent": { "properties": { "type": { "type": "string", "enum": [ "input_file" ], "description": "The type of the input item. Always `input_file`.", "default": "input_file" }, "file_id": { "anyOf": [ { "type": "string", "description": "The ID of the file to be sent to the model." }, { "type": "null" } ] }, "filename": { "type": "string", "description": "The name of the file to be sent to the model." }, "file_data": { "type": "string", "description": "The content of the file to be sent to the model.\n" }, "prompt_cache_breakpoint": { "$ref": "#/components/schemas/PromptCacheBreakpointConfig" }, "file_url": { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, "detail": { "$ref": "#/components/schemas/FileInputDetail", "description": "The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`." }, "cache_control": { "additionalProperties": false, "properties": { "ttl": { "description": "The time-to-live for the cache control breakpoint.\n\nThis may be one the following values:\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.", "enum": [ "5m", "1h" ], "title": "Ttl", "type": "string" }, "type": { "const": "ephemeral", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "CacheControlEphemeral", "type": "object", "description": "Anthropic prompt-cache breakpoint. When set on a content block,\neverything from the conversation start up through that block is\ncached on Anthropic's servers (5m or 1h TTL — see the `ttl` field).\nCurrently supported for Anthropic / Bedrock only; ignored by other\nproviders.\n", "x-source": { "from": "avs://anthropic/official", "authority": "official" }, "x-providers-default": "drop", "x-providers": { "anthropic": {}, "bedrock": {} } } }, "type": "object", "required": [ "type" ], "title": "Input file", "description": "A file input to the model.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "DirectToolCallCaller": { "properties": { "type": { "type": "string", "enum": [ "direct" ], "default": "direct" } }, "type": "object", "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ProgramToolCallCaller": { "properties": { "type": { "type": "string", "enum": [ "program" ], "default": "program" }, "caller_id": { "type": "string", "description": "The call ID of the program item that produced this tool call." } }, "type": "object", "required": [ "type", "caller_id" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ToolCallCaller": { "oneOf": [ { "$ref": "#/components/schemas/DirectToolCallCaller" }, { "$ref": "#/components/schemas/ProgramToolCallCaller" } ], "description": "The execution context that produced this tool call.", "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionCallStatus": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "DirectToolCallCallerParam": { "properties": { "type": { "type": "string", "enum": [ "direct" ], "description": "The caller type. Always `direct`.", "default": "direct" } }, "type": "object", "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ProgramToolCallCallerParam": { "properties": { "type": { "type": "string", "enum": [ "program" ], "description": "The caller type. Always `program`.", "default": "program" }, "caller_id": { "type": "string", "maxLength": 64, "minLength": 1, "description": "The call ID of the program item that produced this tool call." } }, "type": "object", "required": [ "type", "caller_id" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ToolCallCallerParam": { "oneOf": [ { "$ref": "#/components/schemas/DirectToolCallCallerParam" }, { "$ref": "#/components/schemas/ProgramToolCallCallerParam" } ], "description": "The execution context that produced this tool call.", "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionCallOutputStatusEnum": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ClickButtonType": { "type": "string", "enum": [ "left", "right", "wheel", "back", "forward" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ClickParam": { "properties": { "type": { "type": "string", "enum": [ "click" ], "description": "Specifies the event type. For a click action, this property is always `click`.", "default": "click" }, "button": { "$ref": "#/components/schemas/ClickButtonType", "description": "Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`." }, "x": { "type": "integer", "description": "The x-coordinate where the click occurred." }, "y": { "type": "integer", "description": "The y-coordinate where the click occurred." }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "description": "The keys being held while clicking." }, { "type": "null" } ] } }, "type": "object", "required": [ "type", "button", "x", "y" ], "title": "Click", "description": "A click action.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "DoubleClickAction": { "properties": { "type": { "type": "string", "enum": [ "double_click" ], "description": "Specifies the event type. For a double click action, this property is always set to `double_click`.", "default": "double_click" }, "x": { "type": "integer", "description": "The x-coordinate where the double click occurred." }, "y": { "type": "integer", "description": "The y-coordinate where the double click occurred." }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "description": "The keys being held while double-clicking." }, { "type": "null" } ] } }, "type": "object", "required": [ "type", "x", "y", "keys" ], "title": "DoubleClick", "description": "A double click action.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CoordParam": { "properties": { "x": { "type": "integer", "description": "The x-coordinate." }, "y": { "type": "integer", "description": "The y-coordinate." } }, "type": "object", "required": [ "x", "y" ], "title": "Coordinate", "description": "An x/y coordinate pair, e.g. `{ x: 100, y: 200 }`.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "DragParam": { "properties": { "type": { "type": "string", "enum": [ "drag" ], "description": "Specifies the event type. For a drag action, this property is always set to `drag`.", "default": "drag" }, "path": { "items": { "$ref": "#/components/schemas/CoordParam" }, "type": "array", "description": "An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg\n```\n[\n { x: 100, y: 200 },\n { x: 200, y: 300 }\n]\n```" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "description": "The keys being held while dragging the mouse." }, { "type": "null" } ] } }, "type": "object", "required": [ "type", "path" ], "title": "Drag", "description": "A drag action.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "KeyPressAction": { "properties": { "type": { "type": "string", "enum": [ "keypress" ], "description": "Specifies the event type. For a keypress action, this property is always set to `keypress`.", "default": "keypress" }, "keys": { "items": { "type": "string", "description": "One of the keys the model is requesting to be pressed." }, "type": "array", "description": "The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key." } }, "type": "object", "required": [ "type", "keys" ], "title": "KeyPress", "description": "A collection of keypresses the model would like to perform.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "MoveParam": { "properties": { "type": { "type": "string", "enum": [ "move" ], "description": "Specifies the event type. For a move action, this property is always set to `move`.", "default": "move" }, "x": { "type": "integer", "description": "The x-coordinate to move to." }, "y": { "type": "integer", "description": "The y-coordinate to move to." }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "description": "The keys being held while moving the mouse." }, { "type": "null" } ] } }, "type": "object", "required": [ "type", "x", "y" ], "title": "Move", "description": "A mouse move action.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ScreenshotParam": { "properties": { "type": { "type": "string", "enum": [ "screenshot" ], "description": "Specifies the event type. For a screenshot action, this property is always set to `screenshot`.", "default": "screenshot" } }, "type": "object", "required": [ "type" ], "title": "Screenshot", "description": "A screenshot action.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ScrollParam": { "properties": { "type": { "type": "string", "enum": [ "scroll" ], "description": "Specifies the event type. For a scroll action, this property is always set to `scroll`.", "default": "scroll" }, "x": { "type": "integer", "description": "The x-coordinate where the scroll occurred." }, "y": { "type": "integer", "description": "The y-coordinate where the scroll occurred." }, "scroll_x": { "type": "integer", "description": "The horizontal scroll distance." }, "scroll_y": { "type": "integer", "description": "The vertical scroll distance." }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "description": "The keys being held while scrolling." }, { "type": "null" } ] } }, "type": "object", "required": [ "type", "x", "y", "scroll_x", "scroll_y" ], "title": "Scroll", "description": "A scroll action.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "TypeParam": { "properties": { "type": { "type": "string", "enum": [ "type" ], "description": "Specifies the event type. For a type action, this property is always set to `type`.", "default": "type" }, "text": { "type": "string", "description": "The text to type." } }, "type": "object", "required": [ "type", "text" ], "title": "Type", "description": "An action to type in text.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "WaitParam": { "properties": { "type": { "type": "string", "enum": [ "wait" ], "description": "Specifies the event type. For a wait action, this property is always set to `wait`.", "default": "wait" } }, "type": "object", "required": [ "type" ], "title": "Wait", "description": "A wait action.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ComputerCallSafetyCheckParam": { "properties": { "id": { "type": "string", "description": "The ID of the pending safety check." }, "code": { "anyOf": [ { "type": "string", "description": "The type of the pending safety check." }, { "type": "null" } ] }, "message": { "anyOf": [ { "type": "string", "description": "Details about the pending safety check." }, { "type": "null" } ] } }, "type": "object", "required": [ "id" ], "description": "A pending safety check for the computer call.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ComputerCallOutputStatus": { "type": "string", "enum": [ "completed", "incomplete", "failed" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ToolSearchExecutionType": { "type": "string", "enum": [ "server", "client" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ToolSearchCall": { "properties": { "type": { "type": "string", "enum": [ "tool_search_call" ], "description": "The type of the item. Always `tool_search_call`.", "default": "tool_search_call" }, "id": { "type": "string", "description": "The unique ID of the tool search call item." }, "call_id": { "anyOf": [ { "type": "string", "description": "The unique ID of the tool search call generated by the model." }, { "type": "null" } ] }, "execution": { "$ref": "#/components/schemas/ToolSearchExecutionType", "description": "Whether tool search was executed by the server or by the client." }, "arguments": { "description": "Arguments used for the tool search call." }, "status": { "$ref": "#/components/schemas/FunctionCallStatus", "description": "The status of the tool search call item that was recorded." }, "created_by": { "type": "string", "description": "The identifier of the actor that created the item." } }, "type": "object", "required": [ "type", "id", "call_id", "execution", "arguments", "status" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CallableToolAllowedCaller": { "type": "string", "enum": [ "direct", "programmatic" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionTool": { "properties": { "type": { "type": "string", "enum": [ "function" ], "description": "The type of the function tool. Always `function`.", "default": "function" }, "name": { "type": "string", "description": "The name of the function to call." }, "description": { "anyOf": [ { "type": "string", "description": "A description of the function. Used by the model to determine whether or not to call the function." }, { "type": "null" } ] }, "parameters": { "anyOf": [ { "additionalProperties": {}, "type": "object", "description": "A JSON schema object describing the parameters of the function." }, { "type": "null" } ] }, "output_schema": { "anyOf": [ { "additionalProperties": {}, "type": "object", "description": "A JSON schema object describing the JSON value encoded in string outputs for this function." }, { "type": "null" } ] }, "strict": { "anyOf": [ { "type": "boolean", "description": "Whether strict parameter validation is enforced for this function tool." }, { "type": "null" } ] }, "defer_loading": { "type": "boolean", "description": "Whether this function is deferred and loaded via tool search." }, "allowed_callers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CallableToolAllowedCaller" }, "type": "array", "description": "The tool invocation context(s)." }, { "type": "null" } ] }, "cache_control": { "additionalProperties": false, "properties": { "ttl": { "description": "The time-to-live for the cache control breakpoint.\n\nThis may be one the following values:\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.", "enum": [ "5m", "1h" ], "title": "Ttl", "type": "string" }, "type": { "const": "ephemeral", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "CacheControlEphemeral", "type": "object", "description": "Per-tool prompt-cache breakpoint. When set on a tool, everything\nfrom the conversation start up through that tool definition is\ncached. Currently supported for Anthropic / Bedrock only.\n", "x-source": { "from": "avs://anthropic/official", "authority": "official" } } }, "type": "object", "required": [ "type", "name", "strict", "parameters" ], "title": "Function", "description": "Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "RankerVersionType": { "type": "string", "enum": [ "auto", "default-2024-11-15" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "HybridSearchOptions": { "properties": { "embedding_weight": { "type": "number", "description": "The weight of the embedding in the reciprocal ranking fusion." }, "text_weight": { "type": "number", "description": "The weight of the text in the reciprocal ranking fusion." } }, "type": "object", "required": [ "embedding_weight", "text_weight" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "RankingOptions": { "properties": { "ranker": { "$ref": "#/components/schemas/RankerVersionType", "description": "The ranker to use for the file search." }, "score_threshold": { "type": "number", "description": "The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results." }, "hybrid_search": { "$ref": "#/components/schemas/HybridSearchOptions", "description": "Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled." } }, "type": "object", "required": [], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "Filters": { "anyOf": [ { "$ref": "#/components/schemas/ComparisonFilter" }, { "$ref": "#/components/schemas/CompoundFilter" } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FileSearchTool": { "properties": { "type": { "type": "string", "enum": [ "file_search" ], "description": "The type of the file search tool. Always `file_search`.", "default": "file_search" }, "vector_store_ids": { "items": { "type": "string" }, "type": "array", "description": "The IDs of the vector stores to search." }, "max_num_results": { "type": "integer", "description": "The maximum number of results to return. This number should be between 1 and 50 inclusive." }, "ranking_options": { "$ref": "#/components/schemas/RankingOptions", "description": "Ranking options for search." }, "filters": { "anyOf": [ { "$ref": "#/components/schemas/Filters", "description": "A filter to apply." }, { "type": "null" } ] } }, "type": "object", "required": [ "type", "vector_store_ids" ], "title": "File search", "description": "A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search).", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ComputerTool": { "properties": { "type": { "type": "string", "enum": [ "computer" ], "description": "The type of the computer tool. Always `computer`.", "default": "computer" } }, "type": "object", "required": [ "type" ], "title": "Computer", "description": "A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ComputerEnvironment": { "type": "string", "enum": [ "windows", "mac", "linux", "ubuntu", "browser" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ComputerUsePreviewTool": { "properties": { "type": { "type": "string", "enum": [ "computer_use_preview" ], "description": "The type of the computer use tool. Always `computer_use_preview`.", "default": "computer_use_preview" }, "environment": { "$ref": "#/components/schemas/ComputerEnvironment", "description": "The type of computer environment to control." }, "display_width": { "type": "integer", "description": "The width of the computer display." }, "display_height": { "type": "integer", "description": "The height of the computer display." } }, "type": "object", "required": [ "type", "environment", "display_width", "display_height" ], "title": "Computer use preview", "description": "A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ContainerMemoryLimit": { "type": "string", "enum": [ "1g", "4g", "16g", "64g" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "AutoCodeInterpreterToolParam": { "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Always `auto`.", "default": "auto" }, "file_ids": { "items": { "type": "string", "example": "file-123" }, "type": "array", "maxItems": 50, "description": "An optional list of uploaded files to make available to your code." }, "memory_limit": { "anyOf": [ { "$ref": "#/components/schemas/ContainerMemoryLimit", "description": "The memory limit for the code interpreter container." }, { "type": "null" } ] }, "network_policy": { "oneOf": [ { "$ref": "#/components/schemas/ContainerNetworkPolicyDisabledParam" }, { "$ref": "#/components/schemas/ContainerNetworkPolicyAllowlistParam" } ], "description": "Network access policy for the container.", "discriminator": { "propertyName": "type" } } }, "type": "object", "required": [ "type" ], "title": "CodeInterpreterToolAuto", "description": "Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ProgrammaticToolCallingParam": { "properties": { "type": { "type": "string", "enum": [ "programmatic_tool_calling" ], "description": "The type of the tool. Always `programmatic_tool_calling`.", "default": "programmatic_tool_calling" } }, "type": "object", "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "InputFidelity": { "type": "string", "enum": [ "high", "low" ], "description": "Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for `gpt-image-1` and `gpt-image-1.5` and later models, unsupported for `gpt-image-1-mini`. Supports `high` and `low`. Defaults to `low`.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ImageGenActionEnum": { "type": "string", "enum": [ "generate", "edit", "auto" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "LocalShellToolParam": { "properties": { "type": { "type": "string", "enum": [ "local_shell" ], "description": "The type of the local shell tool. Always `local_shell`.", "default": "local_shell" } }, "type": "object", "required": [ "type" ], "title": "Local shell tool", "description": "A tool that allows the model to execute shell commands in a local environment.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ContainerAutoParam": { "properties": { "type": { "type": "string", "enum": [ "container_auto" ], "description": "Automatically creates a container for this request", "default": "container_auto" }, "file_ids": { "items": { "type": "string", "example": "file-123" }, "type": "array", "maxItems": 50, "description": "An optional list of uploaded files to make available to your code." }, "memory_limit": { "anyOf": [ { "$ref": "#/components/schemas/ContainerMemoryLimit", "description": "The memory limit for the container." }, { "type": "null" } ] }, "network_policy": { "oneOf": [ { "$ref": "#/components/schemas/ContainerNetworkPolicyDisabledParam" }, { "$ref": "#/components/schemas/ContainerNetworkPolicyAllowlistParam" } ], "description": "Network access policy for the container.", "discriminator": { "propertyName": "type" } }, "skills": { "items": { "oneOf": [ { "$ref": "#/components/schemas/SkillReferenceParam" }, { "$ref": "#/components/schemas/InlineSkillParam" } ], "discriminator": { "propertyName": "type" } }, "type": "array", "maxItems": 200, "description": "An optional list of skills referenced by id or inline data." } }, "type": "object", "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "LocalSkillParam": { "properties": { "name": { "type": "string", "description": "The name of the skill." }, "description": { "type": "string", "description": "The description of the skill." }, "path": { "type": "string", "description": "The path to the directory containing the skill." } }, "type": "object", "required": [ "name", "description", "path" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "LocalEnvironmentParam": { "properties": { "type": { "type": "string", "enum": [ "local" ], "description": "Use a local computer environment.", "default": "local" }, "skills": { "items": { "$ref": "#/components/schemas/LocalSkillParam" }, "type": "array", "maxItems": 200, "description": "An optional list of skills." } }, "type": "object", "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ContainerReferenceParam": { "properties": { "type": { "type": "string", "enum": [ "container_reference" ], "description": "References a container created with the /v1/containers endpoint", "default": "container_reference" }, "container_id": { "type": "string", "description": "The ID of the referenced container.", "example": "cntr_123" } }, "type": "object", "required": [ "type", "container_id" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellToolParam": { "properties": { "type": { "type": "string", "enum": [ "shell" ], "description": "The type of the shell tool. Always `shell`.", "default": "shell" }, "environment": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/ContainerAutoParam" }, { "$ref": "#/components/schemas/LocalEnvironmentParam" }, { "$ref": "#/components/schemas/ContainerReferenceParam" } ], "discriminator": { "propertyName": "type" } }, { "type": "null" } ] }, "allowed_callers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CallableToolAllowedCaller" }, "type": "array", "minItems": 1, "description": "The tool invocation context(s)." }, { "type": "null" } ] } }, "type": "object", "required": [ "type" ], "title": "Shell tool", "description": "A tool that allows the model to execute shell commands.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CustomTextFormatParam": { "properties": { "type": { "type": "string", "enum": [ "text" ], "description": "Unconstrained text format. Always `text`.", "default": "text" } }, "type": "object", "required": [ "type" ], "title": "Text format", "description": "Unconstrained free-form text.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "GrammarSyntax1": { "type": "string", "enum": [ "lark", "regex" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CustomGrammarFormatParam": { "properties": { "type": { "type": "string", "enum": [ "grammar" ], "description": "Grammar format. Always `grammar`.", "default": "grammar" }, "syntax": { "$ref": "#/components/schemas/GrammarSyntax1", "description": "The syntax of the grammar definition. One of `lark` or `regex`." }, "definition": { "type": "string", "description": "The grammar definition." } }, "type": "object", "required": [ "type", "syntax", "definition" ], "title": "Grammar format", "description": "A grammar defined by the user.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CustomToolParam": { "properties": { "type": { "type": "string", "enum": [ "custom" ], "description": "The type of the custom tool. Always `custom`.", "default": "custom" }, "name": { "type": "string", "description": "The name of the custom tool, used to identify it in tool calls." }, "description": { "type": "string", "description": "Optional description of the custom tool, used to provide more context." }, "format": { "oneOf": [ { "$ref": "#/components/schemas/CustomTextFormatParam" }, { "$ref": "#/components/schemas/CustomGrammarFormatParam" } ], "description": "The input format for the custom tool. Default is unconstrained text.", "discriminator": { "propertyName": "type" } }, "defer_loading": { "type": "boolean", "description": "Whether this tool should be deferred and discovered via tool search." }, "allowed_callers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CallableToolAllowedCaller" }, "type": "array", "minItems": 1, "description": "The tool invocation context(s)." }, { "type": "null" } ] } }, "type": "object", "required": [ "type", "name" ], "title": "Custom tool", "description": "A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "EmptyModelParam": { "properties": {}, "type": "object", "required": [], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionToolParam": { "properties": { "name": { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "parameters": { "anyOf": [ { "$ref": "#/components/schemas/EmptyModelParam" }, { "type": "null" } ] }, "strict": { "anyOf": [ { "type": "boolean", "description": "Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise." }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "function" ], "default": "function" }, "output_schema": { "anyOf": [ { "additionalProperties": {}, "type": "object", "description": "A JSON Schema describing the JSON value encoded in string outputs for this function tool. This does not describe content-array outputs." }, { "type": "null" } ] }, "defer_loading": { "type": "boolean", "description": "Whether this function should be deferred and discovered via tool search." }, "allowed_callers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CallableToolAllowedCaller" }, "type": "array", "minItems": 1, "description": "The tool invocation context(s)." }, { "type": "null" } ] } }, "type": "object", "required": [ "name", "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "NamespaceToolParam": { "properties": { "type": { "type": "string", "enum": [ "namespace" ], "description": "The type of the tool. Always `namespace`.", "default": "namespace" }, "name": { "type": "string", "minLength": 1, "description": "The namespace name used in tool calls (for example, `crm`)." }, "description": { "type": "string", "minLength": 1, "description": "A description of the namespace shown to the model." }, "tools": { "items": { "oneOf": [ { "$ref": "#/components/schemas/FunctionToolParam" }, { "$ref": "#/components/schemas/CustomToolParam" } ], "description": "A function or custom tool that belongs to a namespace.", "discriminator": { "propertyName": "type" } }, "type": "array", "minItems": 1, "description": "The function/custom tools available inside this namespace." } }, "type": "object", "required": [ "type", "name", "description", "tools" ], "title": "Namespace", "description": "Groups function/custom tools under a shared namespace.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ToolSearchToolParam": { "properties": { "type": { "type": "string", "enum": [ "tool_search" ], "description": "The type of the tool. Always `tool_search`.", "default": "tool_search" }, "execution": { "$ref": "#/components/schemas/ToolSearchExecutionType", "description": "Whether tool search is executed by the server or by the client." }, "description": { "anyOf": [ { "type": "string", "description": "Description shown to the model for a client-executed tool search tool." }, { "type": "null" } ] }, "parameters": { "anyOf": [ { "$ref": "#/components/schemas/EmptyModelParam", "description": "Parameter schema for a client-executed tool search tool." }, { "type": "null" } ] } }, "type": "object", "required": [ "type" ], "title": "Tool search tool", "description": "Hosted or BYOT tool search configuration for deferred tools.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApproximateLocation": { "properties": { "type": { "type": "string", "enum": [ "approximate" ], "description": "The type of location approximation. Always `approximate`.", "default": "approximate" }, "country": { "anyOf": [ { "type": "string", "description": "The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`." }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string", "description": "Free text input for the region of the user, e.g. `California`." }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "description": "Free text input for the city of the user, e.g. `San Francisco`." }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string", "description": "The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`." }, { "type": "null" } ] } }, "type": "object", "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "SearchContextSize": { "type": "string", "enum": [ "low", "medium", "high" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "SearchContentType": { "type": "string", "enum": [ "text", "image" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "WebSearchPreviewTool": { "properties": { "type": { "type": "string", "enum": [ "web_search_preview", "web_search_preview_2025_03_11" ], "description": "The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`.", "default": "web_search_preview" }, "user_location": { "anyOf": [ { "$ref": "#/components/schemas/ApproximateLocation", "description": "The user's location." }, { "type": "null" } ] }, "search_context_size": { "$ref": "#/components/schemas/SearchContextSize", "description": "High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default." }, "search_content_types": { "items": { "$ref": "#/components/schemas/SearchContentType" }, "type": "array" } }, "type": "object", "required": [ "type" ], "title": "Web search preview", "description": "This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search).", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApplyPatchToolParam": { "properties": { "type": { "type": "string", "enum": [ "apply_patch" ], "description": "The type of the tool. Always `apply_patch`.", "default": "apply_patch" }, "allowed_callers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CallableToolAllowedCaller" }, "type": "array", "minItems": 1, "description": "The tool invocation context(s)." }, { "type": "null" } ] } }, "type": "object", "required": [ "type" ], "title": "Apply patch tool", "description": "Allows the assistant to create, delete, or update files using unified diffs.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ToolSearchOutput": { "properties": { "type": { "type": "string", "enum": [ "tool_search_output" ], "description": "The type of the item. Always `tool_search_output`.", "default": "tool_search_output" }, "id": { "type": "string", "description": "The unique ID of the tool search output item." }, "call_id": { "anyOf": [ { "type": "string", "description": "The unique ID of the tool search call generated by the model." }, { "type": "null" } ] }, "execution": { "$ref": "#/components/schemas/ToolSearchExecutionType", "description": "Whether tool search was executed by the server or by the client." }, "tools": { "items": { "$ref": "#/components/schemas/Tool" }, "type": "array", "description": "The loaded tool definitions returned by tool search." }, "status": { "$ref": "#/components/schemas/FunctionCallOutputStatusEnum", "description": "The status of the tool search output item that was recorded." }, "created_by": { "type": "string", "description": "The identifier of the actor that created the item." } }, "type": "object", "required": [ "type", "id", "call_id", "execution", "tools", "status" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "AdditionalTools": { "properties": { "type": { "type": "string", "enum": [ "additional_tools" ], "description": "The type of the item. Always `additional_tools`.", "default": "additional_tools" }, "id": { "type": "string", "description": "The unique ID of the additional tools item." }, "role": { "$ref": "#/components/schemas/MessageRole", "description": "The role that provided the additional tools." }, "tools": { "items": { "$ref": "#/components/schemas/Tool" }, "type": "array", "description": "The additional tool definitions made available at this item." } }, "type": "object", "required": [ "type", "id", "role", "tools" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "Program": { "properties": { "type": { "type": "string", "enum": [ "program" ], "description": "The type of the item. Always `program`.", "default": "program" }, "id": { "type": "string", "description": "The unique ID of the program item." }, "call_id": { "type": "string", "description": "The stable call ID of the program item." }, "code": { "type": "string", "description": "The JavaScript source executed by programmatic tool calling." }, "fingerprint": { "type": "string", "description": "Opaque program replay fingerprint that must be round-tripped." } }, "type": "object", "required": [ "type", "id", "call_id", "code", "fingerprint" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ProgramOutputStatus": { "type": "string", "enum": [ "completed", "incomplete" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ProgramOutput": { "properties": { "type": { "type": "string", "enum": [ "program_output" ], "description": "The type of the item. Always `program_output`.", "default": "program_output" }, "id": { "type": "string", "description": "The unique ID of the program output item." }, "call_id": { "type": "string", "description": "The call ID of the program item." }, "result": { "type": "string", "description": "The result produced by the program item." }, "status": { "$ref": "#/components/schemas/ProgramOutputStatus", "description": "The terminal status of the program output item." } }, "type": "object", "required": [ "type", "id", "call_id", "result", "status" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CompactionBody": { "properties": { "type": { "type": "string", "enum": [ "compaction" ], "description": "The type of the item. Always `compaction`.", "default": "compaction" }, "id": { "type": "string", "description": "The unique ID of the compaction item." }, "encrypted_content": { "type": "string", "description": "The encrypted content that was produced by compaction." }, "created_by": { "type": "string", "description": "The identifier of the actor that created the item." } }, "type": "object", "required": [ "type", "id", "encrypted_content" ], "title": "Compaction item", "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CodeInterpreterOutputLogs": { "properties": { "type": { "type": "string", "enum": [ "logs" ], "description": "The type of the output. Always `logs`.", "default": "logs" }, "logs": { "type": "string", "description": "The logs output from the code interpreter." } }, "type": "object", "required": [ "type", "logs" ], "title": "Code interpreter output logs", "description": "The logs output from the code interpreter.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CodeInterpreterOutputImage": { "properties": { "type": { "type": "string", "enum": [ "image" ], "description": "The type of the output. Always `image`.", "default": "image" }, "url": { "type": "string", "format": "uri", "description": "The URL of the image output from the code interpreter." } }, "type": "object", "required": [ "type", "url" ], "title": "Code interpreter output image", "description": "The image output from the code interpreter.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "LocalShellExecAction": { "properties": { "type": { "type": "string", "enum": [ "exec" ], "description": "The type of the local shell action. Always `exec`.", "default": "exec" }, "command": { "items": { "type": "string" }, "type": "array", "description": "The command to run." }, "timeout_ms": { "anyOf": [ { "type": "integer", "description": "Optional timeout in milliseconds for the command." }, { "type": "null" } ] }, "working_directory": { "anyOf": [ { "type": "string", "description": "Optional working directory to run the command in." }, { "type": "null" } ] }, "env": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Environment variables to set for the command." }, "user": { "anyOf": [ { "type": "string", "description": "Optional user to run the command as." }, { "type": "null" } ] } }, "type": "object", "required": [ "type", "command", "env" ], "title": "Local shell exec action", "description": "Execute a shell command on the server.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellAction": { "properties": { "commands": { "items": { "type": "string", "description": "A list of commands to run." }, "type": "array" }, "timeout_ms": { "anyOf": [ { "type": "integer", "description": "Optional timeout in milliseconds for the commands." }, { "type": "null" } ] }, "max_output_length": { "anyOf": [ { "type": "integer", "description": "Optional maximum number of characters to return from each command." }, { "type": "null" } ] } }, "type": "object", "required": [ "commands", "timeout_ms", "max_output_length" ], "title": "Shell exec action", "description": "Execute a shell command.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellCallStatus": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "LocalEnvironmentResource": { "properties": { "type": { "type": "string", "enum": [ "local" ], "description": "The environment type. Always `local`.", "default": "local" } }, "type": "object", "required": [ "type" ], "title": "Local Environment", "description": "Represents the use of a local environment to perform shell actions.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ContainerReferenceResource": { "properties": { "type": { "type": "string", "enum": [ "container_reference" ], "description": "The environment type. Always `container_reference`.", "default": "container_reference" }, "container_id": { "type": "string" } }, "type": "object", "required": [ "type", "container_id" ], "title": "Container Reference", "description": "Represents a container created with /v1/containers.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellCall": { "properties": { "type": { "type": "string", "enum": [ "shell_call" ], "description": "The type of the item. Always `shell_call`.", "default": "shell_call" }, "id": { "type": "string", "description": "The unique ID of the shell tool call. Populated when this item is returned via API." }, "call_id": { "type": "string", "description": "The unique ID of the shell tool call generated by the model." }, "caller": { "anyOf": [ { "$ref": "#/components/schemas/ToolCallCaller", "description": "The execution context that produced this tool call." }, { "type": "null" } ] }, "action": { "$ref": "#/components/schemas/FunctionShellAction", "description": "The shell commands and limits that describe how to run the tool call." }, "status": { "$ref": "#/components/schemas/FunctionShellCallStatus", "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, "environment": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/LocalEnvironmentResource" }, { "$ref": "#/components/schemas/ContainerReferenceResource" } ], "discriminator": { "propertyName": "type" } }, { "type": "null" } ] }, "created_by": { "type": "string", "description": "The ID of the entity that created this tool call." } }, "type": "object", "required": [ "type", "id", "call_id", "action", "status", "environment" ], "title": "Shell tool call", "description": "A tool call that executes one or more shell commands in a managed environment.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellCallOutputStatusEnum": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellCallOutputTimeoutOutcome": { "properties": { "type": { "type": "string", "enum": [ "timeout" ], "description": "The outcome type. Always `timeout`.", "default": "timeout" } }, "type": "object", "required": [ "type" ], "title": "Shell call timeout outcome", "description": "Indicates that the shell call exceeded its configured time limit.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellCallOutputExitOutcome": { "properties": { "type": { "type": "string", "enum": [ "exit" ], "description": "The outcome type. Always `exit`.", "default": "exit" }, "exit_code": { "type": "integer", "description": "Exit code from the shell process." } }, "type": "object", "required": [ "type", "exit_code" ], "title": "Shell call exit outcome", "description": "Indicates that the shell commands finished and returned an exit code.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellCallOutputContent": { "properties": { "stdout": { "type": "string", "description": "The standard output that was captured." }, "stderr": { "type": "string", "description": "The standard error output that was captured." }, "outcome": { "oneOf": [ { "$ref": "#/components/schemas/FunctionShellCallOutputTimeoutOutcome" }, { "$ref": "#/components/schemas/FunctionShellCallOutputExitOutcome" } ], "title": "Shell call outcome", "description": "Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk.", "discriminator": { "propertyName": "type" } }, "created_by": { "type": "string", "description": "The identifier of the actor that created the item." } }, "type": "object", "required": [ "stdout", "stderr", "outcome" ], "title": "Shell call output content", "description": "The content of a shell tool call output that was emitted.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellCallOutput": { "properties": { "type": { "type": "string", "enum": [ "shell_call_output" ], "description": "The type of the shell call output. Always `shell_call_output`.", "default": "shell_call_output" }, "id": { "type": "string", "description": "The unique ID of the shell call output. Populated when this item is returned via API." }, "call_id": { "type": "string", "description": "The unique ID of the shell tool call generated by the model." }, "caller": { "anyOf": [ { "$ref": "#/components/schemas/ToolCallCaller", "description": "The execution context that produced this tool call." }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/FunctionShellCallOutputStatusEnum", "description": "The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`." }, "output": { "items": { "$ref": "#/components/schemas/FunctionShellCallOutputContent" }, "type": "array", "description": "An array of shell call output contents" }, "max_output_length": { "anyOf": [ { "type": "integer", "description": "The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output." }, { "type": "null" } ] }, "created_by": { "type": "string", "description": "The identifier of the actor that created the item." } }, "type": "object", "required": [ "type", "id", "call_id", "status", "output", "max_output_length" ], "title": "Shell call output", "description": "The output of a shell tool call that was emitted.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApplyPatchCallStatus": { "type": "string", "enum": [ "in_progress", "completed" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApplyPatchCreateFileOperation": { "properties": { "type": { "type": "string", "enum": [ "create_file" ], "description": "Create a new file with the provided diff.", "default": "create_file" }, "path": { "type": "string", "description": "Path of the file to create." }, "diff": { "type": "string", "description": "Diff to apply." } }, "type": "object", "required": [ "type", "path", "diff" ], "title": "Apply patch create file operation", "description": "Instruction describing how to create a file via the apply_patch tool.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApplyPatchDeleteFileOperation": { "properties": { "type": { "type": "string", "enum": [ "delete_file" ], "description": "Delete the specified file.", "default": "delete_file" }, "path": { "type": "string", "description": "Path of the file to delete." } }, "type": "object", "required": [ "type", "path" ], "title": "Apply patch delete file operation", "description": "Instruction describing how to delete a file via the apply_patch tool.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApplyPatchUpdateFileOperation": { "properties": { "type": { "type": "string", "enum": [ "update_file" ], "description": "Update an existing file with the provided diff.", "default": "update_file" }, "path": { "type": "string", "description": "Path of the file to update." }, "diff": { "type": "string", "description": "Diff to apply." } }, "type": "object", "required": [ "type", "path", "diff" ], "title": "Apply patch update file operation", "description": "Instruction describing how to update a file via the apply_patch tool.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApplyPatchToolCall": { "properties": { "type": { "type": "string", "enum": [ "apply_patch_call" ], "description": "The type of the item. Always `apply_patch_call`.", "default": "apply_patch_call" }, "id": { "type": "string", "description": "The unique ID of the apply patch tool call. Populated when this item is returned via API." }, "call_id": { "type": "string", "description": "The unique ID of the apply patch tool call generated by the model." }, "caller": { "anyOf": [ { "$ref": "#/components/schemas/ToolCallCaller", "description": "The execution context that produced this tool call." }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/ApplyPatchCallStatus", "description": "The status of the apply patch tool call. One of `in_progress` or `completed`." }, "operation": { "oneOf": [ { "$ref": "#/components/schemas/ApplyPatchCreateFileOperation" }, { "$ref": "#/components/schemas/ApplyPatchDeleteFileOperation" }, { "$ref": "#/components/schemas/ApplyPatchUpdateFileOperation" } ], "title": "Apply patch operation", "description": "One of the create_file, delete_file, or update_file operations applied via apply_patch.", "discriminator": { "propertyName": "type" } }, "created_by": { "type": "string", "description": "The ID of the entity that created this tool call." } }, "type": "object", "required": [ "type", "id", "call_id", "status", "operation" ], "title": "Apply patch tool call", "description": "A tool call that applies file diffs by creating, deleting, or updating files.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApplyPatchCallOutputStatus": { "type": "string", "enum": [ "completed", "failed" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApplyPatchToolCallOutput": { "properties": { "type": { "type": "string", "enum": [ "apply_patch_call_output" ], "description": "The type of the item. Always `apply_patch_call_output`.", "default": "apply_patch_call_output" }, "id": { "type": "string", "description": "The unique ID of the apply patch tool call output. Populated when this item is returned via API." }, "call_id": { "type": "string", "description": "The unique ID of the apply patch tool call generated by the model." }, "caller": { "anyOf": [ { "$ref": "#/components/schemas/ToolCallCaller", "description": "The execution context that produced this tool call." }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/ApplyPatchCallOutputStatus", "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { "anyOf": [ { "type": "string", "description": "Optional textual output returned by the apply patch tool." }, { "type": "null" } ] }, "created_by": { "type": "string", "description": "The ID of the entity that created this tool call output." } }, "type": "object", "required": [ "type", "id", "call_id", "status" ], "title": "Apply patch tool call output", "description": "The output emitted by an apply patch tool call.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "MCPToolCallStatus": { "type": "string", "enum": [ "in_progress", "completed", "incomplete", "calling", "failed" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "DetailEnum": { "type": "string", "enum": [ "low", "high", "auto", "original" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionCallItemStatus": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ComputerCallOutputItemParam": { "properties": { "id": { "anyOf": [ { "type": "string", "description": "The ID of the computer tool call output.", "example": "cuo_123" }, { "type": "null" } ] }, "call_id": { "type": "string", "maxLength": 64, "minLength": 1, "description": "The ID of the computer tool call that produced the output." }, "type": { "type": "string", "enum": [ "computer_call_output" ], "description": "The type of the computer tool call output. Always `computer_call_output`.", "default": "computer_call_output" }, "output": { "$ref": "#/components/schemas/ComputerScreenshotImage" }, "acknowledged_safety_checks": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ComputerCallSafetyCheckParam" }, "type": "array", "description": "The safety checks reported by the API that have been acknowledged by the developer." }, { "type": "null" } ] }, "status": { "anyOf": [ { "$ref": "#/components/schemas/FunctionCallItemStatus", "description": "The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API." }, { "type": "null" } ] } }, "type": "object", "required": [ "call_id", "type", "output" ], "title": "Computer tool call output", "description": "The output of a computer tool call.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "InputTextContentParam": { "properties": { "type": { "type": "string", "enum": [ "input_text" ], "description": "The type of the input item. Always `input_text`.", "default": "input_text" }, "text": { "type": "string", "maxLength": 10485760, "description": "The text input to the model." }, "prompt_cache_breakpoint": { "anyOf": [ { "$ref": "#/components/schemas/PromptCacheBreakpointParam" }, { "type": "null" } ] } }, "type": "object", "required": [ "type", "text" ], "title": "Input text", "description": "A text input to the model.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "InputImageContentParamAutoParam": { "properties": { "type": { "type": "string", "enum": [ "input_image" ], "description": "The type of the input item. Always `input_image`.", "default": "input_image" }, "image_url": { "anyOf": [ { "type": "string", "maxLength": 20971520, "format": "uri", "description": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL." }, { "type": "null" } ] }, "file_id": { "anyOf": [ { "type": "string", "description": "The ID of the file to be sent to the model.", "example": "file-123" }, { "type": "null" } ] }, "detail": { "anyOf": [ { "$ref": "#/components/schemas/DetailEnum", "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`." }, { "type": "null" } ] }, "prompt_cache_breakpoint": { "anyOf": [ { "$ref": "#/components/schemas/PromptCacheBreakpointParam" }, { "type": "null" } ] } }, "type": "object", "required": [ "type" ], "title": "Input image", "description": "An image input to the model. Learn about [image inputs](/docs/guides/vision)", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FileDetailEnum": { "type": "string", "enum": [ "auto", "low", "high" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "InputFileContentParam": { "properties": { "type": { "type": "string", "enum": [ "input_file" ], "description": "The type of the input item. Always `input_file`.", "default": "input_file" }, "file_id": { "anyOf": [ { "type": "string", "description": "The ID of the file to be sent to the model.", "example": "file-123" }, { "type": "null" } ] }, "filename": { "anyOf": [ { "type": "string", "description": "The name of the file to be sent to the model." }, { "type": "null" } ] }, "file_data": { "anyOf": [ { "type": "string", "maxLength": 73400320, "description": "The base64-encoded data of the file to be sent to the model." }, { "type": "null" } ] }, "file_url": { "anyOf": [ { "type": "string", "format": "uri", "description": "The URL of the file to be sent to the model." }, { "type": "null" } ] }, "detail": { "$ref": "#/components/schemas/FileDetailEnum", "description": "The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`." }, "prompt_cache_breakpoint": { "anyOf": [ { "$ref": "#/components/schemas/PromptCacheBreakpointParam" }, { "type": "null" } ] } }, "type": "object", "required": [ "type" ], "title": "Input file", "description": "A file input to the model.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionCallOutputItemParam": { "properties": { "id": { "anyOf": [ { "type": "string", "description": "The unique ID of the function tool call output. Populated when this item is returned via API.", "example": "fc_123" }, { "type": "null" } ] }, "call_id": { "type": "string", "maxLength": 64, "minLength": 1, "description": "The unique ID of the function tool call generated by the model." }, "type": { "type": "string", "enum": [ "function_call_output" ], "description": "The type of the function tool call output. Always `function_call_output`.", "default": "function_call_output" }, "output": { "oneOf": [ { "type": "string", "maxLength": 10485760, "description": "A JSON string of the output of the function tool call." }, { "items": { "oneOf": [ { "$ref": "#/components/schemas/InputTextContentParam" }, { "$ref": "#/components/schemas/InputImageContentParamAutoParam" }, { "$ref": "#/components/schemas/InputFileContentParam" } ], "description": "A piece of message content, such as text, an image, or a file.", "discriminator": { "propertyName": "type" } }, "type": "array", "description": "An array of content outputs (text, image, file) for the function tool call." } ], "description": "Text, image, or file output of the function tool call." }, "name": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1, "description": "The name of the tool that produced the output." }, { "type": "null" } ] }, "caller": { "anyOf": [ { "$ref": "#/components/schemas/ToolCallCallerParam", "description": "The execution context that produced this tool call." }, { "type": "null" } ] }, "status": { "anyOf": [ { "$ref": "#/components/schemas/FunctionCallItemStatus", "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API." }, { "type": "null" } ] } }, "type": "object", "required": [ "call_id", "type", "output" ], "title": "Function tool call output", "description": "The output of a function tool call.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ToolSearchCallItemParam": { "properties": { "id": { "anyOf": [ { "type": "string", "description": "The unique ID of this tool search call.", "example": "tsc_123" }, { "type": "null" } ] }, "call_id": { "anyOf": [ { "type": "string", "maxLength": 64, "minLength": 1, "description": "The unique ID of the tool search call generated by the model." }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "tool_search_call" ], "description": "The item type. Always `tool_search_call`.", "default": "tool_search_call" }, "execution": { "$ref": "#/components/schemas/ToolSearchExecutionType", "description": "Whether tool search was executed by the server or by the client." }, "arguments": { "$ref": "#/components/schemas/EmptyModelParam", "description": "The arguments supplied to the tool search call." }, "status": { "anyOf": [ { "$ref": "#/components/schemas/FunctionCallItemStatus", "description": "The status of the tool search call." }, { "type": "null" } ] } }, "type": "object", "required": [ "type", "arguments" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ToolSearchOutputItemParam": { "properties": { "id": { "anyOf": [ { "type": "string", "description": "The unique ID of this tool search output.", "example": "tso_123" }, { "type": "null" } ] }, "call_id": { "anyOf": [ { "type": "string", "maxLength": 64, "minLength": 1, "description": "The unique ID of the tool search call generated by the model." }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "tool_search_output" ], "description": "The item type. Always `tool_search_output`.", "default": "tool_search_output" }, "execution": { "$ref": "#/components/schemas/ToolSearchExecutionType", "description": "Whether tool search was executed by the server or by the client." }, "tools": { "items": { "$ref": "#/components/schemas/Tool" }, "type": "array", "description": "The loaded tool definitions returned by the tool search output." }, "status": { "anyOf": [ { "$ref": "#/components/schemas/FunctionCallItemStatus", "description": "The status of the tool search output." }, { "type": "null" } ] } }, "type": "object", "required": [ "type", "tools" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "AdditionalToolsItemParam": { "properties": { "id": { "anyOf": [ { "type": "string", "description": "The unique ID of this additional tools item.", "example": "at_123" }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "additional_tools" ], "description": "The item type. Always `additional_tools`.", "default": "additional_tools" }, "role": { "type": "string", "enum": [ "developer" ], "description": "The role that provided the additional tools. Only `developer` is supported.", "default": "developer" }, "tools": { "items": { "$ref": "#/components/schemas/Tool" }, "type": "array", "description": "A list of additional tools made available at this item." } }, "type": "object", "required": [ "type", "role", "tools" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CompactionSummaryItemParam": { "properties": { "id": { "anyOf": [ { "type": "string", "description": "The ID of the compaction item.", "example": "cmp_123" }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "compaction" ], "description": "The type of the item. Always `compaction`.", "default": "compaction" }, "encrypted_content": { "type": "string", "maxLength": 10485760, "description": "The encrypted content of the compaction summary." } }, "type": "object", "required": [ "type", "encrypted_content" ], "title": "Compaction item", "description": "A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellActionParam": { "properties": { "commands": { "items": { "type": "string" }, "type": "array", "description": "Ordered shell commands for the execution environment to run." }, "timeout_ms": { "anyOf": [ { "type": "integer", "description": "Maximum wall-clock time in milliseconds to allow the shell commands to run." }, { "type": "null" } ] }, "max_output_length": { "anyOf": [ { "type": "integer", "description": "Maximum number of UTF-8 characters to capture from combined stdout and stderr output." }, { "type": "null" } ] } }, "type": "object", "required": [ "commands" ], "title": "Shell action", "description": "Commands and limits describing how to run the shell tool call.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellCallItemStatus": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Shell call status", "description": "Status values reported for shell tool calls.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellCallItemParam": { "properties": { "id": { "anyOf": [ { "type": "string", "description": "The unique ID of the shell tool call. Populated when this item is returned via API.", "example": "sh_123" }, { "type": "null" } ] }, "call_id": { "type": "string", "maxLength": 64, "minLength": 1, "description": "The unique ID of the shell tool call generated by the model." }, "caller": { "anyOf": [ { "$ref": "#/components/schemas/ToolCallCallerParam", "description": "The execution context that produced this tool call." }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "shell_call" ], "description": "The type of the item. Always `shell_call`.", "default": "shell_call" }, "action": { "$ref": "#/components/schemas/FunctionShellActionParam", "description": "The shell commands and limits that describe how to run the tool call." }, "status": { "anyOf": [ { "$ref": "#/components/schemas/FunctionShellCallItemStatus", "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`." }, { "type": "null" } ] }, "environment": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/LocalEnvironmentParam" }, { "$ref": "#/components/schemas/ContainerReferenceParam" } ], "description": "The environment to execute the shell commands in.", "discriminator": { "propertyName": "type" } }, { "type": "null" } ] } }, "type": "object", "required": [ "call_id", "type", "action" ], "title": "Shell tool call", "description": "A tool representing a request to execute one or more shell commands.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellCallOutputTimeoutOutcomeParam": { "properties": { "type": { "type": "string", "enum": [ "timeout" ], "description": "The outcome type. Always `timeout`.", "default": "timeout" } }, "type": "object", "required": [ "type" ], "title": "Shell call timeout outcome", "description": "Indicates that the shell call exceeded its configured time limit.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellCallOutputExitOutcomeParam": { "properties": { "type": { "type": "string", "enum": [ "exit" ], "description": "The outcome type. Always `exit`.", "default": "exit" }, "exit_code": { "type": "integer", "description": "The exit code returned by the shell process." } }, "type": "object", "required": [ "type", "exit_code" ], "title": "Shell call exit outcome", "description": "Indicates that the shell commands finished and returned an exit code.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellCallOutputOutcomeParam": { "oneOf": [ { "$ref": "#/components/schemas/FunctionShellCallOutputTimeoutOutcomeParam" }, { "$ref": "#/components/schemas/FunctionShellCallOutputExitOutcomeParam" } ], "title": "Shell call outcome", "description": "The exit or timeout outcome associated with this shell call.", "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellCallOutputContentParam": { "properties": { "stdout": { "type": "string", "maxLength": 10485760, "description": "Captured stdout output for the shell call." }, "stderr": { "type": "string", "maxLength": 10485760, "description": "Captured stderr output for the shell call." }, "outcome": { "$ref": "#/components/schemas/FunctionShellCallOutputOutcomeParam", "description": "The exit or timeout outcome associated with this shell call." } }, "type": "object", "required": [ "stdout", "stderr", "outcome" ], "title": "Shell output content", "description": "Captured stdout and stderr for a portion of a shell tool call output.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "FunctionShellCallOutputItemParam": { "properties": { "id": { "anyOf": [ { "type": "string", "description": "The unique ID of the shell tool call output. Populated when this item is returned via API.", "example": "sho_123" }, { "type": "null" } ] }, "call_id": { "type": "string", "maxLength": 64, "minLength": 1, "description": "The unique ID of the shell tool call generated by the model." }, "caller": { "anyOf": [ { "$ref": "#/components/schemas/ToolCallCallerParam", "description": "The execution context that produced this tool call." }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "shell_call_output" ], "description": "The type of the item. Always `shell_call_output`.", "default": "shell_call_output" }, "output": { "items": { "$ref": "#/components/schemas/FunctionShellCallOutputContentParam" }, "type": "array", "description": "Captured chunks of stdout and stderr output, along with their associated outcomes." }, "status": { "anyOf": [ { "$ref": "#/components/schemas/FunctionShellCallItemStatus", "description": "The status of the shell call output." }, { "type": "null" } ] }, "max_output_length": { "anyOf": [ { "type": "integer", "description": "The maximum number of UTF-8 characters captured for this shell call's combined output." }, { "type": "null" } ] } }, "type": "object", "required": [ "call_id", "type", "output" ], "title": "Shell tool call output", "description": "The streamed output items emitted by a shell tool call.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApplyPatchCallStatusParam": { "type": "string", "enum": [ "in_progress", "completed" ], "title": "Apply patch call status", "description": "Status values reported for apply_patch tool calls.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApplyPatchCreateFileOperationParam": { "properties": { "type": { "type": "string", "enum": [ "create_file" ], "description": "The operation type. Always `create_file`.", "default": "create_file" }, "path": { "type": "string", "minLength": 1, "description": "Path of the file to create relative to the workspace root." }, "diff": { "type": "string", "maxLength": 10485760, "description": "Unified diff content to apply when creating the file." } }, "type": "object", "required": [ "type", "path", "diff" ], "title": "Apply patch create file operation", "description": "Instruction for creating a new file via the apply_patch tool.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApplyPatchDeleteFileOperationParam": { "properties": { "type": { "type": "string", "enum": [ "delete_file" ], "description": "The operation type. Always `delete_file`.", "default": "delete_file" }, "path": { "type": "string", "minLength": 1, "description": "Path of the file to delete relative to the workspace root." } }, "type": "object", "required": [ "type", "path" ], "title": "Apply patch delete file operation", "description": "Instruction for deleting an existing file via the apply_patch tool.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApplyPatchUpdateFileOperationParam": { "properties": { "type": { "type": "string", "enum": [ "update_file" ], "description": "The operation type. Always `update_file`.", "default": "update_file" }, "path": { "type": "string", "minLength": 1, "description": "Path of the file to update relative to the workspace root." }, "diff": { "type": "string", "maxLength": 10485760, "description": "Unified diff content to apply to the existing file." } }, "type": "object", "required": [ "type", "path", "diff" ], "title": "Apply patch update file operation", "description": "Instruction for updating an existing file via the apply_patch tool.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApplyPatchOperationParam": { "oneOf": [ { "$ref": "#/components/schemas/ApplyPatchCreateFileOperationParam" }, { "$ref": "#/components/schemas/ApplyPatchDeleteFileOperationParam" }, { "$ref": "#/components/schemas/ApplyPatchUpdateFileOperationParam" } ], "title": "Apply patch operation", "description": "One of the create_file, delete_file, or update_file operations supplied to the apply_patch tool.", "discriminator": { "propertyName": "type" }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApplyPatchToolCallItemParam": { "properties": { "type": { "type": "string", "enum": [ "apply_patch_call" ], "description": "The type of the item. Always `apply_patch_call`.", "default": "apply_patch_call" }, "id": { "anyOf": [ { "type": "string", "description": "The unique ID of the apply patch tool call. Populated when this item is returned via API.", "example": "apc_123" }, { "type": "null" } ] }, "call_id": { "type": "string", "maxLength": 64, "minLength": 1, "description": "The unique ID of the apply patch tool call generated by the model." }, "caller": { "anyOf": [ { "$ref": "#/components/schemas/ToolCallCallerParam", "description": "The execution context that produced this tool call." }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/ApplyPatchCallStatusParam", "description": "The status of the apply patch tool call. One of `in_progress` or `completed`." }, "operation": { "$ref": "#/components/schemas/ApplyPatchOperationParam", "description": "The specific create, delete, or update instruction for the apply_patch tool call." } }, "type": "object", "required": [ "type", "call_id", "status", "operation" ], "title": "Apply patch tool call", "description": "A tool call representing a request to create, delete, or update files using diff patches.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApplyPatchCallOutputStatusParam": { "type": "string", "enum": [ "completed", "failed" ], "title": "Apply patch call output status", "description": "Outcome values reported for apply_patch tool call outputs.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ApplyPatchToolCallOutputItemParam": { "properties": { "type": { "type": "string", "enum": [ "apply_patch_call_output" ], "description": "The type of the item. Always `apply_patch_call_output`.", "default": "apply_patch_call_output" }, "id": { "anyOf": [ { "type": "string", "description": "The unique ID of the apply patch tool call output. Populated when this item is returned via API.", "example": "apco_123" }, { "type": "null" } ] }, "call_id": { "type": "string", "maxLength": 64, "minLength": 1, "description": "The unique ID of the apply patch tool call generated by the model." }, "caller": { "anyOf": [ { "$ref": "#/components/schemas/ToolCallCallerParam", "description": "The execution context that produced this tool call." }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/ApplyPatchCallOutputStatusParam", "description": "The status of the apply patch tool call output. One of `completed` or `failed`." }, "output": { "anyOf": [ { "type": "string", "maxLength": 10485760, "description": "Optional human-readable log text from the apply patch tool (e.g., patch results or errors)." }, { "type": "null" } ] } }, "type": "object", "required": [ "type", "call_id", "status" ], "title": "Apply patch tool call output", "description": "The streamed output emitted by an apply patch tool call.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CompactionTriggerItemParam": { "properties": { "type": { "type": "string", "enum": [ "compaction_trigger" ], "description": "The type of the item. Always `compaction_trigger`.", "default": "compaction_trigger" } }, "type": "object", "required": [ "type" ], "title": "Compaction trigger", "description": "Compacts the current context. Must be the final input item.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ItemReferenceParam": { "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "item_reference" ], "description": "The type of item to reference. Always `item_reference`.", "default": "item_reference" }, { "type": "null" } ] }, "id": { "type": "string", "description": "The ID of the item to reference." } }, "type": "object", "required": [ "id" ], "title": "Item reference", "description": "An internal identifier for an item to reference.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ProgramItemParam": { "properties": { "id": { "type": "string", "description": "The unique ID of this program item.", "example": "cm_123" }, "type": { "type": "string", "enum": [ "program" ], "description": "The item type. Always `program`.", "default": "program" }, "call_id": { "type": "string", "maxLength": 64, "minLength": 1, "description": "The stable call ID of the program item." }, "code": { "type": "string", "maxLength": 10485760, "description": "The JavaScript source executed by programmatic tool calling." }, "fingerprint": { "type": "string", "maxLength": 10485760, "description": "Opaque program replay fingerprint that must be round-tripped." } }, "type": "object", "required": [ "id", "type", "call_id", "code", "fingerprint" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ProgramOutputItemStatus": { "type": "string", "enum": [ "completed", "incomplete" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ProgramOutputItemParam": { "properties": { "id": { "type": "string", "description": "The unique ID of this program output item.", "example": "cmo_123" }, "type": { "type": "string", "enum": [ "program_output" ], "description": "The item type. Always `program_output`.", "default": "program_output" }, "call_id": { "type": "string", "maxLength": 64, "minLength": 1, "description": "The call ID of the program item." }, "result": { "type": "string", "maxLength": 10485760, "description": "The result produced by the program item." }, "status": { "$ref": "#/components/schemas/ProgramOutputItemStatus", "description": "The terminal status of the program output." } }, "type": "object", "required": [ "id", "type", "call_id", "result", "status" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ImageGenOutputTokensDetails": { "properties": { "image_tokens": { "type": "integer", "description": "The number of image output tokens generated by the model." }, "text_tokens": { "type": "integer", "description": "The number of text output tokens generated by the model." } }, "type": "object", "required": [ "image_tokens", "text_tokens" ], "title": "Image generation output token details", "description": "The output token details for the image generation.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ImageGenInputUsageDetails": { "properties": { "text_tokens": { "type": "integer", "description": "The number of text tokens in the input prompt." }, "image_tokens": { "type": "integer", "description": "The number of image tokens in the input prompt." } }, "type": "object", "required": [ "text_tokens", "image_tokens" ], "title": "Input usage details", "description": "The input tokens detailed information for the image generation.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ImageGenUsage": { "properties": { "input_tokens": { "type": "integer", "description": "The number of tokens (images and text) in the input prompt." }, "total_tokens": { "type": "integer", "description": "The total number of tokens (images and text) used for the image generation." }, "output_tokens": { "type": "integer", "description": "The number of output tokens generated by the model." }, "output_tokens_details": { "$ref": "#/components/schemas/ImageGenOutputTokensDetails" }, "input_tokens_details": { "$ref": "#/components/schemas/ImageGenInputUsageDetails" } }, "type": "object", "required": [ "input_tokens", "total_tokens", "output_tokens", "input_tokens_details" ], "title": "Image generation usage", "description": "For `gpt-image-1` only, the token usage information for the image generation.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "SpecificProgrammaticToolCallingParam": { "properties": { "type": { "type": "string", "enum": [ "programmatic_tool_calling" ], "description": "The tool to call. Always `programmatic_tool_calling`.", "default": "programmatic_tool_calling" } }, "type": "object", "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "SpecificApplyPatchParam": { "properties": { "type": { "type": "string", "enum": [ "apply_patch" ], "description": "The tool to call. Always `apply_patch`.", "default": "apply_patch" } }, "type": "object", "required": [ "type" ], "title": "Specific apply patch tool choice", "description": "Forces the model to call the apply_patch tool when executing a tool call.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "SpecificFunctionShellParam": { "properties": { "type": { "type": "string", "enum": [ "shell" ], "description": "The tool to call. Always `shell`.", "default": "shell" } }, "type": "object", "required": [ "type" ], "title": "Specific shell tool choice", "description": "Forces the model to call the shell tool when a tool call is required.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ReasoningModeEnum": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "standard", "pro" ] } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ConversationParam-2": { "properties": { "id": { "type": "string", "description": "The unique ID of the conversation.", "example": "conv_123" } }, "type": "object", "required": [ "id" ], "title": "Conversation object", "description": "The conversation that this response belongs to.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ContextManagementParam": { "properties": { "type": { "type": "string", "description": "The context management entry type. Currently only 'compaction' is supported." }, "compact_threshold": { "anyOf": [ { "type": "integer", "minimum": 1000, "description": "Token threshold at which compaction should be triggered for this entry." }, { "type": "null" } ] } }, "type": "object", "required": [ "type" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "PromptCacheOptions": { "properties": { "ttl": { "$ref": "#/components/schemas/PromptCacheTTLEnum", "description": "The minimum lifetime applied to each cache breakpoint." }, "mode": { "$ref": "#/components/schemas/PromptCacheModeEnum", "description": "Whether implicit prompt-cache breakpoints were enabled." } }, "type": "object", "required": [ "ttl", "mode" ], "title": "Prompt cache options", "description": "The prompt-caching options that were applied to the response. Supported for `gpt-5.6` and later models.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ModerationErrorBody": { "properties": { "type": { "type": "string", "enum": [ "error" ], "description": "The object type, which was always `error` for moderation failures.", "default": "error" }, "code": { "type": "string", "description": "The error code." }, "message": { "type": "string", "description": "The error message." } }, "type": "object", "required": [ "type", "code", "message" ], "title": "Moderation error", "description": "An error produced while attempting moderation for the response input or output.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "Moderation": { "properties": { "input": { "oneOf": [ { "$ref": "#/components/schemas/ModerationResultBody" }, { "$ref": "#/components/schemas/ModerationErrorBody" } ], "description": "Moderation for the response input.", "discriminator": { "propertyName": "type" } }, "output": { "oneOf": [ { "$ref": "#/components/schemas/ModerationResultBody" }, { "$ref": "#/components/schemas/ModerationErrorBody" } ], "description": "Moderation for the response output.", "discriminator": { "propertyName": "type" } } }, "type": "object", "required": [ "input", "output" ], "title": "Moderation", "description": "Moderation results or errors for the response input and output.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ResponseConversation": { "properties": { "id": { "type": "string", "description": "The unique ID of the conversation that this response was associated with." } }, "type": "object", "required": [ "id" ], "title": "Conversation", "description": "The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "VideoModel": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "sora-2", "sora-2-pro", "sora-2-2025-10-06", "sora-2-pro-2025-10-06", "sora-2-2025-12-08" ] } ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "VideoStatus": { "type": "string", "enum": [ "queued", "in_progress", "completed", "failed" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "VideoSize": { "type": "string", "enum": [ "720x1280", "1280x720", "1024x1792", "1792x1024" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "Error-2": { "properties": { "code": { "type": "string", "description": "A machine-readable error code that was returned." }, "message": { "type": "string", "description": "A human-readable description of the error that was returned." } }, "type": "object", "required": [ "code", "message" ], "title": "Error", "description": "An error that occurred while generating the response.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "VideoResource": { "properties": { "id": { "type": "string", "description": "Unique identifier for the video job." }, "object": { "type": "string", "enum": [ "video" ], "description": "The object type, which is always `video`.", "default": "video" }, "model": { "$ref": "#/components/schemas/VideoModel", "description": "The video generation model that produced the job." }, "status": { "$ref": "#/components/schemas/VideoStatus", "description": "Current lifecycle status of the video job." }, "progress": { "type": "integer", "description": "Approximate completion percentage for the generation task." }, "created_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (seconds) for when the job was created." }, "completed_at": { "anyOf": [ { "type": "integer", "format": "unixtime", "description": "Unix timestamp (seconds) for when the job completed, if finished." }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "type": "integer", "format": "unixtime", "description": "Unix timestamp (seconds) for when the downloadable assets expire, if set." }, { "type": "null" } ] }, "prompt": { "anyOf": [ { "type": "string", "description": "The prompt that was used to generate the video." }, { "type": "null" } ] }, "size": { "$ref": "#/components/schemas/VideoSize", "description": "The resolution of the generated video." }, "seconds": { "type": "string", "description": "Duration of the generated clip in seconds. For extensions, this is the stitched total duration." }, "remixed_from_video_id": { "anyOf": [ { "type": "string", "description": "Identifier of the source video if this video is a remix." }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/components/schemas/Error-2", "description": "Error payload that explains why generation failed, if applicable." }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "object", "model", "status", "progress", "created_at", "completed_at", "expires_at", "prompt", "size", "seconds", "remixed_from_video_id", "error" ], "title": "Video job", "description": "Structured information describing a generated video job.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "ImageRefParam-2": { "properties": { "image_url": { "type": "string", "maxLength": 20971520, "format": "uri", "description": "A fully qualified URL or base64-encoded data URL." }, "file_id": { "type": "string", "example": "file-123" } }, "type": "object", "required": [], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "VideoSeconds": { "type": "string", "enum": [ "4", "8", "12" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateVideoMultipartBody": { "properties": { "model": { "$ref": "#/components/schemas/VideoModel", "description": "The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults to `sora-2`." }, "prompt": { "type": "string", "maxLength": 32000, "minLength": 1, "description": "Text prompt that describes the video to generate." }, "input_reference": { "oneOf": [ { "type": "string", "format": "binary", "description": "Optional reference asset upload or reference object that guides generation." }, { "$ref": "#/components/schemas/ImageRefParam-2", "description": "Optional reference asset upload or reference object that guides generation. Provide exactly one of `image_url` or `file_id` when using an object." } ] }, "seconds": { "$ref": "#/components/schemas/VideoSeconds", "description": "Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds." }, "size": { "$ref": "#/components/schemas/VideoSize", "description": "Output resolution formatted as width x height (allowed values: 720x1280, 1280x720, 1024x1792, 1792x1024). Defaults to 720x1280." } }, "type": "object", "required": [ "prompt" ], "title": "Create video multipart request", "description": "Multipart parameters for creating a new video generation job.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateVideoJsonBody": { "properties": { "model": { "$ref": "#/components/schemas/VideoModel", "description": "The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults to `sora-2`." }, "prompt": { "type": "string", "maxLength": 32000, "minLength": 1, "description": "Text prompt that describes the video to generate." }, "input_reference": { "$ref": "#/components/schemas/ImageRefParam-2", "description": "Optional reference object that guides generation. Provide exactly one of `image_url` or `file_id`." }, "seconds": { "$ref": "#/components/schemas/VideoSeconds", "description": "Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds." }, "size": { "$ref": "#/components/schemas/VideoSize", "description": "Output resolution formatted as width x height (allowed values: 720x1280, 1280x720, 1024x1792, 1792x1024). Defaults to 720x1280." } }, "type": "object", "required": [ "prompt" ], "title": "Create video JSON request", "description": "JSON parameters for creating a new video generation job.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "DeletedVideoResource": { "properties": { "object": { "type": "string", "enum": [ "video.deleted" ], "description": "The object type that signals the deletion response.", "default": "video.deleted" }, "deleted": { "type": "boolean", "description": "Indicates that the video resource was deleted." }, "id": { "type": "string", "description": "Identifier of the deleted video." } }, "type": "object", "required": [ "object", "deleted", "id" ], "title": "Deleted video response", "description": "Confirmation payload returned after deleting a video.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "VideoContentVariant": { "type": "string", "enum": [ "video", "thumbnail", "spritesheet" ], "x-source": { "from": "avs://openai/official", "authority": "official" } }, "CreateVideoRemixBody": { "properties": { "prompt": { "type": "string", "maxLength": 32000, "minLength": 1, "description": "Updated text prompt that directs the remix generation." } }, "type": "object", "required": [ "prompt" ], "title": "Create video remix request", "description": "Parameters for remixing an existing generated video.", "x-source": { "from": "avs://openai/official", "authority": "official" } }, "AnthropicAllowedCaller": { "description": "Specifies who can invoke a tool.\n\nValues:\n direct: The model can call this tool directly.\n code_execution_20250825: The tool can be called from the code execution environment (v1).\n code_execution_20260120: The tool can be called from the code execution environment (v2 with persistence).\n code_execution_20260521: The tool can be called from the code execution environment (v2 with persistence).", "enum": [ "direct", "code_execution_20250825", "code_execution_20260120", "code_execution_20260521" ], "title": "AllowedCaller", "type": "string", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBase64ImageSource": { "additionalProperties": false, "properties": { "data": { "format": "byte", "title": "Data", "type": "string" }, "media_type": { "enum": [ "image/jpeg", "image/png", "image/gif", "image/webp" ], "title": "Media Type", "type": "string" }, "type": { "const": "base64", "title": "Type", "type": "string" } }, "required": [ "data", "media_type", "type" ], "title": "Base64ImageSource", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBase64PDFSource": { "additionalProperties": false, "properties": { "data": { "format": "byte", "title": "Data", "type": "string" }, "media_type": { "const": "application/pdf", "title": "Media Type", "type": "string" }, "type": { "const": "base64", "title": "Type", "type": "string" } }, "required": [ "data", "media_type", "type" ], "title": "Base64PDFSource", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBashCodeExecutionToolResultErrorCode": { "enum": [ "invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded", "output_file_too_large" ], "title": "BashCodeExecutionToolResultErrorCode", "type": "string", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBashTool_20250124": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "input_examples": { "items": { "additionalProperties": { "$ref": "#/components/schemas/AnthropicJsonValue" }, "type": "object" }, "title": "Input Examples", "type": "array" }, "name": { "const": "bash", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "const": "bash_20250124", "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "BashTool_20250124", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserCloseTabConfig": { "additionalProperties": false, "description": "``close_tab``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserCloseTabConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserDoubleClickConfig": { "additionalProperties": false, "description": "``double_click``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserDoubleClickConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserFileUploadConfig": { "additionalProperties": false, "description": "``file_upload``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserFileUploadConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserFindConfig": { "additionalProperties": false, "description": "``find``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserFindConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserFormInputConfig": { "additionalProperties": false, "description": "``form_input``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserFormInputConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserGetPageTextConfig": { "additionalProperties": false, "description": "``get_page_text``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserGetPageTextConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserHoldKeyConfig": { "additionalProperties": false, "description": "``hold_key``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserHoldKeyConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserHoverConfig": { "additionalProperties": false, "description": "``hover``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserHoverConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserJavascriptExecConfig": { "additionalProperties": false, "description": "``javascript_exec``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserJavascriptExecConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserKeyConfig": { "additionalProperties": false, "description": "``key``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserKeyConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserLeftClickConfig": { "additionalProperties": false, "description": "``left_click``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserLeftClickConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserLeftClickDragConfig": { "additionalProperties": false, "description": "``left_click_drag``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserLeftClickDragConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserLeftMouseDownConfig": { "additionalProperties": false, "description": "``left_mouse_down``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserLeftMouseDownConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserLeftMouseUpConfig": { "additionalProperties": false, "description": "``left_mouse_up``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserLeftMouseUpConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserListTabsConfig": { "additionalProperties": false, "description": "``list_tabs``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserListTabsConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserMiddleClickConfig": { "additionalProperties": false, "description": "``middle_click``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserMiddleClickConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserMouseMoveConfig": { "additionalProperties": false, "description": "``mouse_move``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserMouseMoveConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserNavigateConfig": { "additionalProperties": false, "description": "``navigate``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserNavigateConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserNewTabConfig": { "additionalProperties": false, "description": "``new_tab``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserNewTabConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserReadConsoleConfig": { "additionalProperties": false, "description": "``read_console``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserReadConsoleConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserReadNetworkConfig": { "additionalProperties": false, "description": "``read_network``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserReadNetworkConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserReadPageConfig": { "additionalProperties": false, "description": "``read_page``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserReadPageConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserRightClickConfig": { "additionalProperties": false, "description": "``right_click``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserRightClickConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserScreenshotConfig": { "additionalProperties": false, "description": "``screenshot``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserScreenshotConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserScrollConfig": { "additionalProperties": false, "description": "``scroll``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserScrollConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserScrollToConfig": { "additionalProperties": false, "description": "``scroll_to``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserScrollToConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserStateChangeDownloadCompleted": { "additionalProperties": false, "description": "A file download that finished during this call, reported with the\nsame `download_id` as its `download_started` — or without a prior\n`download_started`, when the download finished during the call that\nstarted it (at most one state change per `download_id` per result).", "properties": { "download_id": { "description": "The caller-assigned identifier for this download, stable across the state changes reporting it.", "maxLength": 4096, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f-\\x9f\\u2028\\u2029]*$", "title": "Download Id", "type": "string" }, "path": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "description": "Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path.", "pattern": "^[^\\x00-\\x1f\\x7f-\\x9f\\u2028\\u2029]*$", "title": "Path" }, "size_bytes": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "The completed download's size.", "title": "Size Bytes" }, "type": { "const": "download_completed", "title": "Type", "type": "string" }, "url": { "description": "The final post-redirect URL the download was served from.", "maxLength": 4096, "pattern": "^[^\\x00-\\x1f\\x7f-\\x9f\\u2028\\u2029]*$", "title": "Url", "type": "string" } }, "required": [ "download_id", "type", "url" ], "title": "BrowserStateChangeDownloadCompleted", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserStateChangeDownloadFailed": { "additionalProperties": false, "description": "A file download that failed — or was cancelled — during this call.", "properties": { "download_id": { "description": "The caller-assigned identifier for this download, stable across the state changes reporting it.", "maxLength": 4096, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f-\\x9f\\u2028\\u2029]*$", "title": "Download Id", "type": "string" }, "error": { "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "description": "The failure or cancellation detail, when known.", "pattern": "^[^\\x00-\\x1f\\x7f-\\x9f\\u2028\\u2029]*$", "title": "Error" }, "type": { "const": "download_failed", "title": "Type", "type": "string" }, "url": { "description": "The final post-redirect URL the download was served from.", "maxLength": 4096, "pattern": "^[^\\x00-\\x1f\\x7f-\\x9f\\u2028\\u2029]*$", "title": "Url", "type": "string" } }, "required": [ "download_id", "type", "url" ], "title": "BrowserStateChangeDownloadFailed", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserStateChangeDownloadStarted": { "additionalProperties": false, "description": "A file download that started during this call.", "properties": { "download_id": { "description": "The caller-assigned identifier for this download, stable across the state changes reporting it.", "maxLength": 4096, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f-\\x9f\\u2028\\u2029]*$", "title": "Download Id", "type": "string" }, "type": { "const": "download_started", "title": "Type", "type": "string" }, "url": { "description": "The final post-redirect URL the download was served from.", "maxLength": 4096, "pattern": "^[^\\x00-\\x1f\\x7f-\\x9f\\u2028\\u2029]*$", "title": "Url", "type": "string" } }, "required": [ "download_id", "type", "url" ], "title": "BrowserStateChangeDownloadStarted", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserStateChangeTabOpened": { "additionalProperties": false, "description": "A tab this call's execution opened that remains open at its end —\nthe creation delta of the `tabs` inventory, not an event log.\n\nCarries only the `tab_id`; the tab's `title` and `url` live on its\n`tabs` entry, which must include the same `tab_id`. A tab opened\nduring a failed call gets no deferred `tab_opened`; it simply appears\nin the next result's `tabs` inventory.", "properties": { "tab_id": { "description": "The `tab_id` of the opened tab, present in `tabs`.", "maxLength": 4096, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f-\\x9f\\u2028\\u2029]*$", "title": "Tab Id", "type": "string" }, "type": { "const": "tab_opened", "title": "Type", "type": "string" } }, "required": [ "tab_id", "type" ], "title": "BrowserStateChangeTabOpened", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserStateTabEntry": { "additionalProperties": false, "description": "One open browser tab reported in a `browser_state` block's `tabs`\ninventory.\n\n`tab_id` is the caller-assigned identifier for the tab; `title` and\n`url` describe the page the tab is currently showing and may be empty\nstrings (a blank tab legitimately has both empty). `active` marks the\ntab that is active after this call; whenever `tabs` is non-empty,\nexactly one entry is marked.", "properties": { "active": { "description": "Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.", "title": "Active", "type": "boolean" }, "tab_id": { "description": "The caller-assigned identifier for this tab, unique within the inventory.", "maxLength": 4096, "minLength": 1, "pattern": "^[^\\x00-\\x1f\\x7f-\\x9f\\u2028\\u2029]*$", "title": "Tab Id", "type": "string" }, "title": { "description": "The title of the page the tab is showing. May be empty.", "maxLength": 4096, "pattern": "^[^\\x00-\\x1f\\x7f-\\x9f\\u2028\\u2029]*$", "title": "Title", "type": "string" }, "url": { "description": "The URL of the page the tab is showing. May be empty.", "maxLength": 4096, "pattern": "^[^\\x00-\\x1f\\x7f-\\x9f\\u2028\\u2029]*$", "title": "Url", "type": "string" } }, "required": [ "tab_id", "title", "url" ], "title": "BrowserStateTabEntry", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserSwitchTabConfig": { "additionalProperties": false, "description": "``switch_tab``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserSwitchTabConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserToolsetConfigs": { "additionalProperties": false, "description": "Per-member configuration for ``browser_toolset_20260801``: one\noptional field per member tool, keyed by the member name — the same\nname the member's ``tool_use`` blocks carry. Every member is an\naccepted key, and a member's defaults apply wherever its key is\nabsent. Unknown keys are rejected: the field set is this toolset\nversion's complete member set.", "properties": { "close_tab": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserCloseTabConfig" }, { "type": "null" } ] }, "double_click": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserDoubleClickConfig" }, { "type": "null" } ] }, "file_upload": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserFileUploadConfig" }, { "type": "null" } ] }, "find": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserFindConfig" }, { "type": "null" } ] }, "form_input": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserFormInputConfig" }, { "type": "null" } ] }, "get_page_text": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserGetPageTextConfig" }, { "type": "null" } ] }, "hold_key": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserHoldKeyConfig" }, { "type": "null" } ] }, "hover": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserHoverConfig" }, { "type": "null" } ] }, "javascript_exec": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserJavascriptExecConfig" }, { "type": "null" } ] }, "key": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserKeyConfig" }, { "type": "null" } ] }, "left_click": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserLeftClickConfig" }, { "type": "null" } ] }, "left_click_drag": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserLeftClickDragConfig" }, { "type": "null" } ] }, "left_mouse_down": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserLeftMouseDownConfig" }, { "type": "null" } ] }, "left_mouse_up": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserLeftMouseUpConfig" }, { "type": "null" } ] }, "list_tabs": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserListTabsConfig" }, { "type": "null" } ] }, "middle_click": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserMiddleClickConfig" }, { "type": "null" } ] }, "mouse_move": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserMouseMoveConfig" }, { "type": "null" } ] }, "navigate": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserNavigateConfig" }, { "type": "null" } ] }, "new_tab": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserNewTabConfig" }, { "type": "null" } ] }, "read_console": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserReadConsoleConfig" }, { "type": "null" } ] }, "read_network": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserReadNetworkConfig" }, { "type": "null" } ] }, "read_page": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserReadPageConfig" }, { "type": "null" } ] }, "right_click": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserRightClickConfig" }, { "type": "null" } ] }, "screenshot": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserScreenshotConfig" }, { "type": "null" } ] }, "scroll": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserScrollConfig" }, { "type": "null" } ] }, "scroll_to": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserScrollToConfig" }, { "type": "null" } ] }, "switch_tab": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserSwitchTabConfig" }, { "type": "null" } ] }, "triple_click": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserTripleClickConfig" }, { "type": "null" } ] }, "type": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserTypeConfig" }, { "type": "null" } ] }, "wait": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserWaitConfig" }, { "type": "null" } ] }, "zoom": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserZoomConfig" }, { "type": "null" } ] } }, "title": "BrowserToolsetConfigs", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserToolset_20260801": { "additionalProperties": false, "description": "The browser toolset: a single ``tools[]`` entry (carrying no\n``name``) that declares the browser tool family. The model is served\nthe family's tool with any members disabled via ``configs`` removed\nfrom its schema.", "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "configs": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicBrowserToolsetConfigs" }, { "type": "null" } ], "description": "Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent." }, "type": { "const": "browser_toolset_20260801", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "BrowserToolset_20260801", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserTripleClickConfig": { "additionalProperties": false, "description": "``triple_click``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserTripleClickConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserTypeConfig": { "additionalProperties": false, "description": "``type``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserTypeConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserWaitConfig": { "additionalProperties": false, "description": "``wait``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserWaitConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicBrowserZoomConfig": { "additionalProperties": false, "description": "``zoom``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "BrowserZoomConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicCacheControlEphemeral": { "additionalProperties": false, "properties": { "ttl": { "description": "The time-to-live for the cache control breakpoint.\n\nThis may be one the following values:\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.", "enum": [ "5m", "1h" ], "title": "Ttl", "type": "string" }, "type": { "const": "ephemeral", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "CacheControlEphemeral", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicCacheCreation": { "properties": { "ephemeral_1h_input_tokens": { "default": 0, "description": "The number of input tokens used to create the 1 hour cache entry.", "minimum": 0, "title": "Ephemeral 1H Input Tokens", "type": "integer" }, "ephemeral_5m_input_tokens": { "default": 0, "description": "The number of input tokens used to create the 5 minute cache entry.", "minimum": 0, "title": "Ephemeral 5M Input Tokens", "type": "integer" } }, "required": [ "ephemeral_1h_input_tokens", "ephemeral_5m_input_tokens" ], "title": "CacheCreation", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicCitationsDelta": { "properties": { "citation": { "discriminator": { "mapping": { "char_location": "#/components/schemas/AnthropicResponseCharLocationCitation", "content_block_location": "#/components/schemas/AnthropicResponseContentBlockLocationCitation", "page_location": "#/components/schemas/AnthropicResponsePageLocationCitation", "search_result_location": "#/components/schemas/AnthropicResponseSearchResultLocationCitation", "web_search_result_location": "#/components/schemas/AnthropicResponseWebSearchResultLocationCitation" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicResponseCharLocationCitation" }, { "$ref": "#/components/schemas/AnthropicResponsePageLocationCitation" }, { "$ref": "#/components/schemas/AnthropicResponseContentBlockLocationCitation" }, { "$ref": "#/components/schemas/AnthropicResponseWebSearchResultLocationCitation" }, { "$ref": "#/components/schemas/AnthropicResponseSearchResultLocationCitation" } ], "title": "Citation" }, "type": { "const": "citations_delta", "default": "citations_delta", "title": "Type", "type": "string" } }, "required": [ "citation", "type" ], "title": "CitationsDelta", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicCodeExecutionToolResultErrorCode": { "enum": [ "invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded" ], "title": "CodeExecutionToolResultErrorCode", "type": "string", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicCodeExecutionTool_20250522": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "name": { "const": "code_execution", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "const": "code_execution_20250522", "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "CodeExecutionTool_20250522", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicCodeExecutionTool_20250825": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "name": { "const": "code_execution", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "const": "code_execution_20250825", "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "CodeExecutionTool_20250825", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicCodeExecutionTool_20260120": { "additionalProperties": false, "description": "Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).", "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "name": { "const": "code_execution", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "const": "code_execution_20260120", "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "CodeExecutionTool_20260120", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicCodeExecutionTool_20260521": { "additionalProperties": false, "description": "Code execution tool with REPL state persistence.", "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "name": { "const": "code_execution", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "const": "code_execution_20260521", "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "CodeExecutionTool_20260521", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerCursorPositionConfig": { "additionalProperties": false, "description": "``cursor_position``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerCursorPositionConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerDoubleClickConfig": { "additionalProperties": false, "description": "``double_click``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerDoubleClickConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerHoldKeyConfig": { "additionalProperties": false, "description": "``hold_key``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerHoldKeyConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerKeyConfig": { "additionalProperties": false, "description": "``key``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerKeyConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerLeftClickConfig": { "additionalProperties": false, "description": "``left_click``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerLeftClickConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerLeftClickDragConfig": { "additionalProperties": false, "description": "``left_click_drag``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerLeftClickDragConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerLeftMouseDownConfig": { "additionalProperties": false, "description": "``left_mouse_down``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerLeftMouseDownConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerLeftMouseUpConfig": { "additionalProperties": false, "description": "``left_mouse_up``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerLeftMouseUpConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerMiddleClickConfig": { "additionalProperties": false, "description": "``middle_click``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerMiddleClickConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerMouseMoveConfig": { "additionalProperties": false, "description": "``mouse_move``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerMouseMoveConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerRightClickConfig": { "additionalProperties": false, "description": "``right_click``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerRightClickConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerScreenshotConfig": { "additionalProperties": false, "description": "``screenshot``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerScreenshotConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerScrollConfig": { "additionalProperties": false, "description": "``scroll``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerScrollConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerToolsetConfigs": { "additionalProperties": false, "description": "Per-member configuration for ``computer_toolset_20260801``: one\noptional field per member tool, keyed by the member name — the same\nname the member's ``tool_use`` blocks carry. Every member is an\naccepted key, and a member's defaults apply wherever its key is\nabsent. Unknown keys are rejected: the field set is this toolset\nversion's complete member set.", "properties": { "cursor_position": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerCursorPositionConfig" }, { "type": "null" } ] }, "double_click": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerDoubleClickConfig" }, { "type": "null" } ] }, "hold_key": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerHoldKeyConfig" }, { "type": "null" } ] }, "key": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerKeyConfig" }, { "type": "null" } ] }, "left_click": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerLeftClickConfig" }, { "type": "null" } ] }, "left_click_drag": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerLeftClickDragConfig" }, { "type": "null" } ] }, "left_mouse_down": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerLeftMouseDownConfig" }, { "type": "null" } ] }, "left_mouse_up": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerLeftMouseUpConfig" }, { "type": "null" } ] }, "middle_click": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerMiddleClickConfig" }, { "type": "null" } ] }, "mouse_move": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerMouseMoveConfig" }, { "type": "null" } ] }, "right_click": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerRightClickConfig" }, { "type": "null" } ] }, "screenshot": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerScreenshotConfig" }, { "type": "null" } ] }, "scroll": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerScrollConfig" }, { "type": "null" } ] }, "triple_click": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerTripleClickConfig" }, { "type": "null" } ] }, "type": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerTypeConfig" }, { "type": "null" } ] }, "wait": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerWaitConfig" }, { "type": "null" } ] }, "zoom": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerZoomConfig" }, { "type": "null" } ] } }, "title": "ComputerToolsetConfigs", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerToolset_20260801": { "additionalProperties": false, "description": "The computer toolset: a single ``tools[]`` entry (carrying no\n``name``) that declares the computer tool family. The model is\nserved the family's tool with any members disabled via ``configs``\nremoved from its schema. Every member is enabled by default, zoom\nincluded. The single-tool options ``display_number`` and\n``enable_zoom`` are not fields of a toolset entry — it carries only\n``type``, ``configs``, and ``cache_control``; zoom is controlled\nvia ``configs.zoom.enabled``.", "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "configs": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicComputerToolsetConfigs" }, { "type": "null" } ], "description": "Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent." }, "type": { "const": "computer_toolset_20260801", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "ComputerToolset_20260801", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerTripleClickConfig": { "additionalProperties": false, "description": "``triple_click``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerTripleClickConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerTypeConfig": { "additionalProperties": false, "description": "``type``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerTypeConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerWaitConfig": { "additionalProperties": false, "description": "``wait``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerWaitConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicComputerZoomConfig": { "additionalProperties": false, "description": "``zoom``'s config overrides.", "properties": { "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.", "title": "Defer Loading" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.", "title": "Enabled" } }, "title": "ComputerZoomConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicContainer": { "description": "Information about the container used in the request (for the code execution tool)", "properties": { "expires_at": { "description": "The time at which the container will expire.", "format": "date-time", "title": "Expires At", "type": "string" }, "id": { "description": "Identifier for the container used in this request", "examples": [ "container_011CpZohnwH4vuy7gazohgSP" ], "title": "Id", "type": "string" }, "skills": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AnthropicContainerSkill" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Skills loaded in the container", "title": "Skills" } }, "required": [ "expires_at", "id", "skills" ], "title": "Container", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicContainerParams": { "additionalProperties": false, "description": "Container parameters with skills to be loaded.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Container id", "title": "Id" }, "skills": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AnthropicSkillParams" }, "maxItems": 20, "type": "array" }, { "type": "null" } ], "description": "List of skills to load in the container", "title": "Skills" } }, "title": "ContainerParams", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicContainerSkill": { "description": "A skill that was loaded in a container (response model).", "properties": { "skill_id": { "description": "Skill ID", "examples": [ "pdf" ], "maxLength": 64, "minLength": 1, "title": "Skill Id", "type": "string" }, "type": { "description": "Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)", "enum": [ "anthropic", "custom" ], "examples": [ "anthropic" ], "title": "Type", "type": "string" }, "version": { "description": "The resolved version: a skill version ID for custom skills.", "examples": [ "latest" ], "maxLength": 64, "minLength": 1, "title": "Version", "type": "string" } }, "required": [ "skill_id", "type", "version" ], "title": "ContainerSkill", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicContentBlockDeltaEvent": { "properties": { "delta": { "discriminator": { "mapping": { "citations_delta": "#/components/schemas/AnthropicCitationsDelta", "input_json_delta": "#/components/schemas/AnthropicInputJsonContentBlockDelta", "signature_delta": "#/components/schemas/AnthropicSignatureContentBlockDelta", "text_delta": "#/components/schemas/AnthropicTextContentBlockDelta", "thinking_delta": "#/components/schemas/AnthropicThinkingContentBlockDelta" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicTextContentBlockDelta" }, { "$ref": "#/components/schemas/AnthropicInputJsonContentBlockDelta" }, { "$ref": "#/components/schemas/AnthropicCitationsDelta" }, { "$ref": "#/components/schemas/AnthropicThinkingContentBlockDelta" }, { "$ref": "#/components/schemas/AnthropicSignatureContentBlockDelta" } ], "title": "Delta" }, "index": { "title": "Index", "type": "integer" }, "type": { "const": "content_block_delta", "default": "content_block_delta", "title": "Type", "type": "string" } }, "required": [ "delta", "index", "type" ], "title": "ContentBlockDeltaEvent", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicContentBlockSource": { "additionalProperties": false, "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "discriminator": { "mapping": { "image": "#/components/schemas/AnthropicRequestImageBlock", "text": "#/components/schemas/AnthropicRequestTextBlock" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicRequestTextBlock" }, { "$ref": "#/components/schemas/AnthropicRequestImageBlock" } ], "title": "content_block_source_content_item" }, "type": "array", "title": "content_block_source_content" } ], "title": "Content" }, "type": { "const": "content", "title": "Type", "type": "string" } }, "required": [ "content", "type" ], "title": "ContentBlockSource", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicContentBlockStartEvent": { "properties": { "content_block": { "discriminator": { "mapping": { "bash_code_execution_tool_result": "#/components/schemas/AnthropicResponseBashCodeExecutionToolResultBlock", "code_execution_tool_result": "#/components/schemas/AnthropicResponseCodeExecutionToolResultBlock", "container_upload": "#/components/schemas/AnthropicResponseContainerUploadBlock", "redacted_thinking": "#/components/schemas/AnthropicResponseRedactedThinkingBlock", "server_tool_use": "#/components/schemas/AnthropicResponseServerToolUseBlock", "text": "#/components/schemas/AnthropicResponseTextBlock", "text_editor_code_execution_tool_result": "#/components/schemas/AnthropicResponseTextEditorCodeExecutionToolResultBlock", "thinking": "#/components/schemas/AnthropicResponseThinkingBlock", "tool_search_tool_result": "#/components/schemas/AnthropicResponseToolSearchToolResultBlock", "tool_use": "#/components/schemas/AnthropicResponseToolUseBlock", "web_fetch_tool_result": "#/components/schemas/AnthropicResponseWebFetchToolResultBlock", "web_search_tool_result": "#/components/schemas/AnthropicResponseWebSearchToolResultBlock" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicResponseTextBlock" }, { "$ref": "#/components/schemas/AnthropicResponseThinkingBlock" }, { "$ref": "#/components/schemas/AnthropicResponseRedactedThinkingBlock" }, { "$ref": "#/components/schemas/AnthropicResponseToolUseBlock" }, { "$ref": "#/components/schemas/AnthropicResponseServerToolUseBlock" }, { "$ref": "#/components/schemas/AnthropicResponseWebSearchToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicResponseWebFetchToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicResponseCodeExecutionToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicResponseBashCodeExecutionToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicResponseTextEditorCodeExecutionToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicResponseToolSearchToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicResponseContainerUploadBlock" } ], "title": "Content Block" }, "index": { "title": "Index", "type": "integer" }, "type": { "const": "content_block_start", "default": "content_block_start", "title": "Type", "type": "string" } }, "required": [ "content_block", "index", "type" ], "title": "ContentBlockStartEvent", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicContentBlockStopEvent": { "properties": { "index": { "title": "Index", "type": "integer" }, "type": { "const": "content_block_stop", "default": "content_block_stop", "title": "Type", "type": "string" } }, "required": [ "index", "type" ], "title": "ContentBlockStopEvent", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicCreateMessageParams": { "additionalProperties": false, "example": { "max_tokens": 1024, "messages": [ { "content": "Hello, world", "role": "user" } ], "model": "claude-opus-5" }, "properties": { "model": { "$ref": "#/components/schemas/AnthropicModel" }, "messages": { "description": "Input messages.\n\nOur models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn.\n\nEach input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages.\n\nIf the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response.\n\nExample with a single `user` message:\n\n```json\n[{\"role\": \"user\", \"content\": \"Hello, Claude\"}]\n```\n\nExample with multiple conversational turns:\n\n```json\n[\n {\"role\": \"user\", \"content\": \"Hello there.\"},\n {\"role\": \"assistant\", \"content\": \"Hi, I'm Claude. How can I help you?\"},\n {\"role\": \"user\", \"content\": \"Can you explain LLMs in plain English?\"},\n]\n```\n\nExample with a partially-filled response from Claude:\n\n```json\n[\n {\"role\": \"user\", \"content\": \"What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun\"},\n {\"role\": \"assistant\", \"content\": \"The best answer is (\"},\n]\n```\n\nEach input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `\"text\"`. The following input messages are equivalent:\n\n```json\n{\"role\": \"user\", \"content\": \"Hello, Claude\"}\n```\n\n```json\n{\"role\": \"user\", \"content\": [{\"type\": \"text\", \"text\": \"Hello, Claude\"}]}\n```\n\nSee [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages).\n\nNote that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role), you can use the top-level `system` parameter — there is no `\"system\"` role for input messages in the Messages API.\n\nThere is a limit of 100,000 messages in a single request.", "items": { "$ref": "#/components/schemas/AnthropicInputMessage" }, "title": "Messages", "type": "array", "x-providers": { "openai": { "transform": "anthropic_messages_to_openai_messages" }, "azure": { "transform": "anthropic_messages_to_openai_messages" }, "gemini": { "to": [ "contents" ], "transform": "anthropic_messages_to_gemini_contents" }, "vertex": { "to": [ "contents" ], "transform": "anthropic_messages_to_gemini_contents" } }, "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.", "title": "Cache Control", "x-providers-default": "drop", "x-providers": { "anthropic": {}, "bedrock": {} }, "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "container": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicContainerParams" }, { "type": "string" }, { "type": "null" } ], "description": "Container identifier for reuse across requests.", "title": "Container", "x-providers-default": "drop", "x-providers": { "anthropic": {}, "bedrock": {} }, "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "inference_geo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used.", "title": "Inference Geo", "x-providers-default": "drop", "x-providers": { "anthropic": {} }, "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "max_tokens": { "description": "The maximum number of tokens to generate before stopping.\n\nNote that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.\n\nSet to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#pre-warming-the-cache) without generating a response.\n\nDifferent models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview) for details.", "examples": [ 1024 ], "minimum": 0, "title": "Max Tokens", "type": "integer", "x-providers": { "gemini": { "to": [ "generationConfig", "maxOutputTokens" ] }, "vertex": { "to": [ "generationConfig", "maxOutputTokens" ] } }, "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "metadata": { "$ref": "#/components/schemas/AnthropicMetadata", "description": "An object describing metadata about the request." }, "output_config": { "$ref": "#/components/schemas/AnthropicOutputConfig", "description": "Configuration options for the model's output, such as the output format.", "x-providers-default": "drop", "x-providers": { "anthropic": {} }, "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "service_tier": { "description": "Determines whether to use priority capacity (if available) or standard capacity for this request.\n\nAnthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers) for details.", "enum": [ "auto", "standard_only" ], "title": "Service Tier", "type": "string", "x-providers-default": "drop", "x-providers": { "anthropic": {}, "bedrock": {} }, "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "stop_sequences": { "description": "Custom text sequences that will cause the model to stop generating.\n\nOur models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `\"end_turn\"`.\n\nIf you want the model to stop generating when it encounters custom strings of text, you can use the `stop_sequences` parameter. If the model encounters one of the custom sequences, the response `stop_reason` value will be `\"stop_sequence\"` and the response `stop_sequence` value will contain the matched stop sequence.", "items": { "type": "string" }, "title": "Stop Sequences", "type": "array", "x-providers": { "openai": { "to": [ "stop" ] }, "azure": { "to": [ "stop" ] }, "gemini": { "to": [ "generationConfig", "stopSequences" ] }, "vertex": { "to": [ "generationConfig", "stopSequences" ] } }, "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "stream": { "description": "Whether to incrementally stream the response using server-sent events.\n\nSee [streaming](https://platform.claude.com/docs/en/build-with-claude/streaming) for details.", "title": "Stream", "type": "boolean", "example": false }, "system": { "anyOf": [ { "type": "string" }, { "items": { "$ref": "#/components/schemas/AnthropicRequestTextBlock" }, "type": "array" } ], "description": "System prompt.\n\nA system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role).", "examples": [ [ { "text": "Today's date is 2024-06-01.", "type": "text" } ], "Today's date is 2023-01-01." ], "title": "System", "x-providers-default": "drop", "x-providers": { "anthropic": {}, "bedrock": {}, "openai": { "transform": "anthropic_system_to_openai_system_message" }, "azure": { "transform": "anthropic_system_to_openai_system_message" }, "gemini": { "to": [ "systemInstruction" ], "transform": "anthropic_system_to_gemini_system_instruction" }, "vertex": { "to": [ "systemInstruction" ], "transform": "anthropic_system_to_gemini_system_instruction" } }, "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "temperature": { "deprecated": true, "description": "Amount of randomness injected into the response.\n\nDefaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks.\n\nNote that even with `temperature` of `0.0`, the results will not be fully deterministic.", "examples": [ 1 ], "maximum": 1, "minimum": 0, "title": "Temperature", "type": "number", "x-providers": { "gemini": { "to": [ "generationConfig", "temperature" ] }, "vertex": { "to": [ "generationConfig", "temperature" ] } }, "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "thinking": { "$ref": "#/components/schemas/AnthropicThinkingConfigParam", "x-providers-default": "drop", "x-providers": { "anthropic": {}, "bedrock": {} }, "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "tool_choice": { "$ref": "#/components/schemas/AnthropicToolChoice", "x-providers": { "openai": { "transform": "anthropic_tool_choice_to_openai_tool_choice" }, "azure": { "transform": "anthropic_tool_choice_to_openai_tool_choice" }, "gemini": { "to": [ "toolConfig" ], "transform": "anthropic_tool_choice_to_gemini_tool_config" }, "vertex": { "to": [ "toolConfig" ], "transform": "anthropic_tool_choice_to_gemini_tool_config" } }, "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "tools": { "description": "Definitions of tools that the model may use.\n\nIf you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks.\n\nThere are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool)).\n\nEach tool definition includes:\n\n* `name`: Name of the tool.\n* `description`: Optional, but strongly-recommended description of the tool.\n* `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks.\n\nFor example, if you defined `tools` as:\n\n```json\n[\n {\n \"name\": \"get_stock_price\",\n \"description\": \"Get the current stock price for a given ticker symbol.\",\n \"input_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"ticker\": {\n \"type\": \"string\",\n \"description\": \"The stock ticker symbol, e.g. AAPL for Apple Inc.\"\n }\n },\n \"required\": [\"ticker\"]\n }\n }\n]\n```\n\nAnd then asked the model \"What's the S&P 500 at today?\", the model might produce `tool_use` content blocks in the response like this:\n\n```json\n[\n {\n \"type\": \"tool_use\",\n \"id\": \"toolu_01D7FLrfh4GYq7yT1ULFeyMV\",\n \"name\": \"get_stock_price\",\n \"input\": { \"ticker\": \"^GSPC\" }\n }\n]\n```\n\nYou might then run your `get_stock_price` tool with `{\"ticker\": \"^GSPC\"}` as an input, and return the following back to the model in a subsequent `user` message:\n\n```json\n[\n {\n \"type\": \"tool_result\",\n \"tool_use_id\": \"toolu_01D7FLrfh4GYq7yT1ULFeyMV\",\n \"content\": \"259.75 USD\"\n }\n]\n```\n\nTools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.\n\nSee our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details.", "examples": [ { "description": "Get the current weather in a given location", "input_schema": { "properties": { "location": { "description": "The city and state, e.g. San Francisco, CA", "type": "string" }, "unit": { "description": "Unit for the output - one of (celsius, fahrenheit)", "type": "string" } }, "required": [ "location" ], "type": "object" }, "name": "get_weather" } ], "items": { "oneOf": [ { "$ref": "#/components/schemas/AnthropicTool" }, { "$ref": "#/components/schemas/AnthropicBashTool_20250124" }, { "$ref": "#/components/schemas/AnthropicCodeExecutionTool_20250522" }, { "$ref": "#/components/schemas/AnthropicCodeExecutionTool_20250825" }, { "$ref": "#/components/schemas/AnthropicCodeExecutionTool_20260120" }, { "$ref": "#/components/schemas/AnthropicCodeExecutionTool_20260521" }, { "$ref": "#/components/schemas/AnthropicBrowserToolset_20260801" }, { "$ref": "#/components/schemas/AnthropicMemoryTool_20250818" }, { "$ref": "#/components/schemas/AnthropicComputerToolset_20260801" }, { "$ref": "#/components/schemas/AnthropicTextEditor_20250124" }, { "$ref": "#/components/schemas/AnthropicTextEditor_20250429" }, { "$ref": "#/components/schemas/AnthropicTextEditor_20250728" }, { "$ref": "#/components/schemas/AnthropicWebSearchTool_20250305" }, { "$ref": "#/components/schemas/AnthropicWebFetchTool_20250910" }, { "$ref": "#/components/schemas/AnthropicWebSearchTool_20260209" }, { "$ref": "#/components/schemas/AnthropicWebFetchTool_20260209" }, { "$ref": "#/components/schemas/AnthropicWebFetchTool_20260309" }, { "$ref": "#/components/schemas/AnthropicWebSearchTool_20260318" }, { "$ref": "#/components/schemas/AnthropicWebFetchTool_20260318" }, { "$ref": "#/components/schemas/AnthropicToolSearchToolBM25_20251119" }, { "$ref": "#/components/schemas/AnthropicToolSearchToolRegex_20251119" } ] }, "title": "Tools", "type": "array", "x-providers": { "openai": { "transform": "anthropic_tools_to_openai_tools" }, "azure": { "transform": "anthropic_tools_to_openai_tools" }, "gemini": { "to": [ "tools" ], "transform": "anthropic_tools_to_gemini_tools" }, "vertex": { "to": [ "tools" ], "transform": "anthropic_tools_to_gemini_tools" } }, "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "top_k": { "deprecated": true, "description": "Only sample from the top K options for each subsequent token.\n\nUsed to remove \"long tail\" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277).\n\nRecommended for advanced use cases only.", "examples": [ 5 ], "minimum": 0, "title": "Top K", "type": "integer", "x-providers-default": "drop", "x-providers": { "anthropic": {}, "bedrock": {}, "cohere": {}, "gemini": { "to": [ "generationConfig", "topK" ] }, "vertex": { "to": [ "generationConfig", "topK" ] } }, "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "top_p": { "deprecated": true, "description": "Use nucleus sampling.\n\nIn nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`.\n\nRecommended for advanced use cases only.", "examples": [ 0.7 ], "maximum": 1, "minimum": 0, "title": "Top P", "type": "number", "x-providers": { "gemini": { "to": [ "generationConfig", "topP" ] }, "vertex": { "to": [ "generationConfig", "topP" ] } }, "x-source": { "from": "avs://anthropic/official", "authority": "official" } } }, "required": [ "model", "messages", "max_tokens" ], "title": "CreateMessageParams", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicDirectCaller": { "additionalProperties": false, "description": "Tool invocation directly from the model.", "properties": { "type": { "const": "direct", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "DirectCaller", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicEffortLevel": { "description": "All possible effort levels.", "enum": [ "low", "medium", "high", "xhigh", "max" ], "title": "EffortLevel", "type": "string", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicFileDocumentSource": { "additionalProperties": false, "properties": { "file_id": { "title": "File Id", "type": "string" }, "type": { "const": "file", "title": "Type", "type": "string" } }, "required": [ "file_id", "type" ], "title": "FileDocumentSource", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicFileImageSource": { "additionalProperties": false, "properties": { "file_id": { "title": "File Id", "type": "string" }, "type": { "const": "file", "title": "Type", "type": "string" } }, "required": [ "file_id", "type" ], "title": "FileImageSource", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicInputJsonContentBlockDelta": { "properties": { "partial_json": { "title": "Partial Json", "type": "string" }, "type": { "const": "input_json_delta", "default": "input_json_delta", "title": "Type", "type": "string" } }, "required": [ "partial_json", "type" ], "title": "InputJsonContentBlockDelta", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicInputMessage": { "additionalProperties": false, "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "$ref": "#/components/schemas/AnthropicInputContentBlock" }, "type": "array", "example": [ { "type": "text", "text": "What is a quaternion?" } ] } ], "title": "Content" }, "role": { "enum": [ "user", "assistant", "system" ], "title": "Role", "type": "string" } }, "required": [ "content", "role" ], "title": "InputMessage", "type": "object", "discriminator": { "propertyName": "role" }, "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicInputSchema": { "additionalProperties": true, "properties": { "properties": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Properties" }, "required": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Required" }, "type": { "const": "object", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "InputSchema", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicJsonOutputFormat": { "additionalProperties": false, "properties": { "schema": { "additionalProperties": true, "description": "The JSON schema of the format", "title": "Schema", "type": "object" }, "type": { "const": "json_schema", "title": "Type", "type": "string" } }, "required": [ "schema", "type" ], "title": "JsonOutputFormat", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicJsonValue": { "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicMemoryTool_20250818": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "input_examples": { "items": { "additionalProperties": { "$ref": "#/components/schemas/AnthropicJsonValue" }, "type": "object" }, "title": "Input Examples", "type": "array" }, "name": { "const": "memory", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "const": "memory_20250818", "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "MemoryTool_20250818", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicMessage": { "examples": [ { "content": [ { "citations": null, "text": "Hi! My name is Claude.", "type": "text" } ], "id": "msg_013Zva2CMHLNnXjNJJKqJ2EF", "model": "claude-opus-5", "role": "assistant", "stop_details": null, "stop_reason": "end_turn", "stop_sequence": null, "type": "message", "usage": { "input_tokens": 2095, "output_tokens": 503 } } ], "properties": { "id": { "description": "Unique object identifier.\n\nThe format and length of IDs may change over time.", "examples": [ "msg_013Zva2CMHLNnXjNJJKqJ2EF" ], "title": "Id", "type": "string" }, "type": { "const": "message", "default": "message", "description": "Object type.\n\nFor Messages, this is always `\"message\"`.", "title": "Type", "type": "string" }, "role": { "const": "assistant", "default": "assistant", "description": "Conversational role of the generated message.\n\nThis will always be `\"assistant\"`.", "title": "Role", "type": "string" }, "content": { "description": "Content generated by the model.\n\nThis is an array of content blocks, each of which has a `type` that determines its shape.\n\nExample:\n\n```json\n[{\"type\": \"text\", \"text\": \"Hi, I'm Claude.\"}]\n```\n\nIf the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output.\n\nFor example, if the input `messages` were:\n```json\n[\n {\"role\": \"user\", \"content\": \"What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun\"},\n {\"role\": \"assistant\", \"content\": \"The best answer is (\"}\n]\n```\n\nThen the response `content` might be:\n\n```json\n[{\"type\": \"text\", \"text\": \"B)\"}]\n```", "examples": [ [ { "citations": null, "text": "Hi! My name is Claude.", "type": "text" } ] ], "items": { "$ref": "#/components/schemas/AnthropicContentBlock" }, "title": "Content", "type": "array" }, "model": { "$ref": "#/components/schemas/AnthropicModel" }, "stop_reason": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicStopReason" }, { "type": "null" } ], "description": "The reason that we stopped.\n\nThis may be one the following values:\n* `\"end_turn\"`: the model reached a natural stopping point\n* `\"max_tokens\"`: we exceeded the requested `max_tokens` or the model's maximum\n* `\"stop_sequence\"`: one of your provided custom `stop_sequences` was generated\n* `\"tool_use\"`: the model invoked one or more tools\n* `\"pause_turn\"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue.\n* `\"refusal\"`: when streaming classifiers intervene to handle potential policy violations\n* `\"model_context_window_exceeded\"`: we exceeded the model's context window\n\nIn non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise.", "title": "Stop Reason" }, "stop_sequence": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Which custom stop sequence was generated, if any.\n\nThis value will be a non-null string if one of your custom stop sequences was generated.", "title": "Stop Sequence" }, "stop_details": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicRefusalStopDetails" }, { "type": "null" } ], "default": null, "description": "Structured information about why model output stopped.\n\nThis is `null` when the `stop_reason` has no additional detail to report." }, "usage": { "$ref": "#/components/schemas/AnthropicUsage", "description": "Billing and rate-limit usage.\n\nAnthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.\n\nUnder the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response.\n\nFor example, `output_tokens` will be non-zero, even for an empty string response from Claude.\n\nTotal input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`.", "examples": [ { "input_tokens": 2095, "output_tokens": 503 } ] }, "container": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicContainer" }, { "type": "null" } ], "default": null, "description": "Information about the container used in this request.\n\nThis will be non-null if a container tool (e.g. code execution) was used." } }, "required": [ "id", "type", "role", "content", "model", "stop_reason", "stop_sequence", "stop_details", "usage" ], "title": "Message", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicMessageDelta": { "properties": { "container": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicContainer" }, { "type": "null" } ], "default": null, "description": "Information about the container used in this request.\n\nThis will be non-null if a container tool (e.g. code execution) was used." }, "stop_details": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicRefusalStopDetails" }, { "type": "null" } ], "default": null, "description": "Structured information about why model output stopped.\n\nThis is `null` when the `stop_reason` has no additional detail to report." }, "stop_reason": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicStopReason" }, { "type": "null" } ], "default": null, "title": "Stop Reason" }, "stop_sequence": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Stop Sequence" } }, "required": [ "stop_details", "stop_reason", "stop_sequence" ], "title": "MessageDelta", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicMessageDeltaEvent": { "properties": { "delta": { "$ref": "#/components/schemas/AnthropicMessageDelta" }, "type": { "const": "message_delta", "default": "message_delta", "title": "Type", "type": "string" }, "usage": { "$ref": "#/components/schemas/AnthropicMessageDeltaUsage", "description": "Billing and rate-limit usage.\n\nAnthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.\n\nUnder the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response.\n\nFor example, `output_tokens` will be non-zero, even for an empty string response from Claude.\n\nTotal input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`.", "examples": [ { "output_tokens": 503 } ] } }, "required": [ "delta", "type", "usage" ], "title": "MessageDeltaEvent", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicMessageDeltaUsage": { "properties": { "cache_creation_input_tokens": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "The cumulative number of input tokens used to create the cache entry.", "examples": [ 2051 ], "title": "Cache Creation Input Tokens" }, "cache_read_input_tokens": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "The cumulative number of input tokens read from the cache.", "examples": [ 2051 ], "title": "Cache Read Input Tokens" }, "input_tokens": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "The cumulative number of input tokens which were used.", "examples": [ 2095 ], "title": "Input Tokens" }, "output_tokens": { "description": "The cumulative number of output tokens which were used.", "examples": [ 503 ], "title": "Output Tokens", "type": "integer" }, "output_tokens_details": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicOutputTokensDetails" }, { "type": "null" } ], "default": null, "description": "Breakdown of output tokens by category.\n\n`output_tokens` remains the inclusive, authoritative total used for billing.\nThis object provides a read-only decomposition for observability — for example,\nhow many of the billed output tokens were spent on internal reasoning that may\nhave been summarized before being returned to you." }, "server_tool_use": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicServerToolUsage" }, { "type": "null" } ], "default": null, "description": "The number of server tool requests." } }, "required": [ "cache_creation_input_tokens", "cache_read_input_tokens", "input_tokens", "output_tokens", "output_tokens_details" ], "title": "MessageDeltaUsage", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicMessageStartEvent": { "properties": { "message": { "$ref": "#/components/schemas/AnthropicMessage" }, "type": { "const": "message_start", "default": "message_start", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "MessageStartEvent", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicMessageStopEvent": { "properties": { "type": { "const": "message_stop", "default": "message_stop", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "MessageStopEvent", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicMessageStreamEvent": { "discriminator": { "mapping": { "content_block_delta": "#/components/schemas/AnthropicContentBlockDeltaEvent", "content_block_start": "#/components/schemas/AnthropicContentBlockStartEvent", "content_block_stop": "#/components/schemas/AnthropicContentBlockStopEvent", "message_delta": "#/components/schemas/AnthropicMessageDeltaEvent", "message_start": "#/components/schemas/AnthropicMessageStartEvent", "message_stop": "#/components/schemas/AnthropicMessageStopEvent" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicMessageStartEvent" }, { "$ref": "#/components/schemas/AnthropicMessageDeltaEvent" }, { "$ref": "#/components/schemas/AnthropicMessageStopEvent" }, { "$ref": "#/components/schemas/AnthropicContentBlockStartEvent" }, { "$ref": "#/components/schemas/AnthropicContentBlockDeltaEvent" }, { "$ref": "#/components/schemas/AnthropicContentBlockStopEvent" } ], "title": "MessageStreamEvent", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicMetadata": { "additionalProperties": false, "properties": { "user_id": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "description": "An external identifier for the user who is associated with the request.\n\nThis should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number.", "examples": [ "13803d75-b4b5-4c3e-b2a2-6f21399b021b" ], "title": "User Id" } }, "title": "Metadata", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicOutputConfig": { "additionalProperties": false, "properties": { "effort": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicEffortLevel" }, { "type": "null" } ], "description": "How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.\n\nValid values are `low`, `medium`, `high`, `xhigh`, or `max`.", "title": "Effort" }, "format": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicJsonOutputFormat" }, { "type": "null" } ], "description": "A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)" } }, "title": "OutputConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicOutputTokensDetails": { "properties": { "thinking_tokens": { "default": 0, "description": "Number of output tokens the model generated as internal reasoning, including\nthe thinking-block delimiter tokens.\n\nReflects the raw reasoning the model produced, not the (possibly shorter)\nsummarized thinking text returned in the response body. Computed by\nre-tokenizing the raw reasoning text, so it may differ from the model's exact\ngeneration count by a small number of tokens. Always ≤ `output_tokens`;\n`output_tokens - thinking_tokens` approximates the non-reasoning output.", "minimum": 0, "title": "Thinking Tokens", "type": "integer" } }, "required": [ "thinking_tokens" ], "title": "OutputTokensDetails", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicPlainTextSource": { "additionalProperties": false, "properties": { "data": { "title": "Data", "type": "string" }, "media_type": { "const": "text/plain", "title": "Media Type", "type": "string" }, "type": { "const": "text", "title": "Type", "type": "string" } }, "required": [ "data", "media_type", "type" ], "title": "PlainTextSource", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRefusalCategory": { "description": "The policy category that triggered a refusal.", "enum": [ "cyber", "bio", "frontier_llm", "reasoning_extraction", "general_harms" ], "title": "RefusalCategory", "type": "string", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRefusalStopDetails": { "description": "Structured information about a refusal.", "properties": { "category": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicRefusalCategory" }, { "type": "null" } ], "default": null, "description": "The policy category that triggered the refusal.\n\n`null` when the refusal doesn't map to a named category." }, "explanation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Human-readable explanation of the refusal.\n\nThis text is not guaranteed to be stable. `null` when no explanation is available for the category.", "examples": [ "This request was declined because it conflicts with Anthropic's Usage Policy." ], "title": "Explanation" }, "type": { "const": "refusal", "default": "refusal", "title": "Type", "type": "string" } }, "required": [ "category", "explanation", "type" ], "title": "RefusalStopDetails", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestBashCodeExecutionOutputBlock": { "additionalProperties": false, "properties": { "file_id": { "title": "File Id", "type": "string" }, "type": { "const": "bash_code_execution_output", "title": "Type", "type": "string" } }, "required": [ "file_id", "type" ], "title": "RequestBashCodeExecutionOutputBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestBashCodeExecutionResultBlock": { "additionalProperties": false, "properties": { "content": { "items": { "$ref": "#/components/schemas/AnthropicRequestBashCodeExecutionOutputBlock" }, "title": "Content", "type": "array" }, "return_code": { "title": "Return Code", "type": "integer" }, "stderr": { "title": "Stderr", "type": "string" }, "stdout": { "title": "Stdout", "type": "string" }, "type": { "const": "bash_code_execution_result", "title": "Type", "type": "string" } }, "required": [ "content", "return_code", "stderr", "stdout", "type" ], "title": "RequestBashCodeExecutionResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestBashCodeExecutionToolResultBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicRequestBashCodeExecutionToolResultError" }, { "$ref": "#/components/schemas/AnthropicRequestBashCodeExecutionResultBlock" } ], "title": "Content" }, "tool_use_id": { "pattern": "^srvtoolu_[a-zA-Z0-9_]+$", "title": "Tool Use Id", "type": "string" }, "type": { "const": "bash_code_execution_tool_result", "title": "Type", "type": "string" } }, "required": [ "content", "tool_use_id", "type" ], "title": "RequestBashCodeExecutionToolResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestBashCodeExecutionToolResultError": { "additionalProperties": false, "properties": { "error_code": { "$ref": "#/components/schemas/AnthropicBashCodeExecutionToolResultErrorCode" }, "type": { "const": "bash_code_execution_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "type" ], "title": "RequestBashCodeExecutionToolResultError", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestBrowserStateBlock": { "additionalProperties": false, "description": "The caller's browser state after a browser toolset member call —\nthe full inventory of open tabs, which tab is active, and any side\neffects (tabs opened, download state changes) the call produced.\n\nAt most one per `tool_result`, only on a non-error result answering a\nbrowser toolset member `tool_use`. The server renders the\nmodel-visible text from it; the model never sees the raw fields.", "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "state_changes": { "anyOf": [ { "items": { "discriminator": { "mapping": { "download_completed": "#/components/schemas/AnthropicBrowserStateChangeDownloadCompleted", "download_failed": "#/components/schemas/AnthropicBrowserStateChangeDownloadFailed", "download_started": "#/components/schemas/AnthropicBrowserStateChangeDownloadStarted", "tab_opened": "#/components/schemas/AnthropicBrowserStateChangeTabOpened" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicBrowserStateChangeTabOpened" }, { "$ref": "#/components/schemas/AnthropicBrowserStateChangeDownloadStarted" }, { "$ref": "#/components/schemas/AnthropicBrowserStateChangeDownloadCompleted" }, { "$ref": "#/components/schemas/AnthropicBrowserStateChangeDownloadFailed" } ] }, "maxItems": 200, "minItems": 1, "type": "array" }, { "type": "null" } ], "description": "Tabs opened and download state changes during this call. \"Nothing to report\" is expressed by omitting the field, never by an empty list.", "title": "State Changes" }, "tabs": { "description": "All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`.", "items": { "$ref": "#/components/schemas/AnthropicBrowserStateTabEntry" }, "maxItems": 100, "title": "Tabs", "type": "array" }, "type": { "const": "browser_state", "title": "Type", "type": "string" } }, "required": [ "tabs", "type" ], "title": "RequestBrowserStateBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestCharLocationCitation": { "additionalProperties": false, "properties": { "cited_text": { "examples": [ "The grass is green. The sky is blue." ], "title": "Cited Text", "type": "string" }, "document_index": { "minimum": 0, "title": "Document Index", "type": "integer" }, "document_title": { "anyOf": [ { "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Document Title" }, "end_char_index": { "title": "End Char Index", "type": "integer" }, "start_char_index": { "minimum": 0, "title": "Start Char Index", "type": "integer" }, "type": { "const": "char_location", "title": "Type", "type": "string" } }, "required": [ "cited_text", "document_index", "document_title", "end_char_index", "start_char_index", "type" ], "title": "RequestCharLocationCitation", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestCitationsConfig": { "additionalProperties": false, "properties": { "enabled": { "title": "Enabled", "type": "boolean" } }, "title": "RequestCitationsConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestCodeExecutionOutputBlock": { "additionalProperties": false, "properties": { "file_id": { "title": "File Id", "type": "string" }, "type": { "const": "code_execution_output", "title": "Type", "type": "string" } }, "required": [ "file_id", "type" ], "title": "RequestCodeExecutionOutputBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestCodeExecutionResultBlock": { "additionalProperties": false, "properties": { "content": { "items": { "$ref": "#/components/schemas/AnthropicRequestCodeExecutionOutputBlock" }, "title": "Content", "type": "array" }, "return_code": { "title": "Return Code", "type": "integer" }, "stderr": { "title": "Stderr", "type": "string" }, "stdout": { "title": "Stdout", "type": "string" }, "type": { "const": "code_execution_result", "title": "Type", "type": "string" } }, "required": [ "content", "return_code", "stderr", "stdout", "type" ], "title": "RequestCodeExecutionResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestCodeExecutionToolResultBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicRequestCodeExecutionToolResultError" }, { "$ref": "#/components/schemas/AnthropicRequestCodeExecutionResultBlock" }, { "$ref": "#/components/schemas/AnthropicRequestEncryptedCodeExecutionResultBlock" } ], "title": "Content" }, "tool_use_id": { "pattern": "^srvtoolu_[a-zA-Z0-9_]+$", "title": "Tool Use Id", "type": "string" }, "type": { "const": "code_execution_tool_result", "title": "Type", "type": "string" } }, "required": [ "content", "tool_use_id", "type" ], "title": "RequestCodeExecutionToolResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestCodeExecutionToolResultError": { "additionalProperties": false, "properties": { "error_code": { "$ref": "#/components/schemas/AnthropicCodeExecutionToolResultErrorCode" }, "type": { "const": "code_execution_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "type" ], "title": "RequestCodeExecutionToolResultError", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestContainerUploadBlock": { "additionalProperties": false, "description": "A content block that represents a file to be uploaded to the container\nFiles uploaded via this block will be available in the container's input directory.", "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "file_id": { "title": "File Id", "type": "string" }, "type": { "const": "container_upload", "title": "Type", "type": "string" } }, "required": [ "file_id", "type" ], "title": "RequestContainerUploadBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestContentBlockLocationCitation": { "additionalProperties": false, "properties": { "cited_text": { "description": "The full text of the cited block range, concatenated.\n\nAlways equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.", "examples": [ "The grass is green. The sky is blue." ], "title": "Cited Text", "type": "string" }, "document_index": { "minimum": 0, "title": "Document Index", "type": "integer" }, "document_title": { "anyOf": [ { "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Document Title" }, "end_block_index": { "description": "Exclusive 0-based end index of the cited block range in the source's `content` array.\n\nAlways greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.", "title": "End Block Index", "type": "integer" }, "start_block_index": { "description": "0-based index of the first cited block in the source's `content` array.", "minimum": 0, "title": "Start Block Index", "type": "integer" }, "type": { "const": "content_block_location", "title": "Type", "type": "string" } }, "required": [ "cited_text", "document_index", "document_title", "end_block_index", "start_block_index", "type" ], "title": "RequestContentBlockLocationCitation", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestDocumentBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "citations": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicRequestCitationsConfig" }, { "type": "null" } ] }, "context": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Context" }, "source": { "discriminator": { "mapping": { "base64": "#/components/schemas/AnthropicBase64PDFSource", "content": "#/components/schemas/AnthropicContentBlockSource", "file": "#/components/schemas/AnthropicFileDocumentSource", "text": "#/components/schemas/AnthropicPlainTextSource", "url": "#/components/schemas/AnthropicURLPDFSource" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicBase64PDFSource" }, { "$ref": "#/components/schemas/AnthropicPlainTextSource" }, { "$ref": "#/components/schemas/AnthropicContentBlockSource" }, { "$ref": "#/components/schemas/AnthropicURLPDFSource" }, { "$ref": "#/components/schemas/AnthropicFileDocumentSource" } ], "title": "Source" }, "title": { "anyOf": [ { "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Title" }, "type": { "const": "document", "title": "Type", "type": "string" } }, "required": [ "source", "type" ], "title": "RequestDocumentBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestEncryptedCodeExecutionResultBlock": { "additionalProperties": false, "description": "Code execution result with encrypted stdout for PFC + web_search results.", "properties": { "content": { "items": { "$ref": "#/components/schemas/AnthropicRequestCodeExecutionOutputBlock" }, "title": "Content", "type": "array" }, "encrypted_stdout": { "title": "Encrypted Stdout", "type": "string" }, "return_code": { "title": "Return Code", "type": "integer" }, "stderr": { "title": "Stderr", "type": "string" }, "type": { "const": "encrypted_code_execution_result", "title": "Type", "type": "string" } }, "required": [ "content", "encrypted_stdout", "return_code", "stderr", "type" ], "title": "RequestEncryptedCodeExecutionResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestImageBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "source": { "discriminator": { "mapping": { "base64": "#/components/schemas/AnthropicBase64ImageSource", "file": "#/components/schemas/AnthropicFileImageSource", "url": "#/components/schemas/AnthropicURLImageSource" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicBase64ImageSource" }, { "$ref": "#/components/schemas/AnthropicURLImageSource" }, { "$ref": "#/components/schemas/AnthropicFileImageSource" } ], "title": "Source" }, "transformations": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicRequestImageTransformations" }, { "type": "null" } ], "description": "Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field." }, "type": { "const": "image", "title": "Type", "type": "string" } }, "required": [ "source", "type" ], "title": "RequestImageBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestImageTransformations": { "additionalProperties": false, "description": "Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field.", "properties": { "oversized_image": { "description": "What the server does when this image exceeds the model's maximum image size. `\"downsize\"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `\"error\"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down.", "enum": [ "downsize", "error" ], "title": "Oversized Image", "type": "string" } }, "title": "RequestImageTransformations", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestPageLocationCitation": { "additionalProperties": false, "properties": { "cited_text": { "examples": [ "The grass is green. The sky is blue." ], "title": "Cited Text", "type": "string" }, "document_index": { "minimum": 0, "title": "Document Index", "type": "integer" }, "document_title": { "anyOf": [ { "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Document Title" }, "end_page_number": { "title": "End Page Number", "type": "integer" }, "start_page_number": { "minimum": 1, "title": "Start Page Number", "type": "integer" }, "type": { "const": "page_location", "title": "Type", "type": "string" } }, "required": [ "cited_text", "document_index", "document_title", "end_page_number", "start_page_number", "type" ], "title": "RequestPageLocationCitation", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestRedactedThinkingBlock": { "additionalProperties": false, "properties": { "data": { "description": "The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged.", "title": "Data", "type": "string" }, "type": { "const": "redacted_thinking", "title": "Type", "type": "string" } }, "required": [ "data", "type" ], "title": "RequestRedactedThinkingBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestSearchResultBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "citations": { "$ref": "#/components/schemas/AnthropicRequestCitationsConfig" }, "content": { "items": { "$ref": "#/components/schemas/AnthropicRequestTextBlock" }, "title": "Content", "type": "array" }, "source": { "title": "Source", "type": "string" }, "title": { "title": "Title", "type": "string" }, "type": { "const": "search_result", "title": "Type", "type": "string" } }, "required": [ "content", "source", "title", "type" ], "title": "RequestSearchResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestSearchResultLocationCitation": { "additionalProperties": false, "properties": { "cited_text": { "description": "The full text of the cited block range, concatenated.\n\nAlways equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.", "examples": [ "The grass is green. The sky is blue." ], "title": "Cited Text", "type": "string" }, "end_block_index": { "description": "Exclusive 0-based end index of the cited block range in the source's `content` array.\n\nAlways greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.", "title": "End Block Index", "type": "integer" }, "search_result_index": { "description": "0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results.\n\nCounted separately from `document_index`; server-side web search results are not included in this count.", "minimum": 0, "title": "Search Result Index", "type": "integer" }, "source": { "title": "Source", "type": "string" }, "start_block_index": { "description": "0-based index of the first cited block in the source's `content` array.", "minimum": 0, "title": "Start Block Index", "type": "integer" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "type": { "const": "search_result_location", "title": "Type", "type": "string" } }, "required": [ "cited_text", "end_block_index", "search_result_index", "source", "start_block_index", "title", "type" ], "title": "RequestSearchResultLocationCitation", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestServerToolUseBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "caller": { "discriminator": { "mapping": { "code_execution_20250825": "#/components/schemas/AnthropicServerToolCaller", "code_execution_20260120": "#/components/schemas/AnthropicServerToolCaller_20260120", "direct": "#/components/schemas/AnthropicDirectCaller" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicDirectCaller" }, { "$ref": "#/components/schemas/AnthropicServerToolCaller" }, { "$ref": "#/components/schemas/AnthropicServerToolCaller_20260120" } ], "title": "Caller" }, "id": { "pattern": "^srvtoolu_[a-zA-Z0-9_]+$", "title": "Id", "type": "string" }, "input": { "additionalProperties": true, "title": "Input", "type": "object" }, "name": { "enum": [ "web_search", "web_fetch", "code_execution", "bash_code_execution", "text_editor_code_execution", "tool_search_tool_regex", "tool_search_tool_bm25" ], "title": "Name", "type": "string" }, "type": { "const": "server_tool_use", "title": "Type", "type": "string" } }, "required": [ "id", "input", "name", "type" ], "title": "RequestServerToolUseBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestTextBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "citations": { "anyOf": [ { "items": { "discriminator": { "mapping": { "char_location": "#/components/schemas/AnthropicRequestCharLocationCitation", "content_block_location": "#/components/schemas/AnthropicRequestContentBlockLocationCitation", "page_location": "#/components/schemas/AnthropicRequestPageLocationCitation", "search_result_location": "#/components/schemas/AnthropicRequestSearchResultLocationCitation", "web_search_result_location": "#/components/schemas/AnthropicRequestWebSearchResultLocationCitation" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicRequestCharLocationCitation" }, { "$ref": "#/components/schemas/AnthropicRequestPageLocationCitation" }, { "$ref": "#/components/schemas/AnthropicRequestContentBlockLocationCitation" }, { "$ref": "#/components/schemas/AnthropicRequestWebSearchResultLocationCitation" }, { "$ref": "#/components/schemas/AnthropicRequestSearchResultLocationCitation" } ] }, "type": "array" }, { "type": "null" } ], "title": "Citations" }, "text": { "minLength": 1, "title": "Text", "type": "string" }, "type": { "const": "text", "title": "Type", "type": "string" } }, "required": [ "text", "type" ], "title": "RequestTextBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestTextEditorCodeExecutionCreateResultBlock": { "additionalProperties": false, "properties": { "is_file_update": { "title": "Is File Update", "type": "boolean" }, "type": { "const": "text_editor_code_execution_create_result", "title": "Type", "type": "string" } }, "required": [ "is_file_update", "type" ], "title": "RequestTextEditorCodeExecutionCreateResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestTextEditorCodeExecutionStrReplaceResultBlock": { "additionalProperties": false, "properties": { "lines": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Lines" }, "new_lines": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "New Lines" }, "new_start": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "New Start" }, "old_lines": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Old Lines" }, "old_start": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Old Start" }, "type": { "const": "text_editor_code_execution_str_replace_result", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "RequestTextEditorCodeExecutionStrReplaceResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestTextEditorCodeExecutionToolResultBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicRequestTextEditorCodeExecutionToolResultError" }, { "$ref": "#/components/schemas/AnthropicRequestTextEditorCodeExecutionViewResultBlock" }, { "$ref": "#/components/schemas/AnthropicRequestTextEditorCodeExecutionCreateResultBlock" }, { "$ref": "#/components/schemas/AnthropicRequestTextEditorCodeExecutionStrReplaceResultBlock" } ], "title": "Content" }, "tool_use_id": { "pattern": "^srvtoolu_[a-zA-Z0-9_]+$", "title": "Tool Use Id", "type": "string" }, "type": { "const": "text_editor_code_execution_tool_result", "title": "Type", "type": "string" } }, "required": [ "content", "tool_use_id", "type" ], "title": "RequestTextEditorCodeExecutionToolResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestTextEditorCodeExecutionToolResultError": { "additionalProperties": false, "properties": { "error_code": { "$ref": "#/components/schemas/AnthropicTextEditorCodeExecutionToolResultErrorCode" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "type": { "const": "text_editor_code_execution_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "type" ], "title": "RequestTextEditorCodeExecutionToolResultError", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestTextEditorCodeExecutionViewResultBlock": { "additionalProperties": false, "properties": { "content": { "title": "Content", "type": "string" }, "file_type": { "enum": [ "text", "image", "pdf" ], "title": "File Type", "type": "string" }, "num_lines": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Num Lines" }, "start_line": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Start Line" }, "total_lines": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Lines" }, "type": { "const": "text_editor_code_execution_view_result", "title": "Type", "type": "string" } }, "required": [ "content", "file_type", "type" ], "title": "RequestTextEditorCodeExecutionViewResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestThinkingBlock": { "additionalProperties": false, "properties": { "signature": { "description": "The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude.\n\nThinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`.", "title": "Signature", "type": "string" }, "thinking": { "description": "The `thinking` text of this block as returned by the API.", "title": "Thinking", "type": "string" }, "type": { "const": "thinking", "title": "Type", "type": "string" } }, "required": [ "signature", "thinking", "type" ], "title": "RequestThinkingBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestToolReferenceBlock": { "additionalProperties": false, "description": "Tool reference block that can be included in tool_result content.", "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "tool_name": { "maxLength": 256, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]{1,256}$", "title": "Tool Name", "type": "string" }, "type": { "const": "tool_reference", "title": "Type", "type": "string" } }, "required": [ "tool_name", "type" ], "title": "RequestToolReferenceBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestToolResultBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "content": { "anyOf": [ { "type": "string" }, { "items": { "discriminator": { "mapping": { "browser_state": "#/components/schemas/AnthropicRequestBrowserStateBlock", "document": "#/components/schemas/AnthropicRequestDocumentBlock", "image": "#/components/schemas/AnthropicRequestImageBlock", "search_result": "#/components/schemas/AnthropicRequestSearchResultBlock", "text": "#/components/schemas/AnthropicRequestTextBlock", "tool_reference": "#/components/schemas/AnthropicRequestToolReferenceBlock" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicRequestTextBlock" }, { "$ref": "#/components/schemas/AnthropicRequestImageBlock" }, { "$ref": "#/components/schemas/AnthropicRequestSearchResultBlock" }, { "$ref": "#/components/schemas/AnthropicRequestDocumentBlock" }, { "$ref": "#/components/schemas/AnthropicRequestToolReferenceBlock" }, { "$ref": "#/components/schemas/AnthropicRequestBrowserStateBlock" } ], "title": "Block" }, "type": "array" } ], "title": "Content" }, "is_error": { "title": "Is Error", "type": "boolean" }, "tool_use_id": { "pattern": "^[a-zA-Z0-9_-]+$", "title": "Tool Use Id", "type": "string" }, "toolset_name": { "anyOf": [ { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "type": "string" }, { "type": "null" } ], "description": "For a toolset member tool_result, the toolset family of the paired tool_use.", "title": "Toolset Name" }, "type": { "const": "tool_result", "title": "Type", "type": "string" } }, "required": [ "tool_use_id", "type" ], "title": "RequestToolResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestToolSearchToolResultBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicRequestToolSearchToolResultError" }, { "$ref": "#/components/schemas/AnthropicRequestToolSearchToolSearchResultBlock" } ], "title": "Content" }, "tool_use_id": { "pattern": "^srvtoolu_[a-zA-Z0-9_]+$", "title": "Tool Use Id", "type": "string" }, "type": { "const": "tool_search_tool_result", "title": "Type", "type": "string" } }, "required": [ "content", "tool_use_id", "type" ], "title": "RequestToolSearchToolResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestToolSearchToolResultError": { "additionalProperties": false, "properties": { "error_code": { "$ref": "#/components/schemas/AnthropicToolSearchToolResultErrorCode" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "type": { "const": "tool_search_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "type" ], "title": "RequestToolSearchToolResultError", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestToolSearchToolSearchResultBlock": { "additionalProperties": false, "properties": { "tool_references": { "items": { "$ref": "#/components/schemas/AnthropicRequestToolReferenceBlock" }, "title": "Tool References", "type": "array" }, "type": { "const": "tool_search_tool_search_result", "title": "Type", "type": "string" } }, "required": [ "tool_references", "type" ], "title": "RequestToolSearchToolSearchResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestToolUseBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "caller": { "discriminator": { "mapping": { "code_execution_20250825": "#/components/schemas/AnthropicServerToolCaller", "code_execution_20260120": "#/components/schemas/AnthropicServerToolCaller_20260120", "direct": "#/components/schemas/AnthropicDirectCaller" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicDirectCaller" }, { "$ref": "#/components/schemas/AnthropicServerToolCaller" }, { "$ref": "#/components/schemas/AnthropicServerToolCaller_20260120" } ], "title": "Caller" }, "id": { "pattern": "^[a-zA-Z0-9_-]+$", "title": "Id", "type": "string" }, "input": { "additionalProperties": true, "title": "Input", "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" }, "toolset_name": { "anyOf": [ { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "type": "string" }, { "type": "null" } ], "description": "For a toolset member tool_use, the toolset family this member belongs to.", "title": "Toolset Name" }, "type": { "const": "tool_use", "title": "Type", "type": "string" } }, "required": [ "id", "input", "name", "type" ], "title": "RequestToolUseBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestWebFetchResultBlock": { "additionalProperties": false, "properties": { "content": { "$ref": "#/components/schemas/AnthropicRequestDocumentBlock" }, "retrieved_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO 8601 timestamp when the content was retrieved", "title": "Retrieved At" }, "type": { "const": "web_fetch_result", "title": "Type", "type": "string" }, "url": { "description": "Fetched content URL", "title": "Url", "type": "string" } }, "required": [ "content", "type", "url" ], "title": "RequestWebFetchResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestWebFetchToolResultBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "caller": { "discriminator": { "mapping": { "code_execution_20250825": "#/components/schemas/AnthropicServerToolCaller", "code_execution_20260120": "#/components/schemas/AnthropicServerToolCaller_20260120", "direct": "#/components/schemas/AnthropicDirectCaller" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicDirectCaller" }, { "$ref": "#/components/schemas/AnthropicServerToolCaller" }, { "$ref": "#/components/schemas/AnthropicServerToolCaller_20260120" } ], "title": "Caller" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicRequestWebFetchToolResultError" }, { "$ref": "#/components/schemas/AnthropicRequestWebFetchResultBlock" } ], "title": "Content" }, "tool_use_id": { "pattern": "^srvtoolu_[a-zA-Z0-9_]+$", "title": "Tool Use Id", "type": "string" }, "type": { "const": "web_fetch_tool_result", "title": "Type", "type": "string" } }, "required": [ "content", "tool_use_id", "type" ], "title": "RequestWebFetchToolResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestWebFetchToolResultError": { "additionalProperties": false, "properties": { "error_code": { "$ref": "#/components/schemas/AnthropicWebFetchToolResultErrorCode" }, "type": { "const": "web_fetch_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "type" ], "title": "RequestWebFetchToolResultError", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestWebSearchResultBlock": { "additionalProperties": false, "properties": { "encrypted_content": { "title": "Encrypted Content", "type": "string" }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Age" }, "title": { "title": "Title", "type": "string" }, "type": { "const": "web_search_result", "title": "Type", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "encrypted_content", "title", "type", "url" ], "title": "RequestWebSearchResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestWebSearchResultLocationCitation": { "additionalProperties": false, "properties": { "cited_text": { "examples": [ "The grass is green. The sky is blue." ], "title": "Cited Text", "type": "string" }, "encrypted_index": { "title": "Encrypted Index", "type": "string" }, "title": { "anyOf": [ { "maxLength": 512, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Title" }, "type": { "const": "web_search_result_location", "title": "Type", "type": "string" }, "url": { "minLength": 1, "title": "Url", "type": "string" } }, "required": [ "cited_text", "encrypted_index", "title", "type", "url" ], "title": "RequestWebSearchResultLocationCitation", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestWebSearchToolResultBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "caller": { "discriminator": { "mapping": { "code_execution_20250825": "#/components/schemas/AnthropicServerToolCaller", "code_execution_20260120": "#/components/schemas/AnthropicServerToolCaller_20260120", "direct": "#/components/schemas/AnthropicDirectCaller" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicDirectCaller" }, { "$ref": "#/components/schemas/AnthropicServerToolCaller" }, { "$ref": "#/components/schemas/AnthropicServerToolCaller_20260120" } ], "title": "Caller" }, "content": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AnthropicRequestWebSearchResultBlock" }, "type": "array", "title": "web_search_tool_result_block_item" }, { "$ref": "#/components/schemas/AnthropicRequestWebSearchToolResultError" } ], "title": "Content" }, "tool_use_id": { "pattern": "^srvtoolu_[a-zA-Z0-9_]+$", "title": "Tool Use Id", "type": "string" }, "type": { "const": "web_search_tool_result", "title": "Type", "type": "string" } }, "required": [ "content", "tool_use_id", "type" ], "title": "RequestWebSearchToolResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestWebSearchToolResultError": { "additionalProperties": false, "properties": { "error_code": { "$ref": "#/components/schemas/AnthropicWebSearchToolResultErrorCode" }, "type": { "const": "web_search_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "type" ], "title": "RequestWebSearchToolResultError", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseBashCodeExecutionOutputBlock": { "properties": { "file_id": { "title": "File Id", "type": "string" }, "type": { "const": "bash_code_execution_output", "default": "bash_code_execution_output", "title": "Type", "type": "string" } }, "required": [ "file_id", "type" ], "title": "ResponseBashCodeExecutionOutputBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseBashCodeExecutionResultBlock": { "properties": { "content": { "items": { "$ref": "#/components/schemas/AnthropicResponseBashCodeExecutionOutputBlock" }, "title": "Content", "type": "array" }, "return_code": { "title": "Return Code", "type": "integer" }, "stderr": { "title": "Stderr", "type": "string" }, "stdout": { "title": "Stdout", "type": "string" }, "type": { "const": "bash_code_execution_result", "default": "bash_code_execution_result", "title": "Type", "type": "string" } }, "required": [ "content", "return_code", "stderr", "stdout", "type" ], "title": "ResponseBashCodeExecutionResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseBashCodeExecutionToolResultBlock": { "properties": { "content": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicResponseBashCodeExecutionToolResultError" }, { "$ref": "#/components/schemas/AnthropicResponseBashCodeExecutionResultBlock" } ], "title": "Content" }, "tool_use_id": { "pattern": "^srvtoolu_[a-zA-Z0-9_]+$", "title": "Tool Use Id", "type": "string" }, "type": { "const": "bash_code_execution_tool_result", "default": "bash_code_execution_tool_result", "title": "Type", "type": "string" } }, "required": [ "content", "tool_use_id", "type" ], "title": "ResponseBashCodeExecutionToolResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseBashCodeExecutionToolResultError": { "properties": { "error_code": { "$ref": "#/components/schemas/AnthropicBashCodeExecutionToolResultErrorCode" }, "type": { "const": "bash_code_execution_tool_result_error", "default": "bash_code_execution_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "type" ], "title": "ResponseBashCodeExecutionToolResultError", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseCharLocationCitation": { "properties": { "cited_text": { "examples": [ "The grass is green. The sky is blue." ], "title": "Cited Text", "type": "string" }, "document_index": { "minimum": 0, "title": "Document Index", "type": "integer" }, "document_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "examples": [ "My Document" ], "title": "Document Title" }, "end_char_index": { "title": "End Char Index", "type": "integer" }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "examples": [ "file_011CNha8iCJcU1wXNR6q4V8w" ], "title": "File Id" }, "start_char_index": { "minimum": 0, "title": "Start Char Index", "type": "integer" }, "type": { "const": "char_location", "default": "char_location", "title": "Type", "type": "string" } }, "required": [ "cited_text", "document_index", "document_title", "end_char_index", "file_id", "start_char_index", "type" ], "title": "ResponseCharLocationCitation", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseCitationsConfig": { "properties": { "enabled": { "default": false, "title": "Enabled", "type": "boolean" } }, "required": [ "enabled" ], "title": "ResponseCitationsConfig", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseCodeExecutionOutputBlock": { "properties": { "file_id": { "title": "File Id", "type": "string" }, "type": { "const": "code_execution_output", "default": "code_execution_output", "title": "Type", "type": "string" } }, "required": [ "file_id", "type" ], "title": "ResponseCodeExecutionOutputBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseCodeExecutionResultBlock": { "properties": { "content": { "items": { "$ref": "#/components/schemas/AnthropicResponseCodeExecutionOutputBlock" }, "title": "Content", "type": "array" }, "return_code": { "title": "Return Code", "type": "integer" }, "stderr": { "title": "Stderr", "type": "string" }, "stdout": { "title": "Stdout", "type": "string" }, "type": { "const": "code_execution_result", "default": "code_execution_result", "title": "Type", "type": "string" } }, "required": [ "content", "return_code", "stderr", "stdout", "type" ], "title": "ResponseCodeExecutionResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseCodeExecutionToolResultBlock": { "properties": { "content": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicResponseCodeExecutionToolResultError" }, { "$ref": "#/components/schemas/AnthropicResponseCodeExecutionResultBlock" }, { "$ref": "#/components/schemas/AnthropicResponseEncryptedCodeExecutionResultBlock" } ], "title": "Content" }, "tool_use_id": { "pattern": "^srvtoolu_[a-zA-Z0-9_]+$", "title": "Tool Use Id", "type": "string" }, "type": { "const": "code_execution_tool_result", "default": "code_execution_tool_result", "title": "Type", "type": "string" } }, "required": [ "content", "tool_use_id", "type" ], "title": "ResponseCodeExecutionToolResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseCodeExecutionToolResultError": { "properties": { "error_code": { "$ref": "#/components/schemas/AnthropicCodeExecutionToolResultErrorCode" }, "type": { "const": "code_execution_tool_result_error", "default": "code_execution_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "type" ], "title": "ResponseCodeExecutionToolResultError", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseContainerUploadBlock": { "description": "Response model for a file uploaded to the container.", "properties": { "file_id": { "title": "File Id", "type": "string" }, "type": { "const": "container_upload", "default": "container_upload", "title": "Type", "type": "string" } }, "required": [ "file_id", "type" ], "title": "ResponseContainerUploadBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseContentBlockLocationCitation": { "properties": { "cited_text": { "description": "The full text of the cited block range, concatenated.\n\nAlways equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.", "examples": [ "The grass is green. The sky is blue." ], "title": "Cited Text", "type": "string" }, "document_index": { "minimum": 0, "title": "Document Index", "type": "integer" }, "document_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "examples": [ "My Document" ], "title": "Document Title" }, "end_block_index": { "description": "Exclusive 0-based end index of the cited block range in the source's `content` array.\n\nAlways greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.", "title": "End Block Index", "type": "integer" }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "examples": [ "file_011CNha8iCJcU1wXNR6q4V8w" ], "title": "File Id" }, "start_block_index": { "description": "0-based index of the first cited block in the source's `content` array.", "minimum": 0, "title": "Start Block Index", "type": "integer" }, "type": { "const": "content_block_location", "default": "content_block_location", "title": "Type", "type": "string" } }, "required": [ "cited_text", "document_index", "document_title", "end_block_index", "file_id", "start_block_index", "type" ], "title": "ResponseContentBlockLocationCitation", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseDocumentBlock": { "properties": { "citations": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicResponseCitationsConfig" }, { "type": "null" } ], "default": null, "description": "Citation configuration for the document" }, "source": { "discriminator": { "mapping": { "base64": "#/components/schemas/AnthropicBase64PDFSource", "text": "#/components/schemas/AnthropicPlainTextSource" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicBase64PDFSource" }, { "$ref": "#/components/schemas/AnthropicPlainTextSource" } ], "title": "Source" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The title of the document", "title": "Title" }, "type": { "const": "document", "default": "document", "title": "Type", "type": "string" } }, "required": [ "citations", "source", "title", "type" ], "title": "ResponseDocumentBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseEncryptedCodeExecutionResultBlock": { "description": "Code execution result with encrypted stdout for PFC + web_search results.", "properties": { "content": { "items": { "$ref": "#/components/schemas/AnthropicResponseCodeExecutionOutputBlock" }, "title": "Content", "type": "array" }, "encrypted_stdout": { "title": "Encrypted Stdout", "type": "string" }, "return_code": { "title": "Return Code", "type": "integer" }, "stderr": { "title": "Stderr", "type": "string" }, "type": { "const": "encrypted_code_execution_result", "default": "encrypted_code_execution_result", "title": "Type", "type": "string" } }, "required": [ "content", "encrypted_stdout", "return_code", "stderr", "type" ], "title": "ResponseEncryptedCodeExecutionResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponsePageLocationCitation": { "properties": { "cited_text": { "examples": [ "The grass is green. The sky is blue." ], "title": "Cited Text", "type": "string" }, "document_index": { "minimum": 0, "title": "Document Index", "type": "integer" }, "document_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "examples": [ "My Document" ], "title": "Document Title" }, "end_page_number": { "title": "End Page Number", "type": "integer" }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "examples": [ "file_011CNha8iCJcU1wXNR6q4V8w" ], "title": "File Id" }, "start_page_number": { "minimum": 1, "title": "Start Page Number", "type": "integer" }, "type": { "const": "page_location", "default": "page_location", "title": "Type", "type": "string" } }, "required": [ "cited_text", "document_index", "document_title", "end_page_number", "file_id", "start_page_number", "type" ], "title": "ResponsePageLocationCitation", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseRedactedThinkingBlock": { "properties": { "data": { "description": "The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content.\n\nPass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.\n\nSee [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.", "title": "Data", "type": "string" }, "type": { "const": "redacted_thinking", "default": "redacted_thinking", "title": "Type", "type": "string" } }, "required": [ "data", "type" ], "title": "ResponseRedactedThinkingBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseSearchResultLocationCitation": { "properties": { "cited_text": { "description": "The full text of the cited block range, concatenated.\n\nAlways equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.", "examples": [ "The grass is green. The sky is blue." ], "title": "Cited Text", "type": "string" }, "end_block_index": { "description": "Exclusive 0-based end index of the cited block range in the source's `content` array.\n\nAlways greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.", "title": "End Block Index", "type": "integer" }, "search_result_index": { "description": "0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results.\n\nCounted separately from `document_index`; server-side web search results are not included in this count.", "minimum": 0, "title": "Search Result Index", "type": "integer" }, "source": { "title": "Source", "type": "string" }, "start_block_index": { "description": "0-based index of the first cited block in the source's `content` array.", "minimum": 0, "title": "Start Block Index", "type": "integer" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "type": { "const": "search_result_location", "default": "search_result_location", "title": "Type", "type": "string" } }, "required": [ "cited_text", "end_block_index", "search_result_index", "source", "start_block_index", "title", "type" ], "title": "ResponseSearchResultLocationCitation", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseServerToolUseBlock": { "properties": { "caller": { "default": { "type": "direct" }, "discriminator": { "mapping": { "code_execution_20250825": "#/components/schemas/AnthropicServerToolCaller", "code_execution_20260120": "#/components/schemas/AnthropicServerToolCaller_20260120", "direct": "#/components/schemas/AnthropicDirectCaller" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicDirectCaller" }, { "$ref": "#/components/schemas/AnthropicServerToolCaller" }, { "$ref": "#/components/schemas/AnthropicServerToolCaller_20260120" } ], "title": "Caller" }, "id": { "pattern": "^srvtoolu_[a-zA-Z0-9_]+$", "title": "Id", "type": "string" }, "input": { "additionalProperties": true, "title": "Input", "type": "object" }, "name": { "enum": [ "web_search", "web_fetch", "code_execution", "bash_code_execution", "text_editor_code_execution", "tool_search_tool_regex", "tool_search_tool_bm25" ], "title": "Name", "type": "string" }, "type": { "const": "server_tool_use", "default": "server_tool_use", "title": "Type", "type": "string" } }, "required": [ "id", "input", "name", "type" ], "title": "ResponseServerToolUseBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseTextBlock": { "properties": { "citations": { "anyOf": [ { "items": { "discriminator": { "mapping": { "char_location": "#/components/schemas/AnthropicResponseCharLocationCitation", "content_block_location": "#/components/schemas/AnthropicResponseContentBlockLocationCitation", "page_location": "#/components/schemas/AnthropicResponsePageLocationCitation", "search_result_location": "#/components/schemas/AnthropicResponseSearchResultLocationCitation", "web_search_result_location": "#/components/schemas/AnthropicResponseWebSearchResultLocationCitation" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicResponseCharLocationCitation" }, { "$ref": "#/components/schemas/AnthropicResponsePageLocationCitation" }, { "$ref": "#/components/schemas/AnthropicResponseContentBlockLocationCitation" }, { "$ref": "#/components/schemas/AnthropicResponseWebSearchResultLocationCitation" }, { "$ref": "#/components/schemas/AnthropicResponseSearchResultLocationCitation" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Citations supporting the text block.\n\nThe type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`.", "title": "Citations" }, "text": { "maxLength": 5000000, "minLength": 0, "title": "Text", "type": "string" }, "type": { "const": "text", "default": "text", "title": "Type", "type": "string" } }, "required": [ "text", "type" ], "title": "ResponseTextBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseTextEditorCodeExecutionCreateResultBlock": { "properties": { "is_file_update": { "title": "Is File Update", "type": "boolean" }, "type": { "const": "text_editor_code_execution_create_result", "default": "text_editor_code_execution_create_result", "title": "Type", "type": "string" } }, "required": [ "is_file_update", "type" ], "title": "ResponseTextEditorCodeExecutionCreateResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseTextEditorCodeExecutionStrReplaceResultBlock": { "properties": { "lines": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Lines" }, "new_lines": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "New Lines" }, "new_start": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "New Start" }, "old_lines": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Old Lines" }, "old_start": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Old Start" }, "type": { "const": "text_editor_code_execution_str_replace_result", "default": "text_editor_code_execution_str_replace_result", "title": "Type", "type": "string" } }, "required": [ "lines", "new_lines", "new_start", "old_lines", "old_start", "type" ], "title": "ResponseTextEditorCodeExecutionStrReplaceResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseTextEditorCodeExecutionToolResultBlock": { "properties": { "content": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicResponseTextEditorCodeExecutionToolResultError" }, { "$ref": "#/components/schemas/AnthropicResponseTextEditorCodeExecutionViewResultBlock" }, { "$ref": "#/components/schemas/AnthropicResponseTextEditorCodeExecutionCreateResultBlock" }, { "$ref": "#/components/schemas/AnthropicResponseTextEditorCodeExecutionStrReplaceResultBlock" } ], "title": "Content" }, "tool_use_id": { "pattern": "^srvtoolu_[a-zA-Z0-9_]+$", "title": "Tool Use Id", "type": "string" }, "type": { "const": "text_editor_code_execution_tool_result", "default": "text_editor_code_execution_tool_result", "title": "Type", "type": "string" } }, "required": [ "content", "tool_use_id", "type" ], "title": "ResponseTextEditorCodeExecutionToolResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseTextEditorCodeExecutionToolResultError": { "properties": { "error_code": { "$ref": "#/components/schemas/AnthropicTextEditorCodeExecutionToolResultErrorCode" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error Message" }, "type": { "const": "text_editor_code_execution_tool_result_error", "default": "text_editor_code_execution_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "error_message", "type" ], "title": "ResponseTextEditorCodeExecutionToolResultError", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseTextEditorCodeExecutionViewResultBlock": { "properties": { "content": { "title": "Content", "type": "string" }, "file_type": { "enum": [ "text", "image", "pdf" ], "title": "File Type", "type": "string" }, "num_lines": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Num Lines" }, "start_line": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Start Line" }, "total_lines": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Total Lines" }, "type": { "const": "text_editor_code_execution_view_result", "default": "text_editor_code_execution_view_result", "title": "Type", "type": "string" } }, "required": [ "content", "file_type", "num_lines", "start_line", "total_lines", "type" ], "title": "ResponseTextEditorCodeExecutionViewResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseThinkingBlock": { "properties": { "signature": { "description": "A value used to verify that this thinking block was generated by Claude when it is passed back to the API.\n\nThis is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact.\n\nSee [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.", "title": "Signature", "type": "string" }, "thinking": { "description": "The text of Claude's thinking process for this block.", "title": "Thinking", "type": "string" }, "type": { "const": "thinking", "default": "thinking", "title": "Type", "type": "string" } }, "required": [ "signature", "thinking", "type" ], "title": "ResponseThinkingBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseToolReferenceBlock": { "properties": { "tool_name": { "maxLength": 256, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]{1,256}$", "title": "Tool Name", "type": "string" }, "type": { "const": "tool_reference", "default": "tool_reference", "title": "Type", "type": "string" } }, "required": [ "tool_name", "type" ], "title": "ResponseToolReferenceBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseToolSearchToolResultBlock": { "properties": { "content": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicResponseToolSearchToolResultError" }, { "$ref": "#/components/schemas/AnthropicResponseToolSearchToolSearchResultBlock" } ], "title": "Content" }, "tool_use_id": { "pattern": "^srvtoolu_[a-zA-Z0-9_]+$", "title": "Tool Use Id", "type": "string" }, "type": { "const": "tool_search_tool_result", "default": "tool_search_tool_result", "title": "Type", "type": "string" } }, "required": [ "content", "tool_use_id", "type" ], "title": "ResponseToolSearchToolResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseToolSearchToolResultError": { "properties": { "error_code": { "$ref": "#/components/schemas/AnthropicToolSearchToolResultErrorCode" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error Message" }, "type": { "const": "tool_search_tool_result_error", "default": "tool_search_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "error_message", "type" ], "title": "ResponseToolSearchToolResultError", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseToolSearchToolSearchResultBlock": { "properties": { "tool_references": { "items": { "$ref": "#/components/schemas/AnthropicResponseToolReferenceBlock" }, "title": "Tool References", "type": "array" }, "type": { "const": "tool_search_tool_search_result", "default": "tool_search_tool_search_result", "title": "Type", "type": "string" } }, "required": [ "tool_references", "type" ], "title": "ResponseToolSearchToolSearchResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseToolUseBlock": { "properties": { "caller": { "default": { "type": "direct" }, "discriminator": { "mapping": { "code_execution_20250825": "#/components/schemas/AnthropicServerToolCaller", "code_execution_20260120": "#/components/schemas/AnthropicServerToolCaller_20260120", "direct": "#/components/schemas/AnthropicDirectCaller" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicDirectCaller" }, { "$ref": "#/components/schemas/AnthropicServerToolCaller" }, { "$ref": "#/components/schemas/AnthropicServerToolCaller_20260120" } ], "title": "Caller" }, "id": { "pattern": "^[a-zA-Z0-9_-]+$", "title": "Id", "type": "string" }, "input": { "additionalProperties": true, "title": "Input", "type": "object" }, "name": { "minLength": 1, "title": "Name", "type": "string" }, "toolset_name": { "anyOf": [ { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "type": "string" }, { "type": "null" } ], "default": null, "description": "For a toolset member tool_use, the toolset family.", "title": "Toolset Name" }, "type": { "const": "tool_use", "default": "tool_use", "title": "Type", "type": "string" } }, "required": [ "id", "input", "name", "type" ], "title": "ResponseToolUseBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseWebFetchResultBlock": { "properties": { "content": { "$ref": "#/components/schemas/AnthropicResponseDocumentBlock" }, "retrieved_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ISO 8601 timestamp when the content was retrieved", "title": "Retrieved At" }, "type": { "const": "web_fetch_result", "default": "web_fetch_result", "title": "Type", "type": "string" }, "url": { "description": "Fetched content URL", "title": "Url", "type": "string" } }, "required": [ "content", "retrieved_at", "type", "url" ], "title": "ResponseWebFetchResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseWebFetchToolResultBlock": { "properties": { "caller": { "default": { "type": "direct" }, "discriminator": { "mapping": { "code_execution_20250825": "#/components/schemas/AnthropicServerToolCaller", "code_execution_20260120": "#/components/schemas/AnthropicServerToolCaller_20260120", "direct": "#/components/schemas/AnthropicDirectCaller" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicDirectCaller" }, { "$ref": "#/components/schemas/AnthropicServerToolCaller" }, { "$ref": "#/components/schemas/AnthropicServerToolCaller_20260120" } ], "title": "Caller" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicResponseWebFetchToolResultError" }, { "$ref": "#/components/schemas/AnthropicResponseWebFetchResultBlock" } ], "title": "Content" }, "tool_use_id": { "pattern": "^srvtoolu_[a-zA-Z0-9_]+$", "title": "Tool Use Id", "type": "string" }, "type": { "const": "web_fetch_tool_result", "default": "web_fetch_tool_result", "title": "Type", "type": "string" } }, "required": [ "caller", "content", "tool_use_id", "type" ], "title": "ResponseWebFetchToolResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseWebFetchToolResultError": { "properties": { "error_code": { "$ref": "#/components/schemas/AnthropicWebFetchToolResultErrorCode" }, "type": { "const": "web_fetch_tool_result_error", "default": "web_fetch_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "type" ], "title": "ResponseWebFetchToolResultError", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseWebSearchResultBlock": { "properties": { "encrypted_content": { "title": "Encrypted Content", "type": "string" }, "page_age": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Page Age" }, "title": { "title": "Title", "type": "string" }, "type": { "const": "web_search_result", "default": "web_search_result", "title": "Type", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "encrypted_content", "page_age", "title", "type", "url" ], "title": "ResponseWebSearchResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseWebSearchResultLocationCitation": { "properties": { "cited_text": { "examples": [ "The grass is green. The sky is blue." ], "title": "Cited Text", "type": "string" }, "encrypted_index": { "title": "Encrypted Index", "type": "string" }, "title": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ], "title": "Title" }, "type": { "const": "web_search_result_location", "default": "web_search_result_location", "title": "Type", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "cited_text", "encrypted_index", "title", "type", "url" ], "title": "ResponseWebSearchResultLocationCitation", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseWebSearchToolResultBlock": { "properties": { "caller": { "default": { "type": "direct" }, "discriminator": { "mapping": { "code_execution_20250825": "#/components/schemas/AnthropicServerToolCaller", "code_execution_20260120": "#/components/schemas/AnthropicServerToolCaller_20260120", "direct": "#/components/schemas/AnthropicDirectCaller" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicDirectCaller" }, { "$ref": "#/components/schemas/AnthropicServerToolCaller" }, { "$ref": "#/components/schemas/AnthropicServerToolCaller_20260120" } ], "title": "Caller" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicResponseWebSearchToolResultError" }, { "items": { "$ref": "#/components/schemas/AnthropicResponseWebSearchResultBlock" }, "type": "array" } ], "title": "Content" }, "tool_use_id": { "pattern": "^srvtoolu_[a-zA-Z0-9_]+$", "title": "Tool Use Id", "type": "string" }, "type": { "const": "web_search_tool_result", "default": "web_search_tool_result", "title": "Type", "type": "string" } }, "required": [ "caller", "content", "tool_use_id", "type" ], "title": "ResponseWebSearchToolResultBlock", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicResponseWebSearchToolResultError": { "properties": { "error_code": { "$ref": "#/components/schemas/AnthropicWebSearchToolResultErrorCode" }, "type": { "const": "web_search_tool_result_error", "default": "web_search_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "type" ], "title": "ResponseWebSearchToolResultError", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicServerToolCaller": { "additionalProperties": false, "description": "Tool invocation generated by a server-side tool.", "properties": { "tool_id": { "pattern": "^srvtoolu_[a-zA-Z0-9_]+$", "title": "Tool Id", "type": "string" }, "type": { "const": "code_execution_20250825", "title": "Type", "type": "string" } }, "required": [ "tool_id", "type" ], "title": "ServerToolCaller", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicServerToolCaller_20260120": { "additionalProperties": false, "properties": { "tool_id": { "pattern": "^srvtoolu_[a-zA-Z0-9_]+$", "title": "Tool Id", "type": "string" }, "type": { "const": "code_execution_20260120", "title": "Type", "type": "string" } }, "required": [ "tool_id", "type" ], "title": "ServerToolCaller_20260120", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicServerToolUsage": { "properties": { "web_fetch_requests": { "default": 0, "description": "The number of web fetch tool requests.", "examples": [ 2 ], "minimum": 0, "title": "Web Fetch Requests", "type": "integer" }, "web_search_requests": { "default": 0, "description": "The number of web search tool requests.", "examples": [ 0 ], "minimum": 0, "title": "Web Search Requests", "type": "integer" } }, "required": [ "web_fetch_requests", "web_search_requests" ], "title": "ServerToolUsage", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicSignatureContentBlockDelta": { "properties": { "signature": { "description": "The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event.", "title": "Signature", "type": "string" }, "type": { "const": "signature_delta", "default": "signature_delta", "title": "Type", "type": "string" } }, "required": [ "signature", "type" ], "title": "SignatureContentBlockDelta", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicSkillParams": { "additionalProperties": false, "description": "Specification for a skill to be loaded in a container (request model).", "properties": { "skill_id": { "description": "Skill ID", "examples": [ "pdf" ], "maxLength": 64, "minLength": 1, "title": "Skill Id", "type": "string" }, "type": { "description": "Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)", "enum": [ "anthropic", "custom" ], "examples": [ "anthropic" ], "title": "Type", "type": "string" }, "version": { "description": "Skill version or 'latest' for most recent version", "examples": [ "latest" ], "maxLength": 64, "minLength": 1, "title": "Version", "type": "string" } }, "required": [ "skill_id", "type" ], "title": "SkillParams", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicTextContentBlockDelta": { "properties": { "text": { "title": "Text", "type": "string" }, "type": { "const": "text_delta", "default": "text_delta", "title": "Type", "type": "string" } }, "required": [ "text", "type" ], "title": "TextContentBlockDelta", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicTextEditorCodeExecutionToolResultErrorCode": { "enum": [ "invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded", "file_not_found" ], "title": "TextEditorCodeExecutionToolResultErrorCode", "type": "string", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicTextEditor_20250124": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "input_examples": { "items": { "additionalProperties": { "$ref": "#/components/schemas/AnthropicJsonValue" }, "type": "object" }, "title": "Input Examples", "type": "array" }, "name": { "const": "str_replace_editor", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "const": "text_editor_20250124", "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "TextEditor_20250124", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicTextEditor_20250429": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "input_examples": { "items": { "additionalProperties": { "$ref": "#/components/schemas/AnthropicJsonValue" }, "type": "object" }, "title": "Input Examples", "type": "array" }, "name": { "const": "str_replace_based_edit_tool", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "const": "text_editor_20250429", "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "TextEditor_20250429", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicTextEditor_20250728": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "input_examples": { "items": { "additionalProperties": { "$ref": "#/components/schemas/AnthropicJsonValue" }, "type": "object" }, "title": "Input Examples", "type": "array" }, "max_characters": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "description": "Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.", "title": "Max Characters" }, "name": { "const": "str_replace_based_edit_tool", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "const": "text_editor_20250728", "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "TextEditor_20250728", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicThinkingConfigAdaptive": { "additionalProperties": false, "properties": { "display": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicThinkingDisplayMode" }, { "type": "null" } ], "description": "Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`." }, "type": { "const": "adaptive", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "ThinkingConfigAdaptive", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicThinkingConfigDisabled": { "additionalProperties": false, "properties": { "type": { "const": "disabled", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "ThinkingConfigDisabled", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicThinkingConfigEnabled": { "additionalProperties": false, "properties": { "budget_tokens": { "description": "Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.\n\nMust be ≥1024 and less than `max_tokens`.\n\nSee [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.", "minimum": 1024, "title": "Budget Tokens", "type": "integer" }, "display": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicThinkingDisplayMode" }, { "type": "null" } ], "description": "Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`." }, "type": { "const": "enabled", "title": "Type", "type": "string" } }, "required": [ "budget_tokens", "type" ], "title": "ThinkingConfigEnabled", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicThinkingContentBlockDelta": { "properties": { "thinking": { "description": "The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value.", "title": "Thinking", "type": "string" }, "type": { "const": "thinking_delta", "default": "thinking_delta", "title": "Type", "type": "string" } }, "required": [ "thinking", "type" ], "title": "ThinkingContentBlockDelta", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicThinkingDisplayMode": { "enum": [ "summarized", "omitted" ], "title": "ThinkingDisplayMode", "type": "string", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicTool": { "additionalProperties": false, "properties": { "type": { "anyOf": [ { "type": "null" }, { "const": "custom", "type": "string" } ], "title": "Type" }, "description": { "description": "Description of what this tool does.\n\nTool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.", "examples": [ "Get the current weather in a given location" ], "title": "Description", "type": "string" }, "name": { "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]{1,128}$", "title": "Name", "type": "string" }, "input_schema": { "$ref": "#/components/schemas/AnthropicInputSchema", "description": "[JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.\n\nThis defines the shape of the `input` that your tool accepts and that the model will produce.", "examples": [ { "properties": { "location": { "description": "The city and state, e.g. San Francisco, CA", "type": "string" }, "unit": { "description": "Unit for the output - one of (celsius, fahrenheit)", "type": "string" } }, "required": [ "location" ], "type": "object" } ] }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "eager_input_streaming": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers.", "title": "Eager Input Streaming" }, "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "input_examples": { "items": { "additionalProperties": { "$ref": "#/components/schemas/AnthropicJsonValue" }, "type": "object" }, "title": "Input Examples", "type": "array" } }, "required": [ "name", "input_schema" ], "title": "Tool", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicToolChoiceAny": { "additionalProperties": false, "description": "The model will use any available tools.", "properties": { "disable_parallel_tool_use": { "description": "Whether to disable parallel tool use.\n\nDefaults to `false`. If set to `true`, the model will output exactly one tool use.", "title": "Disable Parallel Tool Use", "type": "boolean" }, "type": { "const": "any", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "ToolChoiceAny", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicToolChoiceAuto": { "additionalProperties": false, "description": "The model will automatically decide whether to use tools.", "properties": { "disable_parallel_tool_use": { "description": "Whether to disable parallel tool use.\n\nDefaults to `false`. If set to `true`, the model will output at most one tool use.", "title": "Disable Parallel Tool Use", "type": "boolean" }, "type": { "const": "auto", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "ToolChoiceAuto", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicToolChoiceNone": { "additionalProperties": false, "description": "The model will not be allowed to use tools.", "properties": { "type": { "const": "none", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "ToolChoiceNone", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicToolChoiceTool": { "additionalProperties": false, "description": "The model will use the specified tool with `tool_choice.name`.", "properties": { "disable_parallel_tool_use": { "description": "Whether to disable parallel tool use.\n\nDefaults to `false`. If set to `true`, the model will output exactly one tool use.", "title": "Disable Parallel Tool Use", "type": "boolean" }, "name": { "description": "The name of the tool to use.", "title": "Name", "type": "string" }, "type": { "const": "tool", "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "ToolChoiceTool", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicToolSearchToolBM25_20251119": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "name": { "const": "tool_search_tool_bm25", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "enum": [ "tool_search_tool_bm25_20251119", "tool_search_tool_bm25" ], "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "ToolSearchToolBM25_20251119", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicToolSearchToolRegex_20251119": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "name": { "const": "tool_search_tool_regex", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "enum": [ "tool_search_tool_regex_20251119", "tool_search_tool_regex" ], "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "ToolSearchToolRegex_20251119", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicToolSearchToolResultErrorCode": { "enum": [ "invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded" ], "title": "ToolSearchToolResultErrorCode", "type": "string", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicURLImageSource": { "additionalProperties": false, "properties": { "type": { "const": "url", "title": "Type", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "type", "url" ], "title": "URLImageSource", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicURLPDFSource": { "additionalProperties": false, "properties": { "type": { "const": "url", "title": "Type", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "type", "url" ], "title": "URLPDFSource", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicUsage": { "properties": { "cache_creation": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicCacheCreation" }, { "type": "null" } ], "default": null, "description": "Breakdown of cached tokens by TTL" }, "cache_creation_input_tokens": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "The number of input tokens used to create the cache entry.", "examples": [ 2051 ], "title": "Cache Creation Input Tokens" }, "cache_read_input_tokens": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "The number of input tokens read from the cache.", "examples": [ 2051 ], "title": "Cache Read Input Tokens" }, "inference_geo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The geographic region where inference was performed for this request.", "examples": [ "global" ], "title": "Inference Geo" }, "input_tokens": { "description": "The number of input tokens which were used.", "examples": [ 2095 ], "minimum": 0, "title": "Input Tokens", "type": "integer" }, "output_tokens": { "description": "The number of output tokens which were used.", "examples": [ 503 ], "minimum": 0, "title": "Output Tokens", "type": "integer" }, "output_tokens_details": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicOutputTokensDetails" }, { "type": "null" } ], "default": null, "description": "Breakdown of output tokens by category.\n\n`output_tokens` remains the inclusive, authoritative total used for billing.\nThis object provides a read-only decomposition for observability — for example,\nhow many of the billed output tokens were spent on internal reasoning that may\nhave been summarized before being returned to you." }, "server_tool_use": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicServerToolUsage" }, { "type": "null" } ], "default": null, "description": "The number of server tool requests." }, "service_tier": { "anyOf": [ { "enum": [ "standard", "priority", "batch" ], "type": "string" }, { "type": "null" } ], "default": null, "description": "If the request used the priority, standard, or batch tier.", "title": "Service Tier" } }, "required": [ "cache_creation", "cache_creation_input_tokens", "cache_read_input_tokens", "input_tokens", "output_tokens", "output_tokens_details", "service_tier" ], "title": "Usage", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicUserLocation": { "additionalProperties": false, "properties": { "city": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The city of the user.", "examples": [ "New York", "Tokyo", "Los Angeles" ], "title": "City" }, "country": { "anyOf": [ { "maxLength": 2, "minLength": 2, "type": "string" }, { "type": "null" } ], "description": "The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.", "examples": [ "US", "JP", "GB" ], "title": "Country" }, "region": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The region of the user.", "examples": [ "California", "Ontario", "Wales" ], "title": "Region" }, "timezone": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The [IANA timezone](https://nodatime.org/TimeZones) of the user.", "examples": [ "America/New_York", "Asia/Tokyo", "Europe/London" ], "title": "Timezone" }, "type": { "const": "approximate", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "UserLocation", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicWebFetchToolResultErrorCode": { "enum": [ "invalid_tool_input", "url_too_long", "url_not_allowed", "url_not_in_prior_context", "url_not_accessible", "unsupported_content_type", "too_many_requests", "max_uses_exceeded", "unavailable" ], "title": "WebFetchToolResultErrorCode", "type": "string", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicWebFetchTool_20250910": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "List of domains to allow fetching from", "title": "Allowed Domains" }, "blocked_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "List of domains to block fetching from", "title": "Blocked Domains" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "citations": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicRequestCitationsConfig" }, { "type": "null" } ], "description": "Citations configuration for fetched documents. Citations are disabled by default." }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "max_content_tokens": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "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.", "title": "Max Content Tokens" }, "max_uses": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "description": "Maximum number of times the tool can be used in the API request.", "title": "Max Uses" }, "name": { "const": "web_fetch", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "const": "web_fetch_20250910", "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "WebFetchTool_20250910", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicWebFetchTool_20260209": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "List of domains to allow fetching from", "title": "Allowed Domains" }, "blocked_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "List of domains to block fetching from", "title": "Blocked Domains" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "citations": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicRequestCitationsConfig" }, { "type": "null" } ], "description": "Citations configuration for fetched documents. Citations are disabled by default." }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "max_content_tokens": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "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.", "title": "Max Content Tokens" }, "max_uses": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "description": "Maximum number of times the tool can be used in the API request.", "title": "Max Uses" }, "name": { "const": "web_fetch", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "const": "web_fetch_20260209", "title": "Type", "type": "string" } }, "required": [ "name", "type" ], "title": "WebFetchTool_20260209", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicWebFetchTool_20260309": { "additionalProperties": false, "description": "Web fetch tool with use_cache parameter for bypassing cached content.", "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "List of domains to allow fetching from", "title": "Allowed Domains" }, "blocked_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "List of domains to block fetching from", "title": "Blocked Domains" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "citations": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicRequestCitationsConfig" }, { "type": "null" } ], "description": "Citations configuration for fetched documents. Citations are disabled by default." }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "max_content_tokens": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "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.", "title": "Max Content Tokens" }, "max_uses": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "description": "Maximum number of times the tool can be used in the API request.", "title": "Max Uses" }, "name": { "const": "web_fetch", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "const": "web_fetch_20260309", "title": "Type", "type": "string" }, "use_cache": { "description": "Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.", "title": "Use Cache", "type": "boolean" } }, "required": [ "name", "type" ], "title": "WebFetchTool_20260309", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicWebFetchTool_20260318": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "List of domains to allow fetching from", "title": "Allowed Domains" }, "blocked_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "List of domains to block fetching from", "title": "Blocked Domains" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "citations": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicRequestCitationsConfig" }, { "type": "null" } ], "description": "Citations configuration for fetched documents. Citations are disabled by default." }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "max_content_tokens": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "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.", "title": "Max Content Tokens" }, "max_uses": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "description": "Maximum number of times the tool can be used in the API request.", "title": "Max Uses" }, "name": { "const": "web_fetch", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "response_inclusion": { "description": "How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn.", "enum": [ "full", "excluded" ], "title": "Response Inclusion", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "const": "web_fetch_20260318", "title": "Type", "type": "string" }, "use_cache": { "description": "Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.", "title": "Use Cache", "type": "boolean" } }, "required": [ "name", "type" ], "title": "WebFetchTool_20260318", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicWebSearchToolResultErrorCode": { "enum": [ "invalid_tool_input", "unavailable", "max_uses_exceeded", "too_many_requests", "query_too_long", "request_too_large" ], "title": "WebSearchToolResultErrorCode", "type": "string", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicWebSearchTool_20250305": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.", "title": "Allowed Domains" }, "blocked_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.", "title": "Blocked Domains" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "max_uses": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "description": "Maximum number of times the tool can be used in the API request.", "title": "Max Uses" }, "name": { "const": "web_search", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "const": "web_search_20250305", "title": "Type", "type": "string" }, "user_location": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicUserLocation" }, { "type": "null" } ], "description": "Parameters for the user's location. Used to provide more relevant search results." } }, "required": [ "name", "type" ], "title": "WebSearchTool_20250305", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicWebSearchTool_20260209": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.", "title": "Allowed Domains" }, "blocked_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.", "title": "Blocked Domains" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "max_uses": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "description": "Maximum number of times the tool can be used in the API request.", "title": "Max Uses" }, "name": { "const": "web_search", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "const": "web_search_20260209", "title": "Type", "type": "string" }, "user_location": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicUserLocation" }, { "type": "null" } ], "description": "Parameters for the user's location. Used to provide more relevant search results." } }, "required": [ "name", "type" ], "title": "WebSearchTool_20260209", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicWebSearchTool_20260318": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AnthropicAllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.", "title": "Allowed Domains" }, "blocked_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.", "title": "Blocked Domains" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "defer_loading": { "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.", "title": "Defer Loading", "type": "boolean" }, "max_uses": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "description": "Maximum number of times the tool can be used in the API request.", "title": "Max Uses" }, "name": { "const": "web_search", "description": "Name of the tool.\n\nThis is how the tool will be called by the model and in `tool_use` blocks.", "title": "Name", "type": "string" }, "response_inclusion": { "description": "How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn.", "enum": [ "full", "excluded" ], "title": "Response Inclusion", "type": "string" }, "strict": { "description": "When true, guarantees schema validation on tool names and inputs", "title": "Strict", "type": "boolean" }, "type": { "const": "web_search_20260318", "title": "Type", "type": "string" }, "user_location": { "anyOf": [ { "$ref": "#/components/schemas/AnthropicUserLocation" }, { "type": "null" } ], "description": "Parameters for the user's location. Used to provide more relevant search results." } }, "required": [ "name", "type" ], "title": "WebSearchTool_20260318", "type": "object", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicThinkingConfigParam": { "description": "Configuration for enabling Claude's extended thinking.\n\nWhen enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit.\n\nSee [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.", "discriminator": { "mapping": { "adaptive": "#/components/schemas/AnthropicThinkingConfigAdaptive", "disabled": "#/components/schemas/AnthropicThinkingConfigDisabled", "enabled": "#/components/schemas/AnthropicThinkingConfigEnabled" }, "propertyName": "type" }, "examples": [ { "type": "adaptive" } ], "oneOf": [ { "$ref": "#/components/schemas/AnthropicThinkingConfigEnabled" }, { "$ref": "#/components/schemas/AnthropicThinkingConfigDisabled" }, { "$ref": "#/components/schemas/AnthropicThinkingConfigAdaptive" } ], "title": "Thinking", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicToolChoice": { "description": "How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.", "discriminator": { "mapping": { "any": "#/components/schemas/AnthropicToolChoiceAny", "auto": "#/components/schemas/AnthropicToolChoiceAuto", "none": "#/components/schemas/AnthropicToolChoiceNone", "tool": "#/components/schemas/AnthropicToolChoiceTool" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicToolChoiceAuto" }, { "$ref": "#/components/schemas/AnthropicToolChoiceAny" }, { "$ref": "#/components/schemas/AnthropicToolChoiceTool" }, { "$ref": "#/components/schemas/AnthropicToolChoiceNone" } ], "title": "Tool Choice", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicContentBlock": { "discriminator": { "mapping": { "bash_code_execution_tool_result": "#/components/schemas/AnthropicResponseBashCodeExecutionToolResultBlock", "code_execution_tool_result": "#/components/schemas/AnthropicResponseCodeExecutionToolResultBlock", "container_upload": "#/components/schemas/AnthropicResponseContainerUploadBlock", "redacted_thinking": "#/components/schemas/AnthropicResponseRedactedThinkingBlock", "server_tool_use": "#/components/schemas/AnthropicResponseServerToolUseBlock", "text": "#/components/schemas/AnthropicResponseTextBlock", "text_editor_code_execution_tool_result": "#/components/schemas/AnthropicResponseTextEditorCodeExecutionToolResultBlock", "thinking": "#/components/schemas/AnthropicResponseThinkingBlock", "tool_search_tool_result": "#/components/schemas/AnthropicResponseToolSearchToolResultBlock", "tool_use": "#/components/schemas/AnthropicResponseToolUseBlock", "web_fetch_tool_result": "#/components/schemas/AnthropicResponseWebFetchToolResultBlock", "web_search_tool_result": "#/components/schemas/AnthropicResponseWebSearchToolResultBlock" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicResponseTextBlock" }, { "$ref": "#/components/schemas/AnthropicResponseThinkingBlock" }, { "$ref": "#/components/schemas/AnthropicResponseRedactedThinkingBlock" }, { "$ref": "#/components/schemas/AnthropicResponseToolUseBlock" }, { "$ref": "#/components/schemas/AnthropicResponseServerToolUseBlock" }, { "$ref": "#/components/schemas/AnthropicResponseWebSearchToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicResponseWebFetchToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicResponseCodeExecutionToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicResponseBashCodeExecutionToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicResponseTextEditorCodeExecutionToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicResponseToolSearchToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicResponseContainerUploadBlock" } ], "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicInputContentBlock": { "discriminator": { "mapping": { "bash_code_execution_tool_result": "#/components/schemas/AnthropicRequestBashCodeExecutionToolResultBlock", "code_execution_tool_result": "#/components/schemas/AnthropicRequestCodeExecutionToolResultBlock", "container_upload": "#/components/schemas/AnthropicRequestContainerUploadBlock", "document": "#/components/schemas/AnthropicRequestDocumentBlock", "image": "#/components/schemas/AnthropicRequestImageBlock", "redacted_thinking": "#/components/schemas/AnthropicRequestRedactedThinkingBlock", "search_result": "#/components/schemas/AnthropicRequestSearchResultBlock", "server_tool_use": "#/components/schemas/AnthropicRequestServerToolUseBlock", "text": "#/components/schemas/AnthropicRequestTextBlock", "text_editor_code_execution_tool_result": "#/components/schemas/AnthropicRequestTextEditorCodeExecutionToolResultBlock", "thinking": "#/components/schemas/AnthropicRequestThinkingBlock", "tool_result": "#/components/schemas/AnthropicRequestToolResultBlock", "tool_search_tool_result": "#/components/schemas/AnthropicRequestToolSearchToolResultBlock", "tool_use": "#/components/schemas/AnthropicRequestToolUseBlock", "web_fetch_tool_result": "#/components/schemas/AnthropicRequestWebFetchToolResultBlock", "web_search_tool_result": "#/components/schemas/AnthropicRequestWebSearchToolResultBlock", "mid_conv_system": "#/components/schemas/AnthropicRequestMidConvSystemBlock" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicRequestTextBlock", "description": "Regular text content." }, { "$ref": "#/components/schemas/AnthropicRequestImageBlock", "description": "Image content specified directly as base64 data or as a reference via a URL." }, { "$ref": "#/components/schemas/AnthropicRequestDocumentBlock", "description": "Document content, either specified directly as base64 data, as text, or as a reference via a URL." }, { "$ref": "#/components/schemas/AnthropicRequestSearchResultBlock", "description": "A search result block containing source, title, and content from search operations." }, { "$ref": "#/components/schemas/AnthropicRequestThinkingBlock", "description": "A block specifying internal thinking by the model." }, { "$ref": "#/components/schemas/AnthropicRequestRedactedThinkingBlock", "description": "A block specifying internal, redacted thinking by the model." }, { "$ref": "#/components/schemas/AnthropicRequestToolUseBlock", "description": "A block indicating a tool use by the model." }, { "$ref": "#/components/schemas/AnthropicRequestToolResultBlock", "description": "A block specifying the results of a tool use by the model." }, { "$ref": "#/components/schemas/AnthropicRequestServerToolUseBlock" }, { "$ref": "#/components/schemas/AnthropicRequestWebSearchToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicRequestWebFetchToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicRequestCodeExecutionToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicRequestBashCodeExecutionToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicRequestTextEditorCodeExecutionToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicRequestToolSearchToolResultBlock" }, { "$ref": "#/components/schemas/AnthropicRequestContainerUploadBlock" }, { "$ref": "#/components/schemas/AnthropicRequestMidConvSystemBlock" } ], "x-source": { "from": "avs://anthropic/official", "authority": "official" }, "properties": {} }, "AnthropicStopReason": { "enum": [ "end_turn", "max_tokens", "stop_sequence", "tool_use", "pause_turn", "refusal", "model_context_window_exceeded" ], "type": "string", "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicModel": { "title": "Model", "description": "The model that will complete your prompt.\n\nSee [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.", "anyOf": [ { "type": "string" }, { "const": "claude-sonnet-5", "description": "High-performance model for coding and agents" }, { "const": "claude-fable-5", "description": "Next generation of intelligence for the hardest knowledge work and coding problems" }, { "const": "claude-mythos-5", "description": "Most capable model for cybersecurity and biology research" }, { "const": "claude-opus-5", "description": "Powerful intelligence for long-running agents and coding" }, { "const": "claude-opus-4-8", "description": "Powerful intelligence for long-running agents and coding" }, { "const": "claude-opus-4-7", "description": "Powerful intelligence for long-running agents and coding" }, { "const": "claude-mythos-preview", "description": "New class of intelligence, strongest in coding and cybersecurity", "deprecated": true }, { "const": "claude-opus-4-6", "description": "Powerful intelligence for long-running agents and coding" }, { "const": "claude-sonnet-4-6", "description": "Best combination of speed and intelligence" }, { "const": "claude-haiku-4-5", "description": "Fastest model with near-frontier intelligence" }, { "const": "claude-haiku-4-5-20251001", "description": "Fastest model with near-frontier intelligence" }, { "const": "claude-opus-4-5", "description": "Powerful intelligence for long-running agents and coding" }, { "const": "claude-opus-4-5-20251101", "description": "Powerful intelligence for long-running agents and coding" }, { "const": "claude-sonnet-4-5", "description": "High-performance model for agents and coding" }, { "const": "claude-sonnet-4-5-20250929", "description": "High-performance model for agents and coding" } ], "x-source": { "from": "avs://anthropic/official", "authority": "official" } }, "AnthropicRequestMidConvSystemBlock": { "type": "object", "title": "RequestMidConvSystemBlock", "additionalProperties": false, "description": "System instructions that appear mid-conversation. The block must be the final content block in its turn.", "required": [ "content", "type" ], "properties": { "cache_control": { "anyOf": [ { "discriminator": { "propertyName": "type", "mapping": { "ephemeral": "#/components/schemas/AnthropicCacheControlEphemeral" } }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicCacheControlEphemeral" } ] }, { "type": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "content": { "type": "array", "title": "Content", "description": "System instruction text blocks.", "items": { "discriminator": { "propertyName": "type", "mapping": { "text": "#/components/schemas/AnthropicRequestTextBlock" } }, "oneOf": [ { "$ref": "#/components/schemas/AnthropicRequestTextBlock" } ] } }, "type": { "type": "string", "const": "mid_conv_system", "title": "Type" } }, "x-source": { "from": "gateway/anthropic-wire-parity.yml", "authority": "gateway" } }, "GatewayError": { "type": "object", "description": "OpenAI-compatible error envelope. Top-level `error` object carrying\n`message` / `type` / `param` / `code`. `request_id` lives in the\n`X-Request-Id` response header, not in the body. The legacy `upstream`\nfield is no longer emitted.\n", "x-source": { "from": "gateway", "authority": "gateway" }, "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string", "description": "Human-readable error message." }, "type": { "type": "string", "nullable": true, "description": "Error category. OpenAI-compatible values include\ninvalid_request_error / authentication_error / permission_error /\nnot_found_error / rate_limit_error, etc. The upstream value is\npassed through verbatim; the enum is not fixed.\n" }, "param": { "type": "string", "nullable": true, "description": "Name of the offending field, when applicable." }, "code": { "nullable": true, "description": "Sub-error code. May be a string or integer (the gateway treats\n`code` as an arbitrary type).\n" } } } } }, "GeminiGenerateContentRequest": { "type": "object", "description": "Native Gemini `generateContent` request body. Field definitions here\nare illustrative — refer to\nhttps://ai.google.dev/api/rest/v1beta/models/generateContent as the\nauthoritative reference.\n", "x-source": { "from": "gemini/official", "authority": "manual" }, "additionalProperties": true, "required": [ "contents" ], "properties": { "contents": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "generationConfig": { "type": "object", "additionalProperties": true, "description": "Generation parameters (sampling, output shaping, thinking).", "properties": { "temperature": { "type": [ "number", "null" ], "minimum": 0, "maximum": 2, "description": "Sampling temperature (0–2). Higher values are more random." }, "topP": { "type": [ "number", "null" ], "minimum": 0, "maximum": 1, "description": "Nucleus sampling cumulative probability threshold (0–1)." }, "topK": { "type": [ "integer", "null" ], "minimum": 1, "description": "Number of candidates kept for top-k sampling (≥1)." }, "maxOutputTokens": { "type": [ "integer", "null" ], "minimum": 1, "description": "Maximum number of tokens in a single response (≥1)." }, "candidateCount": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 8, "description": "Number of response candidates to return (1–8)." }, "presencePenalty": { "type": [ "number", "null" ], "minimum": -2, "maximum": 2, "description": "Presence penalty (-2–2)." }, "frequencyPenalty": { "type": [ "number", "null" ], "minimum": -2, "maximum": 2, "description": "Frequency penalty (-2–2)." }, "seed": { "type": [ "integer", "null" ], "description": "Random seed for reproducible sampling." }, "responseMimeType": { "anyOf": [ { "type": "string", "enum": [ "text/plain", "application/json", "text/x.enum" ] }, { "type": "null" } ], "description": "MIME type of the generated response." }, "stopSequences": { "type": [ "array", "null" ], "items": { "type": "string" }, "maxItems": 5, "description": "Stop sequences (up to 5)." }, "responseModalities": { "type": [ "array", "null" ], "items": { "type": "string", "enum": [ "TEXT", "IMAGE", "AUDIO" ] }, "description": "Requested output modalities." }, "responseLogprobs": { "type": [ "boolean", "null" ], "description": "Whether to return log probabilities in the response." }, "logprobs": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 20, "description": "Number of top logprobs per token (0–20). Only valid when responseLogprobs is true." }, "responseSchema": { "type": [ "object", "null" ], "additionalProperties": true, "description": "Output schema (OpenAPI 3.0 subset). Requires responseMimeType of application/json or text/x.enum; mutually exclusive with responseJsonSchema." }, "responseJsonSchema": { "type": [ "object", "null" ], "additionalProperties": true, "description": "Output schema (standard JSON Schema). Requires responseMimeType of application/json; mutually exclusive with responseSchema." }, "thinkingConfig": { "type": [ "object", "null" ], "additionalProperties": true, "description": "Thinking (reasoning) configuration for thinking-capable models.", "properties": { "includeThoughts": { "type": [ "boolean", "null" ], "description": "Whether to include thought summaries in the response." }, "thinkingBudget": { "type": [ "integer", "null" ], "minimum": -1, "maximum": 32768, "description": "Thinking token budget. -1 = dynamic, 0 = off (2.5 Pro cannot disable); model-specific ranges, e.g. 2.5 Pro 128–32768, 2.5 Flash 0–24576, 2.5 Flash-Lite 512–24576. For Gemini 3+ prefer thinkingLevel." }, "thinkingLevel": { "anyOf": [ { "type": "string", "enum": [ "MINIMAL", "LOW", "MEDIUM", "HIGH" ] }, { "type": "null" } ], "description": "Maximum depth of internal reasoning before responding. Recommended for Gemini 3 or later models; earlier models return an error." } } } } }, "safetySettings": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "systemInstruction": { "type": "object", "additionalProperties": true }, "tools": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "GeminiGenerateContentResponse": { "type": "object", "description": "Native Gemini response body. Refer to Google's official documentation\nfor the authoritative field reference.\n", "x-source": { "from": "gemini/official", "authority": "manual" }, "additionalProperties": true }, "ResponseModelResponseProperties": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "top_logprobs": { "anyOf": [ { "description": "An integer between 0 and 20 specifying the maximum number of most likely\ntokens to return at each token position, each with an associated log\nprobability. In some cases, the number of returned tokens may be fewer than\nrequested.\n", "type": "integer", "minimum": 0, "maximum": 20 }, { "type": "null" } ] }, "temperature": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 2, "default": 1, "example": 1, "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both.\n" }, { "type": "null" } ], "x-providers": { "gemini": { "to": [ "generationConfig", "temperature" ] }, "vertex": { "to": [ "generationConfig", "temperature" ] } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "top_p": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1, "default": 1, "example": 1, "description": "An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability\nmass. So 0.1 means only the tokens comprising the top 10% probability mass\nare considered.\n\nWe generally recommend altering this or `temperature` but not both.\n" }, { "type": "null" } ], "x-providers": { "gemini": { "to": [ "generationConfig", "topP" ] }, "vertex": { "to": [ "generationConfig", "topP" ] } }, "x-source": { "from": "avs://openai/official", "authority": "official" } }, "user": { "type": "string", "example": "user-1234", "deprecated": true, "description": "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.\nA stable identifier for your end-users.\nUsed to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n", "nullable": true }, "safety_identifier": { "anyOf": [ { "type": "string", "maxLength": 64, "example": "safety-identifier-1234", "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.\nThe IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).\n" }, { "type": "null" } ] }, "prompt_cache_key": { "anyOf": [ { "type": "string", "example": "prompt-cache-key-1234", "description": "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching).\n" }, { "type": "null" } ] }, "service_tier": { "$ref": "#/components/schemas/ServiceTier" }, "prompt_cache_retention": { "deprecated": true, "anyOf": [ { "type": "string", "enum": [ "in_memory", "24h" ], "description": "Deprecated. Use `prompt_cache_options.ttl` instead.\n\nThe retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](/docs/guides/prompt-caching#prompt-cache-retention).\nThis field expresses a maximum retention policy, while\n`prompt_cache_options.ttl` expresses a minimum cache lifetime. The two\nfields are independent and do not interact.\nFor `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.\n\nFor older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy:\n - Organizations without ZDR enabled default to `24h`.\n - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified.\n" }, { "type": "null" } ] } }, "x-source": { "from": "avs://openai/official", "authority": "derived" } } }, "securitySchemes": { "gatewayBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "API Key", "description": "Gateway-issued API key, formatted as `sk-gateway-xxxxxxxx`.\nUsed by OpenAI-shaped endpoints (/v1/chat/completions, etc.).\n", "x-source": { "from": "gateway", "authority": "gateway" } }, "gatewayAnthropicKey": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "Used by Anthropic-shaped endpoints (/v1/messages). The value is\nthe gateway API key, shared with OpenAI-shaped endpoints. Clients\nidentifying as anthropic-sdk-* will use this header.\n", "x-source": { "from": "gateway", "authority": "gateway" } }, "gatewayGeminiKey": { "type": "apiKey", "in": "header", "name": "x-goog-api-key", "description": "Used by Gemini-shaped endpoints (/v1beta/...). The value is the\ngateway API key, shared with other endpoint shapes. The google-genai\nSDK uses this header by default.\n", "x-source": { "from": "gateway", "authority": "gateway" } }, "gatewayGeminiQuery": { "type": "apiKey", "in": "query", "name": "key", "description": "Query-parameter fallback for Gemini-shaped endpoints. Some SDKs\nand tools only support the `?key=` form. Value is the same as\n`gatewayGeminiKey`.\n", "x-source": { "from": "gateway", "authority": "gateway" } } } }, "security": [ { "gatewayBearer": [] } ] }