# Anthropic Messages > Large Language Models Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation. The Messages API can be used for either single queries or stateless multi-turn conversations. Learn more about the Messages API in our [user guide](https://docs.claude.com/en/docs/initial-setup) ## Endpoint `POST https://api.modelverse.cn/v1/messages` ## Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | anthropic-version | header | string | No | The version of the Claude API you want to use. Read more about versioning and our version history [here](https://docs.claude.com/en/api/versioning). | ## Request Body ## Responses - **200** — Message object. - **4XX** — Error response. See our [errors documentation](https://docs.claude.com/en/api/errors) for more details. ## OpenAPI Definition ```json { "openapi": "3.1.0", "info": { "title": "Anthropic API", "version": "1.0.0" }, "servers": [ { "url": "https://api.modelverse.cn", "description": "中国大陆节点，国内用户推荐，访问延迟低。" }, { "url": "https://api-sg.umodelverse.ai", "description": "新加坡节点，东南亚用户推荐，访问更快。" }, { "url": "https://api-us-ca.umodelverse.ai", "description": "美国洛杉矶节点，海外用户推荐，数据不回国。" }, { "url": "https://api-ge-fra.umodelverse.ai", "description": "法兰克福节点，欧洲用户推荐，访问更快。" } ], "security": [ { "apiKeyAuth": [] } ], "paths": { "/v1/messages": { "post": { "summary": "Anthropic 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://docs.claude.com/en/docs/initial-setup)", "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://docs.claude.com/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://docs.claude.com/en/api/versioning)." } ], "responses": { "200": { "description": "Message object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } } }, "4XX": { "description": "Error response.\n\nSee our [errors documentation](https://docs.claude.com/en/api/errors) for more details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMessageParams" } } }, "required": true } } }, "/v1/messages/count_tokens": { "post": { "summary": "Anthropic Message Token Count", "description": "Count the number of tokens in a Message.\n\nThe Token Count API can be used to count the number of tokens in a Message, including tools, images, and documents, without creating it.\n\nLearn more about token counting in our [user guide](https://docs.claude.com/en/docs/build-with-claude/token-counting)", "operationId": "messages_count_tokens_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://docs.claude.com/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://docs.claude.com/en/api/versioning)." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountMessageTokensResponse" } } } }, "4XX": { "description": "Error response.\n\nSee our [errors documentation](https://docs.claude.com/en/api/errors) for more details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountMessageTokensParams" } } }, "required": true } } } }, "components": { "securitySchemes": { "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "Anthropic API key header." } }, "schemas": { "Message": { "examples": [ { "content": [ { "citations": null, "text": "Hi! My name is Claude.", "type": "text" } ], "id": "msg_013Zva2CMHLNnXjNJJKqJ2EF", "model": "model-name", "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/ContentBlock" }, "title": "Content", "type": "array" }, "model": { "$ref": "#/components/schemas/Model" }, "stop_reason": { "anyOf": [ { "$ref": "#/components/schemas/StopReason" }, { "type": "null", "title": "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\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", "title": "string" }, { "type": "null", "title": "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/RefusalStopDetails" }, { "type": "null", "title": "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/Usage", "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 } ] } }, "required": [ "id", "type", "role", "content", "model", "stop_reason", "stop_sequence", "stop_details", "usage" ], "title": "Message", "type": "object", "x-stainless-python-custom-imports": [ "from .content_block import ContentBlock as ContentBlock" ] }, "ErrorResponse": { "properties": { "error": { "discriminator": { "mapping": { "api_error": "#/components/schemas/APIError", "authentication_error": "#/components/schemas/AuthenticationError", "billing_error": "#/components/schemas/BillingError", "invalid_request_error": "#/components/schemas/InvalidRequestError", "not_found_error": "#/components/schemas/NotFoundError", "overloaded_error": "#/components/schemas/OverloadedError", "permission_error": "#/components/schemas/PermissionError", "rate_limit_error": "#/components/schemas/RateLimitError", "timeout_error": "#/components/schemas/GatewayTimeoutError" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/InvalidRequestError" }, { "$ref": "#/components/schemas/AuthenticationError" }, { "$ref": "#/components/schemas/BillingError" }, { "$ref": "#/components/schemas/PermissionError" }, { "$ref": "#/components/schemas/NotFoundError" }, { "$ref": "#/components/schemas/RateLimitError" }, { "$ref": "#/components/schemas/GatewayTimeoutError" }, { "$ref": "#/components/schemas/APIError" }, { "$ref": "#/components/schemas/OverloadedError" } ], "title": "Error" }, "request_id": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "null" } ], "default": null, "title": "Request Id" }, "type": { "const": "error", "default": "error", "title": "Type", "type": "string" } }, "required": [ "error", "request_id", "type" ], "title": "ErrorResponse", "type": "object" }, "CreateMessageParams": { "additionalProperties": false, "example": { "max_tokens": 1024, "messages": [ { "content": "Hello, world", "role": "user" } ], "model": "model-name" }, "properties": { "model": { "$ref": "#/components/schemas/Model" }, "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://docs.claude.com/en/api/messages-examples).\n\nNote that if you want to include a [system prompt](https://docs.claude.com/en/docs/system-prompts), 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/InputMessage" }, "title": "Messages", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.", "title": "Cache Control" }, "container": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "null" } ], "description": "Container identifier for reuse across requests.", "title": "Container" }, "inference_geo": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "null" } ], "description": "Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used.", "title": "Inference Geo" }, "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\nDifferent models have different maximum values for this parameter. See [models](https://docs.claude.com/en/docs/models-overview) for details.", "examples": [ 1024 ], "minimum": 1, "title": "Max Tokens", "type": "integer" }, "metadata": { "$ref": "#/components/schemas/Metadata", "description": "An object describing metadata about the request." }, "output_config": { "$ref": "#/components/schemas/OutputConfig", "description": "Configuration options for the model's output, such as the output format." }, "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://docs.claude.com/en/api/service-tiers) for details.", "enum": [ "auto", "standard_only" ], "title": "Service Tier", "type": "string" }, "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" }, "stream": { "description": "Whether to incrementally stream the response using server-sent events.\n\nSee [streaming](https://docs.claude.com/en/api/messages-streaming) for details.", "title": "Stream", "type": "boolean" }, "system": { "anyOf": [ { "type": "string", "x-stainless-skip": [ "go" ], "title": "string" }, { "items": { "$ref": "#/components/schemas/RequestTextBlock" }, "type": "array", "title": "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://docs.claude.com/en/docs/system-prompts).", "examples": [ [ { "text": "Today's date is 2024-06-01.", "type": "text" } ], "Today's date is 2023-01-01." ], "title": "System" }, "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-stainless-deprecation-message": "Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 of will be accepted for backwards compatibility, all other values will be rejected with a 400 error." }, "thinking": { "$ref": "#/components/schemas/ThinkingConfigParam" }, "tool_choice": { "$ref": "#/components/schemas/ToolChoice" }, "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://docs.claude.com/en/docs/agents-and-tools/tool-use/overview\\#server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://docs.claude.com/en/docs/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://docs.claude.com/en/docs/tool-use) 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/Tool" }, { "$ref": "#/components/schemas/BashTool_20250124" }, { "$ref": "#/components/schemas/CodeExecutionTool_20250522" }, { "$ref": "#/components/schemas/CodeExecutionTool_20250825" }, { "$ref": "#/components/schemas/CodeExecutionTool_20260120" }, { "$ref": "#/components/schemas/MemoryTool_20250818" }, { "$ref": "#/components/schemas/TextEditor_20250124" }, { "$ref": "#/components/schemas/TextEditor_20250429" }, { "$ref": "#/components/schemas/TextEditor_20250728" }, { "$ref": "#/components/schemas/WebSearchTool_20250305" }, { "$ref": "#/components/schemas/WebFetchTool_20250910" }, { "$ref": "#/components/schemas/WebSearchTool_20260209" }, { "$ref": "#/components/schemas/WebFetchTool_20260209" }, { "$ref": "#/components/schemas/WebFetchTool_20260309" }, { "$ref": "#/components/schemas/ToolSearchToolBM25_20251119" }, { "$ref": "#/components/schemas/ToolSearchToolRegex_20251119" } ] }, "title": "Tools", "type": "array" }, "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-stainless-deprecation-message": "Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error." }, "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-stainless-deprecation-message": "Deprecated. Models released after Claude Opus 4.6 do not support setting top_p. A value >= 0.99 will be accepted for backwards compatibility, all other values will be rejected with a 400 error." } }, "required": [ "model", "messages", "max_tokens" ], "title": "CreateMessageParams", "type": "object" }, "CountMessageTokensResponse": { "properties": { "input_tokens": { "type": "integer", "title": "Input Tokens", "description": "The total number of tokens across the provided list of messages, system prompt, and tools.", "examples": [ 2095 ] } }, "type": "object", "required": [ "input_tokens" ], "title": "CountMessageTokensResponse", "examples": [ { "input_tokens": 2095 } ] }, "CountMessageTokensParams": { "additionalProperties": false, "examples": [ { "messages": [ { "content": "Hello, world", "role": "user" } ], "model": "model-name" } ], "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.", "title": "Cache Control" }, "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://docs.claude.com/en/api/messages-examples).\n\nNote that if you want to include a [system prompt](https://docs.claude.com/en/docs/system-prompts), 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/InputMessage" }, "title": "Messages", "type": "array" }, "model": { "$ref": "#/components/schemas/Model" }, "output_config": { "$ref": "#/components/schemas/OutputConfig", "description": "Configuration options for the model's output, such as the output format." }, "system": { "anyOf": [ { "type": "string", "title": "string" }, { "items": { "$ref": "#/components/schemas/RequestTextBlock" }, "type": "array", "title": "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://docs.claude.com/en/docs/system-prompts).", "examples": [ [ { "text": "Today's date is 2024-06-01.", "type": "text" } ], "Today's date is 2023-01-01." ], "title": "System" }, "thinking": { "$ref": "#/components/schemas/ThinkingConfigParam" }, "tool_choice": { "$ref": "#/components/schemas/ToolChoice" }, "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://docs.claude.com/en/docs/agents-and-tools/tool-use/overview\\#server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://docs.claude.com/en/docs/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://docs.claude.com/en/docs/tool-use) 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/Tool" }, { "$ref": "#/components/schemas/BashTool_20250124" }, { "$ref": "#/components/schemas/CodeExecutionTool_20250522" }, { "$ref": "#/components/schemas/CodeExecutionTool_20250825" }, { "$ref": "#/components/schemas/CodeExecutionTool_20260120" }, { "$ref": "#/components/schemas/MemoryTool_20250818" }, { "$ref": "#/components/schemas/TextEditor_20250124" }, { "$ref": "#/components/schemas/TextEditor_20250429" }, { "$ref": "#/components/schemas/TextEditor_20250728" }, { "$ref": "#/components/schemas/WebSearchTool_20250305" }, { "$ref": "#/components/schemas/WebFetchTool_20250910" }, { "$ref": "#/components/schemas/WebSearchTool_20260209" }, { "$ref": "#/components/schemas/WebFetchTool_20260209" }, { "$ref": "#/components/schemas/WebFetchTool_20260309" }, { "$ref": "#/components/schemas/ToolSearchToolBM25_20251119" }, { "$ref": "#/components/schemas/ToolSearchToolRegex_20251119" } ] }, "title": "Tools", "type": "array" } }, "required": [ "messages", "model" ], "title": "CountMessageTokensParams", "type": "object" }, "ContentBlock": { "discriminator": { "mapping": { "bash_code_execution_tool_result": "#/components/schemas/ResponseBashCodeExecutionToolResultBlock", "code_execution_tool_result": "#/components/schemas/ResponseCodeExecutionToolResultBlock", "container_upload": "#/components/schemas/ResponseContainerUploadBlock", "redacted_thinking": "#/components/schemas/ResponseRedactedThinkingBlock", "server_tool_use": "#/components/schemas/ResponseServerToolUseBlock", "text": "#/components/schemas/ResponseTextBlock", "text_editor_code_execution_tool_result": "#/components/schemas/ResponseTextEditorCodeExecutionToolResultBlock", "thinking": "#/components/schemas/ResponseThinkingBlock", "tool_search_tool_result": "#/components/schemas/ResponseToolSearchToolResultBlock", "tool_use": "#/components/schemas/ResponseToolUseBlock", "web_fetch_tool_result": "#/components/schemas/ResponseWebFetchToolResultBlock", "web_search_tool_result": "#/components/schemas/ResponseWebSearchToolResultBlock" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ResponseTextBlock" }, { "$ref": "#/components/schemas/ResponseThinkingBlock" }, { "$ref": "#/components/schemas/ResponseRedactedThinkingBlock" }, { "$ref": "#/components/schemas/ResponseToolUseBlock" }, { "$ref": "#/components/schemas/ResponseServerToolUseBlock" }, { "$ref": "#/components/schemas/ResponseWebSearchToolResultBlock" }, { "$ref": "#/components/schemas/ResponseWebFetchToolResultBlock" }, { "$ref": "#/components/schemas/ResponseCodeExecutionToolResultBlock" }, { "$ref": "#/components/schemas/ResponseBashCodeExecutionToolResultBlock" }, { "$ref": "#/components/schemas/ResponseTextEditorCodeExecutionToolResultBlock" }, { "$ref": "#/components/schemas/ResponseToolSearchToolResultBlock" }, { "$ref": "#/components/schemas/ResponseContainerUploadBlock" } ] }, "Model": { "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", "title": "string" }, { "const": "claude-opus-4-7", "description": "Frontier intelligence for long-running agents and coding", "x-stainless-nominal": false }, { "const": "claude-mythos-preview", "description": "New class of intelligence, strongest in coding and cybersecurity", "x-stainless-nominal": false }, { "const": "claude-opus-4-6", "description": "Frontier intelligence for long-running agents and coding", "x-stainless-nominal": false }, { "const": "claude-sonnet-4-6", "description": "Best combination of speed and intelligence", "x-stainless-nominal": false }, { "const": "claude-haiku-4-5", "description": "Fastest model with near-frontier intelligence", "x-stainless-nominal": false }, { "const": "claude-haiku-4-5-20251001", "description": "Fastest model with near-frontier intelligence", "x-stainless-nominal": false }, { "const": "claude-opus-4-5", "description": "Premium model combining maximum intelligence with practical performance", "x-stainless-nominal": false }, { "const": "claude-opus-4-5-20251101", "description": "Premium model combining maximum intelligence with practical performance", "x-stainless-nominal": false }, { "const": "claude-sonnet-4-5", "description": "High-performance model for agents and coding", "x-stainless-nominal": false }, { "const": "claude-sonnet-4-5-20250929", "description": "High-performance model for agents and coding", "x-stainless-nominal": false }, { "const": "claude-opus-4-1", "description": "Exceptional model for specialized complex tasks", "x-stainless-nominal": false }, { "const": "claude-opus-4-1-20250805", "description": "Exceptional model for specialized complex tasks", "x-stainless-nominal": false }, { "const": "claude-opus-4-0", "description": "Powerful model for complex tasks", "x-stainless-nominal": false, "deprecated": true, "x-stainless-deprecation-message": "Will reach end-of-life on June 15th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information." }, { "const": "claude-opus-4-20250514", "description": "Powerful model for complex tasks", "x-stainless-nominal": false, "deprecated": true, "x-stainless-deprecation-message": "Will reach end-of-life on June 15th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information." }, { "const": "claude-sonnet-4-0", "description": "High-performance model with extended thinking", "x-stainless-nominal": false, "deprecated": true, "x-stainless-deprecation-message": "Will reach end-of-life on June 15th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information." }, { "const": "claude-sonnet-4-20250514", "description": "High-performance model with extended thinking", "x-stainless-nominal": false, "deprecated": true, "x-stainless-deprecation-message": "Will reach end-of-life on June 15th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information." }, { "const": "claude-3-haiku-20240307", "description": "Fast and cost-effective model", "x-stainless-nominal": false, "deprecated": true, "x-stainless-deprecation-message": "Will reach end-of-life on April 20th, 2026. Please migrate to claude-haiku-4-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information." } ] }, "StopReason": { "enum": [ "end_turn", "max_tokens", "stop_sequence", "tool_use", "pause_turn", "refusal" ], "type": "string" }, "RefusalStopDetails": { "description": "Structured information about a refusal.", "properties": { "category": { "anyOf": [ { "enum": [ "cyber", "bio" ], "type": "string", "title": "string" }, { "type": "null", "title": "null" } ], "default": null, "description": "The policy category that triggered the refusal.\n\n`null` when the refusal doesn't map to a named category.", "title": "Category" }, "explanation": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "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.", "title": "Explanation" }, "type": { "const": "refusal", "default": "refusal", "title": "Type", "type": "string" } }, "required": [ "category", "explanation", "type" ], "title": "RefusalStopDetails", "type": "object" }, "Usage": { "properties": { "cache_creation": { "anyOf": [ { "$ref": "#/components/schemas/CacheCreation" }, { "type": "null", "title": "null" } ], "default": null, "description": "Breakdown of cached tokens by TTL" }, "cache_creation_input_tokens": { "anyOf": [ { "minimum": 0, "type": "integer", "title": "integer" }, { "type": "null", "title": "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", "title": "integer" }, { "type": "null", "title": "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", "title": "string" }, { "type": "null", "title": "null" } ], "default": null, "description": "The geographic region where inference was performed for this request.", "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" }, "server_tool_use": { "anyOf": [ { "$ref": "#/components/schemas/ServerToolUsage" }, { "type": "null", "title": "null" } ], "default": null, "description": "The number of server tool requests." }, "service_tier": { "anyOf": [ { "enum": [ "standard", "priority", "batch" ], "type": "string", "title": "string" }, { "type": "null", "title": "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", "inference_geo", "input_tokens", "output_tokens", "server_tool_use", "service_tier" ], "title": "Usage", "type": "object" }, "Container": { "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", "title": "Id", "type": "string" } }, "required": [ "expires_at", "id" ], "title": "Container", "type": "object" }, "InvalidRequestError": { "properties": { "message": { "default": "Invalid request", "title": "Message", "type": "string" }, "type": { "const": "invalid_request_error", "default": "invalid_request_error", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "InvalidRequestError", "type": "object" }, "AuthenticationError": { "properties": { "message": { "default": "Authentication error", "title": "Message", "type": "string" }, "type": { "const": "authentication_error", "default": "authentication_error", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "AuthenticationError", "type": "object" }, "BillingError": { "properties": { "message": { "default": "Billing error", "title": "Message", "type": "string" }, "type": { "const": "billing_error", "default": "billing_error", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "BillingError", "type": "object" }, "PermissionError": { "properties": { "message": { "default": "Permission denied", "title": "Message", "type": "string" }, "type": { "const": "permission_error", "default": "permission_error", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "PermissionError", "type": "object" }, "NotFoundError": { "properties": { "message": { "default": "Not found", "title": "Message", "type": "string" }, "type": { "const": "not_found_error", "default": "not_found_error", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "NotFoundError", "type": "object" }, "RateLimitError": { "properties": { "message": { "default": "Rate limited", "title": "Message", "type": "string" }, "type": { "const": "rate_limit_error", "default": "rate_limit_error", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "RateLimitError", "type": "object" }, "GatewayTimeoutError": { "properties": { "message": { "default": "Request timeout", "title": "Message", "type": "string" }, "type": { "const": "timeout_error", "default": "timeout_error", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "GatewayTimeoutError", "type": "object" }, "APIError": { "properties": { "message": { "default": "Internal server error", "title": "Message", "type": "string" }, "type": { "const": "api_error", "default": "api_error", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "APIError", "type": "object" }, "OverloadedError": { "properties": { "message": { "default": "Overloaded", "title": "Message", "type": "string" }, "type": { "const": "overloaded_error", "default": "overloaded_error", "title": "Type", "type": "string" } }, "required": [ "message", "type" ], "title": "OverloadedError", "type": "object" }, "InputMessage": { "additionalProperties": false, "properties": { "content": { "anyOf": [ { "type": "string", "x-stainless-skip": [ "go", "cli" ], "title": "string" }, { "items": { "$ref": "#/components/schemas/InputContentBlock" }, "type": "array", "example": [ { "type": "text", "text": "What is a quaternion?" } ], "title": "array" } ], "title": "Content" }, "role": { "enum": [ "user", "assistant" ], "title": "Role", "type": "string" } }, "required": [ "content", "role" ], "title": "InputMessage", "type": "object", "discriminator": { "propertyName": "role" } }, "CacheControlEphemeral": { "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`.", "enum": [ "5m", "1h" ], "title": "Ttl", "type": "string", "x-stainless-renameMap": { "ttl_5m": "5m", "ttl_1h": "1h" } }, "type": { "const": "ephemeral", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "CacheControlEphemeral", "type": "object", "x-stainless-go-constant-constructor": true }, "Metadata": { "additionalProperties": false, "properties": { "user_id": { "anyOf": [ { "maxLength": 512, "type": "string", "title": "string" }, { "type": "null", "title": "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" }, "OutputConfig": { "additionalProperties": false, "properties": { "effort": { "anyOf": [ { "$ref": "#/components/schemas/EffortLevel" }, { "type": "null", "title": "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`, or `max`." }, "format": { "anyOf": [ { "$ref": "#/components/schemas/JsonOutputFormat" }, { "type": "null", "title": "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" }, "RequestTextBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "citations": { "anyOf": [ { "items": { "discriminator": { "mapping": { "char_location": "#/components/schemas/RequestCharLocationCitation", "content_block_location": "#/components/schemas/RequestContentBlockLocationCitation", "page_location": "#/components/schemas/RequestPageLocationCitation", "search_result_location": "#/components/schemas/RequestSearchResultLocationCitation", "web_search_result_location": "#/components/schemas/RequestWebSearchResultLocationCitation" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/RequestCharLocationCitation" }, { "$ref": "#/components/schemas/RequestPageLocationCitation" }, { "$ref": "#/components/schemas/RequestContentBlockLocationCitation" }, { "$ref": "#/components/schemas/RequestWebSearchResultLocationCitation" }, { "$ref": "#/components/schemas/RequestSearchResultLocationCitation" } ] }, "type": "array", "title": "array" }, { "type": "null", "title": "null" } ], "title": "Citations" }, "text": { "minLength": 1, "title": "Text", "type": "string" }, "type": { "const": "text", "title": "Type", "type": "string" } }, "required": [ "text", "type" ], "title": "RequestTextBlock", "type": "object" }, "ThinkingConfigParam": { "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://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details.", "discriminator": { "mapping": { "adaptive": "#/components/schemas/ThinkingConfigAdaptive", "disabled": "#/components/schemas/ThinkingConfigDisabled", "enabled": "#/components/schemas/ThinkingConfigEnabled" }, "propertyName": "type" }, "examples": [ { "type": "adaptive" } ], "oneOf": [ { "$ref": "#/components/schemas/ThinkingConfigEnabled" }, { "$ref": "#/components/schemas/ThinkingConfigDisabled" }, { "$ref": "#/components/schemas/ThinkingConfigAdaptive" } ], "title": "Thinking" }, "ToolChoice": { "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/ToolChoiceAny", "auto": "#/components/schemas/ToolChoiceAuto", "none": "#/components/schemas/ToolChoiceNone", "tool": "#/components/schemas/ToolChoiceTool" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ToolChoiceAuto" }, { "$ref": "#/components/schemas/ToolChoiceAny" }, { "$ref": "#/components/schemas/ToolChoiceTool" }, { "$ref": "#/components/schemas/ToolChoiceNone" } ], "title": "Tool Choice" }, "Tool": { "additionalProperties": false, "properties": { "type": { "anyOf": [ { "type": "null", "title": "null" }, { "const": "custom", "type": "string", "title": "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/InputSchema", "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/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "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", "title": "boolean" }, { "type": "null", "title": "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/AllowedCaller" }, "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/JsonValue" }, "type": "object" }, "title": "Input Examples", "type": "array" } }, "required": [ "name", "input_schema" ], "title": "Tool", "type": "object" }, "BashTool_20250124": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "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/JsonValue" }, "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" }, "CodeExecutionTool_20250522": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "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" }, "CodeExecutionTool_20250825": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "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" }, "CodeExecutionTool_20260120": { "additionalProperties": false, "description": "Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).", "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "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" }, "MemoryTool_20250818": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "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/JsonValue" }, "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" }, "TextEditor_20250124": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "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/JsonValue" }, "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" }, "TextEditor_20250429": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "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/JsonValue" }, "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" }, "TextEditor_20250728": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "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/JsonValue" }, "type": "object" }, "title": "Input Examples", "type": "array" }, "max_characters": { "anyOf": [ { "minimum": 1, "type": "integer", "title": "integer" }, { "type": "null", "title": "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" }, "WebSearchTool_20250305": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "title": "array" }, { "type": "null", "title": "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", "title": "array" }, { "type": "null", "title": "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/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "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", "title": "integer" }, { "type": "null", "title": "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/UserLocation" }, { "type": "null", "title": "null" } ], "description": "Parameters for the user's location. Used to provide more relevant search results." } }, "required": [ "name", "type" ], "title": "WebSearchTool_20250305", "type": "object" }, "WebFetchTool_20250910": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "title": "array" }, { "type": "null", "title": "null" } ], "description": "List of domains to allow fetching from", "title": "Allowed Domains" }, "blocked_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "title": "array" }, { "type": "null", "title": "null" } ], "description": "List of domains to block fetching from", "title": "Blocked Domains" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "citations": { "anyOf": [ { "$ref": "#/components/schemas/RequestCitationsConfig" }, { "type": "null", "title": "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", "title": "integer" }, { "type": "null", "title": "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", "title": "integer" }, { "type": "null", "title": "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" }, "WebSearchTool_20260209": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "title": "array" }, { "type": "null", "title": "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", "title": "array" }, { "type": "null", "title": "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/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "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", "title": "integer" }, { "type": "null", "title": "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/UserLocation" }, { "type": "null", "title": "null" } ], "description": "Parameters for the user's location. Used to provide more relevant search results." } }, "required": [ "name", "type" ], "title": "WebSearchTool_20260209", "type": "object" }, "WebFetchTool_20260209": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "title": "array" }, { "type": "null", "title": "null" } ], "description": "List of domains to allow fetching from", "title": "Allowed Domains" }, "blocked_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "title": "array" }, { "type": "null", "title": "null" } ], "description": "List of domains to block fetching from", "title": "Blocked Domains" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "citations": { "anyOf": [ { "$ref": "#/components/schemas/RequestCitationsConfig" }, { "type": "null", "title": "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", "title": "integer" }, { "type": "null", "title": "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", "title": "integer" }, { "type": "null", "title": "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" }, "WebFetchTool_20260309": { "additionalProperties": false, "description": "Web fetch tool with use_cache parameter for bypassing cached content.", "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "title": "array" }, { "type": "null", "title": "null" } ], "description": "List of domains to allow fetching from", "title": "Allowed Domains" }, "blocked_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "title": "array" }, { "type": "null", "title": "null" } ], "description": "List of domains to block fetching from", "title": "Blocked Domains" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "citations": { "anyOf": [ { "$ref": "#/components/schemas/RequestCitationsConfig" }, { "type": "null", "title": "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", "title": "integer" }, { "type": "null", "title": "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", "title": "integer" }, { "type": "null", "title": "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" }, "ToolSearchToolBM25_20251119": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "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" }, "ToolSearchToolRegex_20251119": { "additionalProperties": false, "properties": { "allowed_callers": { "items": { "$ref": "#/components/schemas/AllowedCaller" }, "title": "Allowed Callers", "type": "array" }, "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "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" }, "ResponseTextBlock": { "properties": { "citations": { "anyOf": [ { "items": { "discriminator": { "mapping": { "char_location": "#/components/schemas/ResponseCharLocationCitation", "content_block_location": "#/components/schemas/ResponseContentBlockLocationCitation", "page_location": "#/components/schemas/ResponsePageLocationCitation", "search_result_location": "#/components/schemas/ResponseSearchResultLocationCitation", "web_search_result_location": "#/components/schemas/ResponseWebSearchResultLocationCitation" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ResponseCharLocationCitation" }, { "$ref": "#/components/schemas/ResponsePageLocationCitation" }, { "$ref": "#/components/schemas/ResponseContentBlockLocationCitation" }, { "$ref": "#/components/schemas/ResponseWebSearchResultLocationCitation" }, { "$ref": "#/components/schemas/ResponseSearchResultLocationCitation" } ] }, "type": "array", "title": "array" }, { "type": "null", "title": "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": [ "citations", "text", "type" ], "title": "ResponseTextBlock", "type": "object" }, "ResponseThinkingBlock": { "properties": { "signature": { "title": "Signature", "type": "string" }, "thinking": { "title": "Thinking", "type": "string" }, "type": { "const": "thinking", "default": "thinking", "title": "Type", "type": "string" } }, "required": [ "signature", "thinking", "type" ], "title": "ResponseThinkingBlock", "type": "object" }, "ResponseRedactedThinkingBlock": { "properties": { "data": { "title": "Data", "type": "string" }, "type": { "const": "redacted_thinking", "default": "redacted_thinking", "title": "Type", "type": "string" } }, "required": [ "data", "type" ], "title": "ResponseRedactedThinkingBlock", "type": "object" }, "ResponseToolUseBlock": { "properties": { "caller": { "default": { "type": "direct" }, "discriminator": { "mapping": { "code_execution_20250825": "#/components/schemas/ServerToolCaller", "code_execution_20260120": "#/components/schemas/ServerToolCaller_20260120", "direct": "#/components/schemas/DirectCaller" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/DirectCaller" }, { "$ref": "#/components/schemas/ServerToolCaller" }, { "$ref": "#/components/schemas/ServerToolCaller_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" }, "type": { "const": "tool_use", "default": "tool_use", "title": "Type", "type": "string" } }, "required": [ "caller", "id", "input", "name", "type" ], "title": "ResponseToolUseBlock", "type": "object" }, "ResponseServerToolUseBlock": { "properties": { "caller": { "default": { "type": "direct" }, "discriminator": { "mapping": { "code_execution_20250825": "#/components/schemas/ServerToolCaller", "code_execution_20260120": "#/components/schemas/ServerToolCaller_20260120", "direct": "#/components/schemas/DirectCaller" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/DirectCaller" }, { "$ref": "#/components/schemas/ServerToolCaller" }, { "$ref": "#/components/schemas/ServerToolCaller_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": [ "caller", "id", "input", "name", "type" ], "title": "ResponseServerToolUseBlock", "type": "object" }, "ResponseWebSearchToolResultBlock": { "properties": { "caller": { "default": { "type": "direct" }, "discriminator": { "mapping": { "code_execution_20250825": "#/components/schemas/ServerToolCaller", "code_execution_20260120": "#/components/schemas/ServerToolCaller_20260120", "direct": "#/components/schemas/DirectCaller" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/DirectCaller" }, { "$ref": "#/components/schemas/ServerToolCaller" }, { "$ref": "#/components/schemas/ServerToolCaller_20260120" } ], "title": "Caller" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/ResponseWebSearchToolResultError" }, { "items": { "$ref": "#/components/schemas/ResponseWebSearchResultBlock" }, "type": "array", "title": "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" }, "ResponseWebFetchToolResultBlock": { "properties": { "caller": { "default": { "type": "direct" }, "discriminator": { "mapping": { "code_execution_20250825": "#/components/schemas/ServerToolCaller", "code_execution_20260120": "#/components/schemas/ServerToolCaller_20260120", "direct": "#/components/schemas/DirectCaller" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/DirectCaller" }, { "$ref": "#/components/schemas/ServerToolCaller" }, { "$ref": "#/components/schemas/ServerToolCaller_20260120" } ], "title": "Caller" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/ResponseWebFetchToolResultError" }, { "$ref": "#/components/schemas/ResponseWebFetchResultBlock" } ], "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" }, "ResponseCodeExecutionToolResultBlock": { "properties": { "content": { "anyOf": [ { "$ref": "#/components/schemas/ResponseCodeExecutionToolResultError" }, { "$ref": "#/components/schemas/ResponseCodeExecutionResultBlock" }, { "$ref": "#/components/schemas/ResponseEncryptedCodeExecutionResultBlock" } ], "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" }, "ResponseBashCodeExecutionToolResultBlock": { "properties": { "content": { "anyOf": [ { "$ref": "#/components/schemas/ResponseBashCodeExecutionToolResultError" }, { "$ref": "#/components/schemas/ResponseBashCodeExecutionResultBlock" } ], "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" }, "ResponseTextEditorCodeExecutionToolResultBlock": { "properties": { "content": { "anyOf": [ { "$ref": "#/components/schemas/ResponseTextEditorCodeExecutionToolResultError" }, { "$ref": "#/components/schemas/ResponseTextEditorCodeExecutionViewResultBlock" }, { "$ref": "#/components/schemas/ResponseTextEditorCodeExecutionCreateResultBlock" }, { "$ref": "#/components/schemas/ResponseTextEditorCodeExecutionStrReplaceResultBlock" } ], "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" }, "ResponseToolSearchToolResultBlock": { "properties": { "content": { "anyOf": [ { "$ref": "#/components/schemas/ResponseToolSearchToolResultError" }, { "$ref": "#/components/schemas/ResponseToolSearchToolSearchResultBlock" } ], "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" }, "ResponseContainerUploadBlock": { "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" }, "CacheCreation": { "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" }, "ServerToolUsage": { "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" }, "InputContentBlock": { "discriminator": { "mapping": { "bash_code_execution_tool_result": "#/components/schemas/RequestBashCodeExecutionToolResultBlock", "code_execution_tool_result": "#/components/schemas/RequestCodeExecutionToolResultBlock", "container_upload": "#/components/schemas/RequestContainerUploadBlock", "document": "#/components/schemas/RequestDocumentBlock", "image": "#/components/schemas/RequestImageBlock", "redacted_thinking": "#/components/schemas/RequestRedactedThinkingBlock", "search_result": "#/components/schemas/RequestSearchResultBlock", "server_tool_use": "#/components/schemas/RequestServerToolUseBlock", "text": "#/components/schemas/RequestTextBlock", "text_editor_code_execution_tool_result": "#/components/schemas/RequestTextEditorCodeExecutionToolResultBlock", "thinking": "#/components/schemas/RequestThinkingBlock", "tool_result": "#/components/schemas/RequestToolResultBlock", "tool_search_tool_result": "#/components/schemas/RequestToolSearchToolResultBlock", "tool_use": "#/components/schemas/RequestToolUseBlock", "web_fetch_tool_result": "#/components/schemas/RequestWebFetchToolResultBlock", "web_search_tool_result": "#/components/schemas/RequestWebSearchToolResultBlock" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/RequestTextBlock", "description": "Regular text content." }, { "$ref": "#/components/schemas/RequestImageBlock", "description": "Image content specified directly as base64 data or as a reference via a URL." }, { "$ref": "#/components/schemas/RequestDocumentBlock", "description": "Document content, either specified directly as base64 data, as text, or as a reference via a URL." }, { "$ref": "#/components/schemas/RequestSearchResultBlock", "description": "A search result block containing source, title, and content from search operations." }, { "$ref": "#/components/schemas/RequestThinkingBlock", "description": "A block specifying internal thinking by the model." }, { "$ref": "#/components/schemas/RequestRedactedThinkingBlock", "description": "A block specifying internal, redacted thinking by the model." }, { "$ref": "#/components/schemas/RequestToolUseBlock", "description": "A block indicating a tool use by the model." }, { "$ref": "#/components/schemas/RequestToolResultBlock", "description": "A block specifying the results of a tool use by the model." }, { "$ref": "#/components/schemas/RequestServerToolUseBlock" }, { "$ref": "#/components/schemas/RequestWebSearchToolResultBlock" }, { "$ref": "#/components/schemas/RequestWebFetchToolResultBlock" }, { "$ref": "#/components/schemas/RequestCodeExecutionToolResultBlock" }, { "$ref": "#/components/schemas/RequestBashCodeExecutionToolResultBlock" }, { "$ref": "#/components/schemas/RequestTextEditorCodeExecutionToolResultBlock" }, { "$ref": "#/components/schemas/RequestToolSearchToolResultBlock" }, { "$ref": "#/components/schemas/RequestContainerUploadBlock" } ], "x-stainless-python-extend-union": [ "ContentBlock" ], "x-stainless-python-extend-union-imports": [ "from .content_block import ContentBlock" ], "x-stainless-go-variant-constructor": { "naming": "new_{variant}_block" } }, "EffortLevel": { "description": "All possible effort levels.", "enum": [ "low", "medium", "high", "xhigh", "max" ], "title": "EffortLevel", "type": "string" }, "JsonOutputFormat": { "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" }, "RequestCharLocationCitation": { "additionalProperties": false, "properties": { "cited_text": { "title": "Cited Text", "type": "string" }, "document_index": { "minimum": 0, "title": "Document Index", "type": "integer" }, "document_title": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string", "title": "string" }, { "type": "null", "title": "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" }, "RequestPageLocationCitation": { "additionalProperties": false, "properties": { "cited_text": { "title": "Cited Text", "type": "string" }, "document_index": { "minimum": 0, "title": "Document Index", "type": "integer" }, "document_title": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string", "title": "string" }, { "type": "null", "title": "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" }, "RequestContentBlockLocationCitation": { "additionalProperties": false, "properties": { "cited_text": { "title": "Cited Text", "type": "string" }, "document_index": { "minimum": 0, "title": "Document Index", "type": "integer" }, "document_title": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string", "title": "string" }, { "type": "null", "title": "null" } ], "title": "Document Title" }, "end_block_index": { "title": "End Block Index", "type": "integer" }, "start_block_index": { "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" }, "RequestWebSearchResultLocationCitation": { "additionalProperties": false, "properties": { "cited_text": { "title": "Cited Text", "type": "string" }, "encrypted_index": { "title": "Encrypted Index", "type": "string" }, "title": { "anyOf": [ { "maxLength": 512, "minLength": 1, "type": "string", "title": "string" }, { "type": "null", "title": "null" } ], "title": "Title" }, "type": { "const": "web_search_result_location", "title": "Type", "type": "string" }, "url": { "maxLength": 2048, "minLength": 1, "title": "Url", "type": "string" } }, "required": [ "cited_text", "encrypted_index", "title", "type", "url" ], "title": "RequestWebSearchResultLocationCitation", "type": "object" }, "RequestSearchResultLocationCitation": { "additionalProperties": false, "properties": { "cited_text": { "title": "Cited Text", "type": "string" }, "end_block_index": { "title": "End Block Index", "type": "integer" }, "search_result_index": { "minimum": 0, "title": "Search Result Index", "type": "integer" }, "source": { "title": "Source", "type": "string" }, "start_block_index": { "minimum": 0, "title": "Start Block Index", "type": "integer" }, "title": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "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" }, "ThinkingConfigEnabled": { "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://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details.", "minimum": 1024, "title": "Budget Tokens", "type": "integer" }, "display": { "anyOf": [ { "$ref": "#/components/schemas/ThinkingDisplayMode" }, { "type": "null", "title": "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" }, "ThinkingConfigDisabled": { "additionalProperties": false, "properties": { "type": { "const": "disabled", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "ThinkingConfigDisabled", "type": "object", "x-stainless-go-constant-constructor": true }, "ThinkingConfigAdaptive": { "additionalProperties": false, "properties": { "display": { "anyOf": [ { "$ref": "#/components/schemas/ThinkingDisplayMode" }, { "type": "null", "title": "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" }, "ToolChoiceAuto": { "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" }, "ToolChoiceAny": { "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" }, "ToolChoiceTool": { "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" }, "ToolChoiceNone": { "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-stainless-go-constant-constructor": true }, "InputSchema": { "additionalProperties": true, "properties": { "properties": { "anyOf": [ { "additionalProperties": true, "type": "object", "title": "object" }, { "type": "null", "title": "null" } ], "title": "Properties" }, "required": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "title": "array" }, { "type": "null", "title": "null" } ], "title": "Required" }, "type": { "const": "object", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "InputSchema", "type": "object" }, "AllowedCaller": { "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).", "enum": [ "direct", "code_execution_20250825", "code_execution_20260120" ], "title": "AllowedCaller", "type": "string" }, "JsonValue": {}, "UserLocation": { "additionalProperties": false, "properties": { "city": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string", "title": "string" }, { "type": "null", "title": "null" } ], "description": "The city of the user.", "examples": [ "New York", "Tokyo", "Los Angeles" ], "title": "City" }, "country": { "anyOf": [ { "maxLength": 2, "minLength": 2, "type": "string", "title": "string" }, { "type": "null", "title": "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", "title": "string" }, { "type": "null", "title": "null" } ], "description": "The region of the user.", "examples": [ "California", "Ontario", "Wales" ], "title": "Region" }, "timezone": { "anyOf": [ { "maxLength": 255, "minLength": 1, "type": "string", "title": "string" }, { "type": "null", "title": "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" }, "RequestCitationsConfig": { "additionalProperties": false, "properties": { "enabled": { "title": "Enabled", "type": "boolean" } }, "title": "RequestCitationsConfig", "type": "object" }, "ResponseCharLocationCitation": { "properties": { "cited_text": { "title": "Cited Text", "type": "string" }, "document_index": { "minimum": 0, "title": "Document Index", "type": "integer" }, "document_title": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "null" } ], "title": "Document Title" }, "end_char_index": { "title": "End Char Index", "type": "integer" }, "file_id": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "null" } ], "default": null, "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" }, "ResponsePageLocationCitation": { "properties": { "cited_text": { "title": "Cited Text", "type": "string" }, "document_index": { "minimum": 0, "title": "Document Index", "type": "integer" }, "document_title": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "null" } ], "title": "Document Title" }, "end_page_number": { "title": "End Page Number", "type": "integer" }, "file_id": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "null" } ], "default": null, "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" }, "ResponseContentBlockLocationCitation": { "properties": { "cited_text": { "title": "Cited Text", "type": "string" }, "document_index": { "minimum": 0, "title": "Document Index", "type": "integer" }, "document_title": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "null" } ], "title": "Document Title" }, "end_block_index": { "title": "End Block Index", "type": "integer" }, "file_id": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "null" } ], "default": null, "title": "File Id" }, "start_block_index": { "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" }, "ResponseWebSearchResultLocationCitation": { "properties": { "cited_text": { "title": "Cited Text", "type": "string" }, "encrypted_index": { "title": "Encrypted Index", "type": "string" }, "title": { "anyOf": [ { "maxLength": 512, "type": "string", "title": "string" }, { "type": "null", "title": "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" }, "ResponseSearchResultLocationCitation": { "properties": { "cited_text": { "title": "Cited Text", "type": "string" }, "end_block_index": { "title": "End Block Index", "type": "integer" }, "search_result_index": { "minimum": 0, "title": "Search Result Index", "type": "integer" }, "source": { "title": "Source", "type": "string" }, "start_block_index": { "minimum": 0, "title": "Start Block Index", "type": "integer" }, "title": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "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" }, "DirectCaller": { "additionalProperties": false, "description": "Tool invocation directly from the model.", "properties": { "type": { "const": "direct", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "DirectCaller", "type": "object" }, "ServerToolCaller": { "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" }, "ServerToolCaller_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" }, "ResponseWebSearchToolResultError": { "properties": { "error_code": { "$ref": "#/components/schemas/WebSearchToolResultErrorCode" }, "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" }, "ResponseWebSearchResultBlock": { "properties": { "encrypted_content": { "title": "Encrypted Content", "type": "string" }, "page_age": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "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" }, "ResponseWebFetchToolResultError": { "properties": { "error_code": { "$ref": "#/components/schemas/WebFetchToolResultErrorCode" }, "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" }, "ResponseWebFetchResultBlock": { "properties": { "content": { "$ref": "#/components/schemas/ResponseDocumentBlock" }, "retrieved_at": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "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" }, "ResponseCodeExecutionToolResultError": { "properties": { "error_code": { "$ref": "#/components/schemas/CodeExecutionToolResultErrorCode" }, "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" }, "ResponseCodeExecutionResultBlock": { "properties": { "content": { "items": { "$ref": "#/components/schemas/ResponseCodeExecutionOutputBlock" }, "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" }, "ResponseEncryptedCodeExecutionResultBlock": { "description": "Code execution result with encrypted stdout for PFC + web_search results.", "properties": { "content": { "items": { "$ref": "#/components/schemas/ResponseCodeExecutionOutputBlock" }, "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" }, "ResponseBashCodeExecutionToolResultError": { "properties": { "error_code": { "$ref": "#/components/schemas/BashCodeExecutionToolResultErrorCode" }, "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" }, "ResponseBashCodeExecutionResultBlock": { "properties": { "content": { "items": { "$ref": "#/components/schemas/ResponseBashCodeExecutionOutputBlock" }, "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" }, "ResponseTextEditorCodeExecutionToolResultError": { "properties": { "error_code": { "$ref": "#/components/schemas/TextEditorCodeExecutionToolResultErrorCode" }, "error_message": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "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" }, "ResponseTextEditorCodeExecutionViewResultBlock": { "properties": { "content": { "title": "Content", "type": "string" }, "file_type": { "enum": [ "text", "image", "pdf" ], "title": "File Type", "type": "string" }, "num_lines": { "anyOf": [ { "type": "integer", "title": "integer" }, { "type": "null", "title": "null" } ], "default": null, "title": "Num Lines" }, "start_line": { "anyOf": [ { "type": "integer", "title": "integer" }, { "type": "null", "title": "null" } ], "default": null, "title": "Start Line" }, "total_lines": { "anyOf": [ { "type": "integer", "title": "integer" }, { "type": "null", "title": "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" }, "ResponseTextEditorCodeExecutionCreateResultBlock": { "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" }, "ResponseTextEditorCodeExecutionStrReplaceResultBlock": { "properties": { "lines": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "title": "array" }, { "type": "null", "title": "null" } ], "default": null, "title": "Lines" }, "new_lines": { "anyOf": [ { "type": "integer", "title": "integer" }, { "type": "null", "title": "null" } ], "default": null, "title": "New Lines" }, "new_start": { "anyOf": [ { "type": "integer", "title": "integer" }, { "type": "null", "title": "null" } ], "default": null, "title": "New Start" }, "old_lines": { "anyOf": [ { "type": "integer", "title": "integer" }, { "type": "null", "title": "null" } ], "default": null, "title": "Old Lines" }, "old_start": { "anyOf": [ { "type": "integer", "title": "integer" }, { "type": "null", "title": "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" }, "ResponseToolSearchToolResultError": { "properties": { "error_code": { "$ref": "#/components/schemas/ToolSearchToolResultErrorCode" }, "error_message": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "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" }, "ResponseToolSearchToolSearchResultBlock": { "properties": { "tool_references": { "items": { "$ref": "#/components/schemas/ResponseToolReferenceBlock" }, "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" }, "RequestImageBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "source": { "discriminator": { "mapping": { "base64": "#/components/schemas/Base64ImageSource", "url": "#/components/schemas/URLImageSource" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/Base64ImageSource" }, { "$ref": "#/components/schemas/URLImageSource" } ], "title": "Source" }, "type": { "const": "image", "title": "Type", "type": "string" } }, "required": [ "source", "type" ], "title": "RequestImageBlock", "type": "object" }, "RequestDocumentBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "citations": { "anyOf": [ { "$ref": "#/components/schemas/RequestCitationsConfig" }, { "type": "null", "title": "null" } ] }, "context": { "anyOf": [ { "minLength": 1, "type": "string", "title": "string" }, { "type": "null", "title": "null" } ], "title": "Context" }, "source": { "discriminator": { "mapping": { "base64": "#/components/schemas/Base64PDFSource", "content": "#/components/schemas/ContentBlockSource", "text": "#/components/schemas/PlainTextSource", "url": "#/components/schemas/URLPDFSource" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/Base64PDFSource" }, { "$ref": "#/components/schemas/PlainTextSource" }, { "$ref": "#/components/schemas/ContentBlockSource" }, { "$ref": "#/components/schemas/URLPDFSource" } ], "title": "Source" }, "title": { "anyOf": [ { "maxLength": 500, "minLength": 1, "type": "string", "title": "string" }, { "type": "null", "title": "null" } ], "title": "Title" }, "type": { "const": "document", "title": "Type", "type": "string" } }, "required": [ "source", "type" ], "title": "RequestDocumentBlock", "type": "object" }, "RequestSearchResultBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "citations": { "$ref": "#/components/schemas/RequestCitationsConfig" }, "content": { "items": { "$ref": "#/components/schemas/RequestTextBlock" }, "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" }, "RequestThinkingBlock": { "additionalProperties": false, "properties": { "signature": { "title": "Signature", "type": "string" }, "thinking": { "title": "Thinking", "type": "string" }, "type": { "const": "thinking", "title": "Type", "type": "string" } }, "required": [ "signature", "thinking", "type" ], "title": "RequestThinkingBlock", "type": "object" }, "RequestRedactedThinkingBlock": { "additionalProperties": false, "properties": { "data": { "title": "Data", "type": "string" }, "type": { "const": "redacted_thinking", "title": "Type", "type": "string" } }, "required": [ "data", "type" ], "title": "RequestRedactedThinkingBlock", "type": "object" }, "RequestToolUseBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "caller": { "discriminator": { "mapping": { "code_execution_20250825": "#/components/schemas/ServerToolCaller", "code_execution_20260120": "#/components/schemas/ServerToolCaller_20260120", "direct": "#/components/schemas/DirectCaller" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/DirectCaller" }, { "$ref": "#/components/schemas/ServerToolCaller" }, { "$ref": "#/components/schemas/ServerToolCaller_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" }, "type": { "const": "tool_use", "title": "Type", "type": "string" } }, "required": [ "id", "input", "name", "type" ], "title": "RequestToolUseBlock", "type": "object" }, "RequestToolResultBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "content": { "anyOf": [ { "type": "string", "x-stainless-skip": [ "go", "cli" ], "title": "string" }, { "items": { "discriminator": { "mapping": { "document": "#/components/schemas/RequestDocumentBlock", "image": "#/components/schemas/RequestImageBlock", "search_result": "#/components/schemas/RequestSearchResultBlock", "text": "#/components/schemas/RequestTextBlock", "tool_reference": "#/components/schemas/RequestToolReferenceBlock" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/RequestTextBlock" }, { "$ref": "#/components/schemas/RequestImageBlock" }, { "$ref": "#/components/schemas/RequestSearchResultBlock" }, { "$ref": "#/components/schemas/RequestDocumentBlock" }, { "$ref": "#/components/schemas/RequestToolReferenceBlock" } ], "title": "Block" }, "type": "array", "x-stainless-naming": { "python": { "type_name": "Content" }, "ruby": { "type_name": "Content" }, "php": { "type_name": "Content" } }, "title": "array" } ], "title": "Content" }, "is_error": { "title": "Is Error", "type": "boolean" }, "tool_use_id": { "pattern": "^[a-zA-Z0-9_-]+$", "title": "Tool Use Id", "type": "string" }, "type": { "const": "tool_result", "title": "Type", "type": "string" } }, "required": [ "tool_use_id", "type" ], "title": "RequestToolResultBlock", "type": "object" }, "RequestServerToolUseBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "caller": { "discriminator": { "mapping": { "code_execution_20250825": "#/components/schemas/ServerToolCaller", "code_execution_20260120": "#/components/schemas/ServerToolCaller_20260120", "direct": "#/components/schemas/DirectCaller" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/DirectCaller" }, { "$ref": "#/components/schemas/ServerToolCaller" }, { "$ref": "#/components/schemas/ServerToolCaller_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" }, "RequestWebSearchToolResultBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "caller": { "discriminator": { "mapping": { "code_execution_20250825": "#/components/schemas/ServerToolCaller", "code_execution_20260120": "#/components/schemas/ServerToolCaller_20260120", "direct": "#/components/schemas/DirectCaller" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/DirectCaller" }, { "$ref": "#/components/schemas/ServerToolCaller" }, { "$ref": "#/components/schemas/ServerToolCaller_20260120" } ], "title": "Caller" }, "content": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RequestWebSearchResultBlock" }, "type": "array", "title": "web_search_tool_result_block_item" }, { "$ref": "#/components/schemas/RequestWebSearchToolResultError", "x-stainless-naming": { "go": { "variant_constructor": "NewWebSearchToolRequestError" } } } ], "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" }, "RequestWebFetchToolResultBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "caller": { "discriminator": { "mapping": { "code_execution_20250825": "#/components/schemas/ServerToolCaller", "code_execution_20260120": "#/components/schemas/ServerToolCaller_20260120", "direct": "#/components/schemas/DirectCaller" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/DirectCaller" }, { "$ref": "#/components/schemas/ServerToolCaller" }, { "$ref": "#/components/schemas/ServerToolCaller_20260120" } ], "title": "Caller" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/RequestWebFetchToolResultError" }, { "$ref": "#/components/schemas/RequestWebFetchResultBlock" } ], "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" }, "RequestCodeExecutionToolResultBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/RequestCodeExecutionToolResultError" }, { "$ref": "#/components/schemas/RequestCodeExecutionResultBlock" }, { "$ref": "#/components/schemas/RequestEncryptedCodeExecutionResultBlock" } ], "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" }, "RequestBashCodeExecutionToolResultBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/RequestBashCodeExecutionToolResultError" }, { "$ref": "#/components/schemas/RequestBashCodeExecutionResultBlock" } ], "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" }, "RequestTextEditorCodeExecutionToolResultBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/RequestTextEditorCodeExecutionToolResultError" }, { "$ref": "#/components/schemas/RequestTextEditorCodeExecutionViewResultBlock" }, { "$ref": "#/components/schemas/RequestTextEditorCodeExecutionCreateResultBlock" }, { "$ref": "#/components/schemas/RequestTextEditorCodeExecutionStrReplaceResultBlock" } ], "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" }, "RequestToolSearchToolResultBlock": { "additionalProperties": false, "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "null" } ], "description": "Create a cache control breakpoint at this content block.", "title": "Cache Control" }, "content": { "anyOf": [ { "$ref": "#/components/schemas/RequestToolSearchToolResultError" }, { "$ref": "#/components/schemas/RequestToolSearchToolSearchResultBlock" } ], "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" }, "RequestContainerUploadBlock": { "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/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "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" }, "ThinkingDisplayMode": { "enum": [ "summarized", "omitted" ], "title": "ThinkingDisplayMode", "type": "string" }, "WebSearchToolResultErrorCode": { "enum": [ "invalid_tool_input", "unavailable", "max_uses_exceeded", "too_many_requests", "query_too_long", "request_too_large" ], "title": "WebSearchToolResultErrorCode", "type": "string" }, "WebFetchToolResultErrorCode": { "enum": [ "invalid_tool_input", "url_too_long", "url_not_allowed", "url_not_accessible", "unsupported_content_type", "too_many_requests", "max_uses_exceeded", "unavailable" ], "title": "WebFetchToolResultErrorCode", "type": "string" }, "ResponseDocumentBlock": { "properties": { "citations": { "anyOf": [ { "$ref": "#/components/schemas/ResponseCitationsConfig" }, { "type": "null", "title": "null" } ], "default": null, "description": "Citation configuration for the document" }, "source": { "discriminator": { "mapping": { "base64": "#/components/schemas/Base64PDFSource", "text": "#/components/schemas/PlainTextSource" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/Base64PDFSource" }, { "$ref": "#/components/schemas/PlainTextSource" } ], "title": "Source" }, "title": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "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" }, "CodeExecutionToolResultErrorCode": { "enum": [ "invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded" ], "title": "CodeExecutionToolResultErrorCode", "type": "string" }, "ResponseCodeExecutionOutputBlock": { "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" }, "BashCodeExecutionToolResultErrorCode": { "enum": [ "invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded", "output_file_too_large" ], "title": "BashCodeExecutionToolResultErrorCode", "type": "string" }, "ResponseBashCodeExecutionOutputBlock": { "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" }, "TextEditorCodeExecutionToolResultErrorCode": { "enum": [ "invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded", "file_not_found" ], "title": "TextEditorCodeExecutionToolResultErrorCode", "type": "string" }, "ToolSearchToolResultErrorCode": { "enum": [ "invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded" ], "title": "ToolSearchToolResultErrorCode", "type": "string" }, "ResponseToolReferenceBlock": { "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" }, "Base64ImageSource": { "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" }, "URLImageSource": { "additionalProperties": false, "properties": { "type": { "const": "url", "title": "Type", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "type", "url" ], "title": "URLImageSource", "type": "object" }, "Base64PDFSource": { "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" }, "PlainTextSource": { "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" }, "ContentBlockSource": { "additionalProperties": false, "properties": { "content": { "anyOf": [ { "type": "string", "title": "string" }, { "items": { "discriminator": { "mapping": { "image": "#/components/schemas/RequestImageBlock", "text": "#/components/schemas/RequestTextBlock" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/RequestTextBlock" }, { "$ref": "#/components/schemas/RequestImageBlock" } ], "x-stainless-naming": { "go": { "type_name": "ContentBlockSourceContentItem" } }, "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" }, "URLPDFSource": { "additionalProperties": false, "properties": { "type": { "const": "url", "title": "Type", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "type", "url" ], "title": "URLPDFSource", "type": "object" }, "RequestToolReferenceBlock": { "additionalProperties": false, "description": "Tool reference block that can be included in tool_result content.", "properties": { "cache_control": { "anyOf": [ { "discriminator": { "mapping": { "ephemeral": "#/components/schemas/CacheControlEphemeral" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/CacheControlEphemeral" } ] }, { "type": "null", "title": "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" }, "RequestWebSearchResultBlock": { "additionalProperties": false, "properties": { "encrypted_content": { "title": "Encrypted Content", "type": "string" }, "page_age": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "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" }, "RequestWebSearchToolResultError": { "additionalProperties": false, "properties": { "error_code": { "$ref": "#/components/schemas/WebSearchToolResultErrorCode" }, "type": { "const": "web_search_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "type" ], "title": "RequestWebSearchToolResultError", "type": "object" }, "RequestWebFetchToolResultError": { "additionalProperties": false, "properties": { "error_code": { "$ref": "#/components/schemas/WebFetchToolResultErrorCode" }, "type": { "const": "web_fetch_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "type" ], "title": "RequestWebFetchToolResultError", "type": "object" }, "RequestWebFetchResultBlock": { "additionalProperties": false, "properties": { "content": { "$ref": "#/components/schemas/RequestDocumentBlock" }, "retrieved_at": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "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" }, "RequestCodeExecutionToolResultError": { "additionalProperties": false, "properties": { "error_code": { "$ref": "#/components/schemas/CodeExecutionToolResultErrorCode" }, "type": { "const": "code_execution_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "type" ], "title": "RequestCodeExecutionToolResultError", "type": "object" }, "RequestCodeExecutionResultBlock": { "additionalProperties": false, "properties": { "content": { "items": { "$ref": "#/components/schemas/RequestCodeExecutionOutputBlock" }, "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" }, "RequestEncryptedCodeExecutionResultBlock": { "additionalProperties": false, "description": "Code execution result with encrypted stdout for PFC + web_search results.", "properties": { "content": { "items": { "$ref": "#/components/schemas/RequestCodeExecutionOutputBlock" }, "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" }, "RequestBashCodeExecutionToolResultError": { "additionalProperties": false, "properties": { "error_code": { "$ref": "#/components/schemas/BashCodeExecutionToolResultErrorCode" }, "type": { "const": "bash_code_execution_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "type" ], "title": "RequestBashCodeExecutionToolResultError", "type": "object" }, "RequestBashCodeExecutionResultBlock": { "additionalProperties": false, "properties": { "content": { "items": { "$ref": "#/components/schemas/RequestBashCodeExecutionOutputBlock" }, "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" }, "RequestTextEditorCodeExecutionToolResultError": { "additionalProperties": false, "properties": { "error_code": { "$ref": "#/components/schemas/TextEditorCodeExecutionToolResultErrorCode" }, "error_message": { "anyOf": [ { "type": "string", "title": "string" }, { "type": "null", "title": "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" }, "RequestTextEditorCodeExecutionViewResultBlock": { "additionalProperties": false, "properties": { "content": { "title": "Content", "type": "string" }, "file_type": { "enum": [ "text", "image", "pdf" ], "title": "File Type", "type": "string" }, "num_lines": { "anyOf": [ { "type": "integer", "title": "integer" }, { "type": "null", "title": "null" } ], "title": "Num Lines" }, "start_line": { "anyOf": [ { "type": "integer", "title": "integer" }, { "type": "null", "title": "null" } ], "title": "Start Line" }, "total_lines": { "anyOf": [ { "type": "integer", "title": "integer" }, { "type": "null", "title": "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" }, "RequestTextEditorCodeExecutionCreateResultBlock": { "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" }, "RequestTextEditorCodeExecutionStrReplaceResultBlock": { "additionalProperties": false, "properties": { "lines": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "title": "array" }, { "type": "null", "title": "null" } ], "title": "Lines" }, "new_lines": { "anyOf": [ { "type": "integer", "title": "integer" }, { "type": "null", "title": "null" } ], "title": "New Lines" }, "new_start": { "anyOf": [ { "type": "integer", "title": "integer" }, { "type": "null", "title": "null" } ], "title": "New Start" }, "old_lines": { "anyOf": [ { "type": "integer", "title": "integer" }, { "type": "null", "title": "null" } ], "title": "Old Lines" }, "old_start": { "anyOf": [ { "type": "integer", "title": "integer" }, { "type": "null", "title": "null" } ], "title": "Old Start" }, "type": { "const": "text_editor_code_execution_str_replace_result", "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "RequestTextEditorCodeExecutionStrReplaceResultBlock", "type": "object" }, "RequestToolSearchToolResultError": { "additionalProperties": false, "properties": { "error_code": { "$ref": "#/components/schemas/ToolSearchToolResultErrorCode" }, "type": { "const": "tool_search_tool_result_error", "title": "Type", "type": "string" } }, "required": [ "error_code", "type" ], "title": "RequestToolSearchToolResultError", "type": "object" }, "RequestToolSearchToolSearchResultBlock": { "additionalProperties": false, "properties": { "tool_references": { "items": { "$ref": "#/components/schemas/RequestToolReferenceBlock" }, "title": "Tool References", "type": "array" }, "type": { "const": "tool_search_tool_search_result", "title": "Type", "type": "string" } }, "required": [ "tool_references", "type" ], "title": "RequestToolSearchToolSearchResultBlock", "type": "object" }, "ResponseCitationsConfig": { "properties": { "enabled": { "default": false, "title": "Enabled", "type": "boolean" } }, "required": [ "enabled" ], "title": "ResponseCitationsConfig", "type": "object" }, "RequestCodeExecutionOutputBlock": { "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" }, "RequestBashCodeExecutionOutputBlock": { "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-openapi": "https://storage.googleapis.com/stainless-sdk-openapi-specs/anthropic%2Fanthropic-6811827071199207cf69c4e64cae1b41e7e74cdb14048e9c748701e474c694a7.yml", "x-filtered-paths": [ "/v1/messages", "/v1/messages/count_tokens" ], "x-filtered-operation-count": 2, "x-filtered-schema-count": 151 } ```