--- title: Messages url: https://platform.claude.com/docs/en/api/typescript/messages --- # Messages ## Create a Message `client.messages.create(params, options?): Message | Stream` **POST** `/v1/messages` 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://platform.claude.com/docs/en/get-started?sdk_languages=typescript) ### Parameters - `params: MessageCreateParams` - `max_tokens: number` The maximum number of tokens to generate before stopping. Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=typescript) for details. minimum: 0 - `messages: Array` Input messages. Our 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. Each 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. If 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. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=typescript#prefill-not-supported). Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude, for models that support prefill: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each 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: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=typescript). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=typescript#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `content: string | Array` - `string` - `Array` - `interface TextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `citations?: Array | null` - `interface CitationCharLocationParam` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `interface CitationPageLocationParam` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocationParam` - `type: "content_block_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationWebSearchResultLocationParam` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string | null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `interface CitationSearchResultLocationParam` - `type: "search_result_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `interface ImageBlockParam` - `type: "image"` - `source: Base64ImageSource | URLImageSource | FileImageSource` - `interface Base64ImageSource` - `type: "base64"` - `data: string` format: byte - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `interface URLImageSource` - `type: "url"` - `url: string` - `interface FileImageSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `transformations?: ImageTransformationsParam | null` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `oversized_image?: "downsize" | "error"` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `"downsize"` - `"error"` - `interface DocumentBlockParam` - `type: "document"` - `source: Base64PDFSource | PlainTextSource | ContentBlockSource | 2 more` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `interface ContentBlockSource` - `type: "content"` - `content: string | Array` - `string` - `Array` - `interface TextBlockParam` - `interface ImageBlockParam` - `interface URLPDFSource` - `type: "url"` - `url: string` - `interface FileDocumentSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` - `enabled?: boolean` - `context?: string | null` minLength: 1 - `title?: string | null` minLength: 1, maxLength: 500 - `interface SearchResultBlockParam` - `type: "search_result"` - `content: Array` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `source: string` - `title: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam` - `interface ThinkingBlockParam` - `type: "thinking"` - `signature: string` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `thinking: string` The `thinking` text of this block as returned by the API. - `interface RedactedThinkingBlockParam` - `type: "redacted_thinking"` - `data: string` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `interface ToolUseBlockParam` - `type: "tool_use"` - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `input: Record` - `name: string` minLength: 1, maxLength: 200 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `toolset_name?: string | null` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ToolResultBlockParam` - `type: "tool_result"` - `tool_use_id: string` pattern: ^[a-zA-Z0-9_-]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | Array` - `string` - `Array` - `interface TextBlockParam` - `interface ImageBlockParam` - `interface SearchResultBlockParam` - `interface DocumentBlockParam` - `interface ToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface BrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `type: "browser_state"` - `tabs: Array` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `tab_id: string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `title: string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `active?: boolean` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `state_changes?: Array | null` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `interface BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `type: "tab_opened"` - `tab_id: string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `interface BrowserStateChangeDownloadStarted` A file download that started during this call. - `type: "download_started"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `interface BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `type: "download_completed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path?: string | null` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `size_bytes?: number | null` The completed download's size. minimum: 0 - `interface BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `type: "download_failed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `error?: string | null` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `is_error?: boolean` - `toolset_name?: string | null` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ServerToolUseBlockParam` - `type: "server_tool_use"` - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: Record` - `name: "web_search" | "web_fetch" | "code_execution" | 4 more` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `interface WebSearchToolResultBlockParam` - `type: "web_search_tool_result"` - `content: WebSearchToolResultBlockParamContent` - `Array` - `type: "web_search_result"` - `encrypted_content: string` - `title: string` - `url: string` - `page_age?: string | null` - `interface WebSearchToolRequestError` - `type: "web_search_tool_result_error"` - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `interface WebFetchToolResultBlockParam` - `type: "web_fetch_tool_result"` - `content: WebFetchToolResultErrorBlockParam | WebFetchBlockParam` - `interface WebFetchToolResultErrorBlockParam` - `type: "web_fetch_tool_result_error"` - `error_code: WebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `interface WebFetchBlockParam` - `type: "web_fetch_result"` - `content: DocumentBlockParam` - `url: string` Fetched content URL - `retrieved_at?: string | null` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `interface CodeExecutionToolResultBlockParam` - `type: "code_execution_tool_result"` - `content: CodeExecutionToolResultBlockParamContent` - `interface CodeExecutionToolResultErrorParam` - `type: "code_execution_tool_result_error"` - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `interface CodeExecutionResultBlockParam` - `type: "code_execution_result"` - `content: Array` - `type: "code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `interface EncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` - `content: Array` - `type: "code_execution_output"` - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface BashCodeExecutionToolResultBlockParam` - `type: "bash_code_execution_tool_result"` - `content: BashCodeExecutionToolResultErrorParam | BashCodeExecutionResultBlockParam` - `interface BashCodeExecutionToolResultErrorParam` - `type: "bash_code_execution_tool_result_error"` - `error_code: BashCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `interface BashCodeExecutionResultBlockParam` - `type: "bash_code_execution_result"` - `content: Array` - `type: "bash_code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface TextEditorCodeExecutionToolResultBlockParam` - `type: "text_editor_code_execution_tool_result"` - `content: TextEditorCodeExecutionToolResultErrorParam | TextEditorCodeExecutionViewResultBlockParam | TextEditorCodeExecutionCreateResultBlockParam | TextEditorCodeExecutionStrReplaceResultBlockParam` - `interface TextEditorCodeExecutionToolResultErrorParam` - `type: "text_editor_code_execution_tool_result_error"` - `error_code: TextEditorCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message?: string | null` - `interface TextEditorCodeExecutionViewResultBlockParam` - `type: "text_editor_code_execution_view_result"` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines?: number | null` - `start_line?: number | null` - `total_lines?: number | null` - `interface TextEditorCodeExecutionCreateResultBlockParam` - `type: "text_editor_code_execution_create_result"` - `is_file_update: boolean` - `interface TextEditorCodeExecutionStrReplaceResultBlockParam` - `type: "text_editor_code_execution_str_replace_result"` - `lines?: Array | null` - `new_lines?: number | null` - `new_start?: number | null` - `old_lines?: number | null` - `old_start?: number | null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface ToolSearchToolResultBlockParam` - `type: "tool_search_tool_result"` - `content: ToolSearchToolResultErrorParam | ToolSearchToolSearchResultBlockParam` - `interface ToolSearchToolResultErrorParam` - `type: "tool_search_tool_result_error"` - `error_code: ToolSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message?: string | null` - `interface ToolSearchToolSearchResultBlockParam` - `type: "tool_search_tool_search_result"` - `tool_references: Array` - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface ContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `type: "container_upload"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `role: "user" | "assistant" | "system"` - `"user"` - `"assistant"` - `"system"` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-mythos-5"` Most capable model for cybersecurity and biology research - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `(string & {})` - `cache_control?: CacheControlEphemeral | null` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `container?: MessageCreateParamsContainer | null` Container identifier for reuse across requests. - `interface ContainerParams` Container parameters with skills to be loaded. - `id?: string | null` Container id - `skills?: Array | null` List of skills to load in the container maxItems: 20 - `type: "anthropic" | "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version?: string` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 - `string` - `diagnostics?: DiagnosticsParam | null` Request-level diagnostics. Supply `previous_message_id` to have the response include `diagnostics.cache_miss_reason` explaining any prompt-cache divergence from that prior request. - `previous_message_id?: string | null` The `id` (`msg_...`) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns `diagnostics.cache_miss_reason` when the prompt-cache prefix could not be reused. Pass `null` on the first turn to opt in without a prior message to compare. maxLength: 256 - `inference_geo?: string | null` Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. - `metadata?: Metadata` An object describing metadata about the request. - `user_id?: string | null` An external identifier for the user who is associated with the request. This 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. maxLength: 512 - `output_config?: OutputConfig` Configuration options for the model's output, such as the output format. - `effort?: "low" | "medium" | "high" | 2 more | null` How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `"max"` - `format?: JSONOutputFormat | null` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=typescript) - `type: "json_schema"` - `schema: Record` The JSON schema of the format - `service_tier?: "auto" | "standard_only"` Determines whether to use priority capacity (if available) or standard capacity for this request. Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers?sdk_languages=typescript) for details. - `"auto"` - `"standard_only"` - `stop_sequences?: Array` Custom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`. If 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. - `stream?: boolean` Whether to incrementally stream the response using server-sent events. When `true`, SDKs return a raw event stream. In the TypeScript, Python and Ruby SDKs, the recommended way to stream is `messages.stream()`. It sets `stream` for you and accumulates the events into the final message. See [Streaming with SDKs](https://platform.claude.com/docs/en/build-with-claude/streaming?sdk_languages=typescript#streaming-with-sdks) for an example in each language. - `system?: string | Array` System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=typescript#give-claude-a-role). - `string` - `Array` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `thinking?: ThinkingConfigParam` Configuration for Claude's thinking. With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit. Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=typescript#configuring-thinking) for each model's behavior. - `interface ThinkingConfigEnabled` - `type: "enabled"` - `budget_tokens: number` 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. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript) for details. minimum: 1024 - `display?: "summarized" | "omitted" | null` 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. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=typescript#controlling-thinking-display). - `"summarized"` - `"omitted"` - `interface ThinkingConfigDisabled` - `type: "disabled"` - `interface ThinkingConfigBetweenTools` - `type: "between_tools"` - `interface ThinkingConfigAdaptive` - `type: "adaptive"` - `display?: "summarized" | "omitted" | null` 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. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=typescript#controlling-thinking-display). - `"summarized"` - `"omitted"` - `tool_choice?: ToolChoice` 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. - `interface ToolChoiceAuto` The model will automatically decide whether to use tools. - `type: "auto"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `interface ToolChoiceAny` The model will use any available tools. - `type: "any"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `interface ToolChoiceTool` The model will use the specified tool with `tool_choice.name`. - `type: "tool"` - `name: string` The name of the tool to use. - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `interface ToolChoiceNone` The model will not be allowed to use tools. - `type: "none"` - `tools?: Array` Definitions of tools that the model may use. If 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. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=typescript), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=typescript)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `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. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And 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: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You 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: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools 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. See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=typescript) for more details. - `interface Tool` - `type?: "custom" | null` - `input_schema: InputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `type: "object"` - `properties?: Record | null` - `required?: Array | null` - `name: string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `description?: string` Description of what this tool does. Tool 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. - `eager_input_streaming?: boolean | null` 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. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolBash20250124` - `type: "bash_20250124"` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20250522` - `type: "code_execution_20250522"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20250825` - `type: "code_execution_20250825"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `type: "code_execution_20260120"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20260521` Code execution tool with REPL state persistence. - `type: "code_execution_20260521"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface BrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `type: "browser_toolset_20260801"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `configs?: BrowserToolsetConfigs | null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type?: BrowserTypeConfig | null` `type`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `close_tab?: BrowserCloseTabConfig | null` `close_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click?: BrowserDoubleClickConfig | null` `double_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `file_upload?: BrowserFileUploadConfig | null` `file_upload`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `find?: BrowserFindConfig | null` `find`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `form_input?: BrowserFormInputConfig | null` `form_input`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `get_page_text?: BrowserGetPageTextConfig | null` `get_page_text`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key?: BrowserHoldKeyConfig | null` `hold_key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hover?: BrowserHoverConfig | null` `hover`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `javascript_exec?: BrowserJavascriptExecConfig | null` `javascript_exec`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key?: BrowserKeyConfig | null` `key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click?: BrowserLeftClickConfig | null` `left_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag?: BrowserLeftClickDragConfig | null` `left_click_drag`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down?: BrowserLeftMouseDownConfig | null` `left_mouse_down`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up?: BrowserLeftMouseUpConfig | null` `left_mouse_up`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `list_tabs?: BrowserListTabsConfig | null` `list_tabs`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click?: BrowserMiddleClickConfig | null` `middle_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move?: BrowserMouseMoveConfig | null` `mouse_move`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `navigate?: BrowserNavigateConfig | null` `navigate`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `new_tab?: BrowserNewTabConfig | null` `new_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_console?: BrowserReadConsoleConfig | null` `read_console`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_network?: BrowserReadNetworkConfig | null` `read_network`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_page?: BrowserReadPageConfig | null` `read_page`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click?: BrowserRightClickConfig | null` `right_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot?: BrowserScreenshotConfig | null` `screenshot`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll?: BrowserScrollConfig | null` `scroll`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll_to?: BrowserScrollToConfig | null` `scroll_to`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `switch_tab?: BrowserSwitchTabConfig | null` `switch_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click?: BrowserTripleClickConfig | null` `triple_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait?: BrowserWaitConfig | null` `wait`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom?: BrowserZoomConfig | null` `zoom`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `interface MemoryTool20250818` - `type: "memory_20250818"` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `type: "computer_toolset_20260801"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `configs?: ComputerToolsetConfigs | null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type?: ComputerTypeConfig | null` `type`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `cursor_position?: ComputerCursorPositionConfig | null` `cursor_position`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click?: ComputerDoubleClickConfig | null` `double_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key?: ComputerHoldKeyConfig | null` `hold_key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key?: ComputerKeyConfig | null` `key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click?: ComputerLeftClickConfig | null` `left_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag?: ComputerLeftClickDragConfig | null` `left_click_drag`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down?: ComputerLeftMouseDownConfig | null` `left_mouse_down`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up?: ComputerLeftMouseUpConfig | null` `left_mouse_up`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click?: ComputerMiddleClickConfig | null` `middle_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move?: ComputerMouseMoveConfig | null` `mouse_move`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click?: ComputerRightClickConfig | null` `right_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot?: ComputerScreenshotConfig | null` `screenshot`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll?: ComputerScrollConfig | null` `scroll`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click?: ComputerTripleClickConfig | null` `triple_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait?: ComputerWaitConfig | null` `wait`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom?: ComputerZoomConfig | null` `zoom`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `interface ToolTextEditor20250124` - `type: "text_editor_20250124"` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolTextEditor20250429` - `type: "text_editor_20250429"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolTextEditor20250728` - `type: "text_editor_20250728"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `max_characters?: number | null` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface WebSearchTool20250305` - `type: "web_search_20250305"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city?: string | null` The city of the user. minLength: 1, maxLength: 255 - `country?: string | null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `region?: string | null` The region of the user. minLength: 1, maxLength: 255 - `timezone?: string | null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `interface WebFetchTool20250910` - `type: "web_fetch_20250910"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `client_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type: "all"` - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type: "none"` - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type: "only"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `type: "except"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `server_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `user_input?: WebFetchURLSourceAll | WebFetchURLSourceNone` Whether URLs in user messages are fetchable: "all" or "none". - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `interface WebSearchTool20260209` - `type: "web_search_20260209"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `interface WebFetchTool20260209` - `type: "web_fetch_20260209"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `interface WebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `type: "web_fetch_20260309"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache?: boolean` 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. - `interface WebSearchTool20260318` - `type: "web_search_20260318"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion?: "full" | "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `interface WebFetchTool20260318` - `type: "web_fetch_20260318"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion?: "full" | "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache?: boolean` 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. - `interface ToolSearchToolBm25_20251119` - `type: "tool_search_tool_bm25_20251119" | "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `name: "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolSearchToolRegex20251119` - `type: "tool_search_tool_regex_20251119" | "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `name: "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_profile_id?: string` (header parameter) The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. - `workspace_id?: string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. - `temperature?: number` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. Amount of randomness injected into the response. Defaults 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. Note that even with `temperature` of `0.0`, the results will not be fully deterministic. minimum: 0, maximum: 1 - `top_k?: number` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error. Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). Recommended for advanced use cases only. minimum: 0 - `top_p?: number` **Deprecated**: 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. Use nucleus sampling. In 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`. Recommended for advanced use cases only. minimum: 0, maximum: 1 ### Returns - When `stream` is `false` or omitted: `interface Message` - `type: "message"` Object type. For Messages, this is always `"message"`. default: message - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: Container | null` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. format: date-time - `skills: Array | null` Skills loaded in the container - `type: "anthropic" | "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version: string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `content: Array` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If 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. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `interface TextBlock` - `type: "text"` default: text - `citations: Array | null` Citations supporting the text block. The 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`. - `interface CitationCharLocation` - `type: "char_location"` default: char_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` minimum: 0 - `interface CitationPageLocation` - `type: "page_location"` default: page_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocation` - `type: "content_block_location"` default: content_block_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `file_id: string | null` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationsWebSearchResultLocation` - `type: "web_search_result_location"` default: web_search_result_location - `cited_text: string` - `encrypted_index: string` - `title: string | null` maxLength: 512 - `url: string` - `interface CitationsSearchResultLocation` - `type: "search_result_location"` default: search_result_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `text: string` - `interface ThinkingBlock` - `type: "thinking"` default: thinking - `signature: string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript) for details. - `thinking: string` The text of Claude's thinking process for this block. - `interface RedactedThinkingBlock` - `type: "redacted_thinking"` default: redacted_thinking - `data: string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript#redacted-thinking-blocks) for details. - `interface ToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: Record` - `name: string` minLength: 1 - `toolset_name?: string | null` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ServerToolUseBlock` - `type: "server_tool_use"` default: server_tool_use - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `input: Record` - `name: "web_search" | "web_fetch" | "code_execution" | 4 more` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `interface WebSearchToolResultBlock` - `type: "web_search_tool_result"` default: web_search_tool_result - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `content: WebSearchToolResultBlockContent` - `interface WebSearchToolResultError` - `type: "web_search_tool_result_error"` default: web_search_tool_result_error - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `Array` - `type: "web_search_result"` default: web_search_result - `encrypted_content: string` - `page_age: string | null` - `title: string` - `url: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface WebFetchToolResultBlock` - `type: "web_fetch_tool_result"` default: web_fetch_tool_result - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `content: WebFetchToolResultErrorBlock | WebFetchBlock` - `interface WebFetchToolResultErrorBlock` - `type: "web_fetch_tool_result_error"` default: web_fetch_tool_result_error - `error_code: WebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `interface WebFetchBlock` - `type: "web_fetch_result"` default: web_fetch_result - `content: DocumentBlock` - `type: "document"` default: document - `citations: CitationsConfig | null` Citation configuration for the document - `enabled: boolean` default: false - `source: Base64PDFSource | PlainTextSource` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `title: string | null` The title of the document - `retrieved_at: string | null` ISO 8601 timestamp when the content was retrieved - `url: string` Fetched content URL - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface CodeExecutionToolResultBlock` - `type: "code_execution_tool_result"` default: code_execution_tool_result - `content: CodeExecutionToolResultBlockContent` - `interface CodeExecutionToolResultError` - `type: "code_execution_tool_result_error"` default: code_execution_tool_result_error - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `interface CodeExecutionResultBlock` - `type: "code_execution_result"` default: code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `interface EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` default: encrypted_code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface BashCodeExecutionToolResultBlock` - `type: "bash_code_execution_tool_result"` default: bash_code_execution_tool_result - `content: BashCodeExecutionToolResultError | BashCodeExecutionResultBlock` - `interface BashCodeExecutionToolResultError` - `type: "bash_code_execution_tool_result_error"` default: bash_code_execution_tool_result_error - `error_code: BashCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `interface BashCodeExecutionResultBlock` - `type: "bash_code_execution_result"` default: bash_code_execution_result - `content: Array` - `type: "bash_code_execution_output"` default: bash_code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface TextEditorCodeExecutionToolResultBlock` - `type: "text_editor_code_execution_tool_result"` default: text_editor_code_execution_tool_result - `content: TextEditorCodeExecutionToolResultError | TextEditorCodeExecutionViewResultBlock | TextEditorCodeExecutionCreateResultBlock | TextEditorCodeExecutionStrReplaceResultBlock` - `interface TextEditorCodeExecutionToolResultError` - `type: "text_editor_code_execution_tool_result_error"` default: text_editor_code_execution_tool_result_error - `error_code: TextEditorCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message: string | null` - `interface TextEditorCodeExecutionViewResultBlock` - `type: "text_editor_code_execution_view_result"` default: text_editor_code_execution_view_result - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `interface TextEditorCodeExecutionCreateResultBlock` - `type: "text_editor_code_execution_create_result"` default: text_editor_code_execution_create_result - `is_file_update: boolean` - `interface TextEditorCodeExecutionStrReplaceResultBlock` - `type: "text_editor_code_execution_str_replace_result"` default: text_editor_code_execution_str_replace_result - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ToolSearchToolResultBlock` - `type: "tool_search_tool_result"` default: tool_search_tool_result - `content: ToolSearchToolResultError | ToolSearchToolSearchResultBlock` - `interface ToolSearchToolResultError` - `type: "tool_search_tool_result_error"` default: tool_search_tool_result_error - `error_code: ToolSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message: string | null` - `interface ToolSearchToolSearchResultBlock` - `type: "tool_search_tool_search_result"` default: tool_search_tool_search_result - `tool_references: Array` - `type: "tool_reference"` default: tool_reference - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ContainerUploadBlock` Response model for a file uploaded to the container. - `type: "container_upload"` default: container_upload - `file_id: string` - `diagnostics: Diagnostics | null` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `cache_miss_reason: CacheMissReason | null` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `interface CacheMissModelChanged` - `type: "model_changed"` default: model_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissSystemChanged` - `type: "system_changed"` default: system_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissToolsChanged` - `type: "tools_changed"` default: tools_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissMessagesChanged` - `type: "messages_changed"` default: messages_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissPreviousMessageNotFound` - `type: "previous_message_not_found"` default: previous_message_not_found - `interface CacheMissUnavailable` - `type: "unavailable"` default: unavailable - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-mythos-5"` Most capable model for cybersecurity and biology research - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `(string & {})` - `role: "assistant"` Conversational role of the generated message. This will always be `"assistant"`. default: assistant - `stop_details: RefusalStopDetails | null` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `type: "refusal"` default: refusal - `category: "cyber" | "bio" | "frontier_llm" | 2 more | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `"bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `"frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `"reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=typescript). - `"general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `explanation: string | null` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `stop_reason: StopReason | null` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"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. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations * `"model_context_window_exceeded"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string | null` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `usage: Usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under 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. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `cache_creation: CacheCreation | null` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `cache_creation_input_tokens: number | null` The number of input tokens used to create the cache entry. minimum: 0 - `cache_read_input_tokens: number | null` The number of input tokens read from the cache. minimum: 0 - `inference_geo: string | null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. minimum: 0 - `output_tokens: number` The number of output tokens which were used. minimum: 0 - `output_tokens_details: OutputTokensDetails | null` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `thinking_tokens: number` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. default: 0, minimum: 0 - `server_tool_use: ServerToolUsage | null` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. default: 0, minimum: 0 - `web_search_requests: number` The number of web search tool requests. default: 0, minimum: 0 - `service_tier: "standard" | "priority" | "batch" | null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - When `stream` is `true`: `Stream` - `interface RawMessageStartEvent` - `type: "message_start"` default: message_start - `message: Message` - `interface RawMessageDeltaEvent` - `type: "message_delta"` default: message_delta - `delta: Delta` - `container: Container | null` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `stop_details: RefusalStopDetails | null` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `stop_reason: StopReason | null` - `stop_sequence: string | null` - `usage: MessageDeltaUsage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under 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. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `cache_creation_input_tokens: number | null` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `cache_read_input_tokens: number | null` The cumulative number of input tokens read from the cache. minimum: 0 - `input_tokens: number | null` The cumulative number of input tokens which were used. minimum: 0 - `output_tokens: number` The cumulative number of output tokens which were used. - `output_tokens_details: OutputTokensDetails | null` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `server_tool_use: ServerToolUsage | null` The number of server tool requests. - `interface RawMessageStopEvent` - `type: "message_stop"` default: message_stop - `interface RawContentBlockStartEvent` - `type: "content_block_start"` default: content_block_start - `content_block: TextBlock | ThinkingBlock | RedactedThinkingBlock | 9 more` - `interface TextBlock` - `interface ThinkingBlock` - `interface RedactedThinkingBlock` - `interface ToolUseBlock` - `interface ServerToolUseBlock` - `interface WebSearchToolResultBlock` - `interface WebFetchToolResultBlock` - `interface CodeExecutionToolResultBlock` - `interface BashCodeExecutionToolResultBlock` - `interface TextEditorCodeExecutionToolResultBlock` - `interface ToolSearchToolResultBlock` - `interface ContainerUploadBlock` Response model for a file uploaded to the container. - `index: number` - `interface RawContentBlockDeltaEvent` - `type: "content_block_delta"` default: content_block_delta - `delta: RawContentBlockDelta` - `interface TextDelta` - `type: "text_delta"` default: text_delta - `text: string` - `interface InputJSONDelta` - `type: "input_json_delta"` default: input_json_delta - `partial_json: string` - `interface CitationsDelta` - `type: "citations_delta"` default: citations_delta - `citation: CitationCharLocation | CitationPageLocation | CitationContentBlockLocation | 2 more` - `interface CitationCharLocation` - `interface CitationPageLocation` - `interface CitationContentBlockLocation` - `interface CitationsWebSearchResultLocation` - `interface CitationsSearchResultLocation` - `interface ThinkingDelta` - `type: "thinking_delta"` default: thinking_delta - `thinking: string` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. - `interface SignatureDelta` - `type: "signature_delta"` default: signature_delta - `signature: string` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. - `index: number` - `interface RawContentBlockStopEvent` - `type: "content_block_stop"` default: content_block_stop - `index: number` ### Example ```typescript import Anthropic from "@anthropic-ai/sdk"; const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); const message = await client.messages.create({ max_tokens: 1024, messages: [{ content: "Hello, world", role: "user" }], model: "claude-opus-5" }); console.log(message.id); ``` #### Response (200) ```json { "id": "msg_013Zva2CMHLNnXjNJJKqJ2EF", "container": { "id": "container_011CpZohnwH4vuy7gazohgSP", "expires_at": "2019-12-27T18:11:19.117Z", "skills": [ { "skill_id": "pdf", "type": "anthropic", "version": "latest" } ] }, "content": [ { "citations": [ { "cited_text": "The grass is green. The sky is blue.", "document_index": 0, "document_title": "My Document", "end_char_index": 0, "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "start_char_index": 0, "type": "char_location" } ], "text": "Hi! My name is Claude.", "type": "text" } ], "diagnostics": { "cache_miss_reason": { "cache_missed_input_tokens": 0, "type": "model_changed" } }, "model": "claude-opus-5", "role": "assistant", "stop_details": { "category": "cyber", "explanation": "This request was declined because it conflicts with Anthropic's Usage Policy.", "type": "refusal" }, "stop_reason": "end_turn", "stop_sequence": null, "type": "message", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_creation_input_tokens": 2051, "cache_read_input_tokens": 2051, "inference_geo": "global", "input_tokens": 2095, "output_tokens": 503, "output_tokens_details": { "thinking_tokens": 0 }, "server_tool_use": { "web_fetch_requests": 2, "web_search_requests": 0 }, "service_tier": "standard" } } ``` ## Count tokens in a Message `client.messages.countTokens(params, options?): MessageTokensCount` **POST** `/v1/messages/count_tokens` Count the number of tokens in a Message. The Token Count API can be used to count the number of tokens in a Message, including tools, images, and documents, without creating it. Learn more about token counting in our [user guide](https://platform.claude.com/docs/en/build-with-claude/token-counting?sdk_languages=typescript) ### Parameters - `params: MessageCountTokensParams` - `messages: Array` Input messages. Our 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. Each 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. If 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. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=typescript#prefill-not-supported). Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude, for models that support prefill: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each 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: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=typescript). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=typescript#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `content: string | Array` - `string` - `Array` - `interface TextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `citations?: Array | null` - `interface CitationCharLocationParam` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `interface CitationPageLocationParam` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocationParam` - `type: "content_block_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationWebSearchResultLocationParam` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string | null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `interface CitationSearchResultLocationParam` - `type: "search_result_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `interface ImageBlockParam` - `type: "image"` - `source: Base64ImageSource | URLImageSource | FileImageSource` - `interface Base64ImageSource` - `type: "base64"` - `data: string` format: byte - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `interface URLImageSource` - `type: "url"` - `url: string` - `interface FileImageSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `transformations?: ImageTransformationsParam | null` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `oversized_image?: "downsize" | "error"` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `"downsize"` - `"error"` - `interface DocumentBlockParam` - `type: "document"` - `source: Base64PDFSource | PlainTextSource | ContentBlockSource | 2 more` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `interface ContentBlockSource` - `type: "content"` - `content: string | Array` - `string` - `Array` - `interface TextBlockParam` - `interface ImageBlockParam` - `interface URLPDFSource` - `type: "url"` - `url: string` - `interface FileDocumentSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` - `enabled?: boolean` - `context?: string | null` minLength: 1 - `title?: string | null` minLength: 1, maxLength: 500 - `interface SearchResultBlockParam` - `type: "search_result"` - `content: Array` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `source: string` - `title: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam` - `interface ThinkingBlockParam` - `type: "thinking"` - `signature: string` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `thinking: string` The `thinking` text of this block as returned by the API. - `interface RedactedThinkingBlockParam` - `type: "redacted_thinking"` - `data: string` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `interface ToolUseBlockParam` - `type: "tool_use"` - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `input: Record` - `name: string` minLength: 1, maxLength: 200 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `toolset_name?: string | null` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ToolResultBlockParam` - `type: "tool_result"` - `tool_use_id: string` pattern: ^[a-zA-Z0-9_-]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | Array` - `string` - `Array` - `interface TextBlockParam` - `interface ImageBlockParam` - `interface SearchResultBlockParam` - `interface DocumentBlockParam` - `interface ToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface BrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `type: "browser_state"` - `tabs: Array` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `tab_id: string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `title: string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `active?: boolean` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `state_changes?: Array | null` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `interface BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `type: "tab_opened"` - `tab_id: string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `interface BrowserStateChangeDownloadStarted` A file download that started during this call. - `type: "download_started"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `interface BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `type: "download_completed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path?: string | null` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `size_bytes?: number | null` The completed download's size. minimum: 0 - `interface BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `type: "download_failed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `error?: string | null` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `is_error?: boolean` - `toolset_name?: string | null` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ServerToolUseBlockParam` - `type: "server_tool_use"` - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: Record` - `name: "web_search" | "web_fetch" | "code_execution" | 4 more` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `interface WebSearchToolResultBlockParam` - `type: "web_search_tool_result"` - `content: WebSearchToolResultBlockParamContent` - `Array` - `type: "web_search_result"` - `encrypted_content: string` - `title: string` - `url: string` - `page_age?: string | null` - `interface WebSearchToolRequestError` - `type: "web_search_tool_result_error"` - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `interface WebFetchToolResultBlockParam` - `type: "web_fetch_tool_result"` - `content: WebFetchToolResultErrorBlockParam | WebFetchBlockParam` - `interface WebFetchToolResultErrorBlockParam` - `type: "web_fetch_tool_result_error"` - `error_code: WebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `interface WebFetchBlockParam` - `type: "web_fetch_result"` - `content: DocumentBlockParam` - `url: string` Fetched content URL - `retrieved_at?: string | null` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `interface CodeExecutionToolResultBlockParam` - `type: "code_execution_tool_result"` - `content: CodeExecutionToolResultBlockParamContent` - `interface CodeExecutionToolResultErrorParam` - `type: "code_execution_tool_result_error"` - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `interface CodeExecutionResultBlockParam` - `type: "code_execution_result"` - `content: Array` - `type: "code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `interface EncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` - `content: Array` - `type: "code_execution_output"` - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface BashCodeExecutionToolResultBlockParam` - `type: "bash_code_execution_tool_result"` - `content: BashCodeExecutionToolResultErrorParam | BashCodeExecutionResultBlockParam` - `interface BashCodeExecutionToolResultErrorParam` - `type: "bash_code_execution_tool_result_error"` - `error_code: BashCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `interface BashCodeExecutionResultBlockParam` - `type: "bash_code_execution_result"` - `content: Array` - `type: "bash_code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface TextEditorCodeExecutionToolResultBlockParam` - `type: "text_editor_code_execution_tool_result"` - `content: TextEditorCodeExecutionToolResultErrorParam | TextEditorCodeExecutionViewResultBlockParam | TextEditorCodeExecutionCreateResultBlockParam | TextEditorCodeExecutionStrReplaceResultBlockParam` - `interface TextEditorCodeExecutionToolResultErrorParam` - `type: "text_editor_code_execution_tool_result_error"` - `error_code: TextEditorCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message?: string | null` - `interface TextEditorCodeExecutionViewResultBlockParam` - `type: "text_editor_code_execution_view_result"` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines?: number | null` - `start_line?: number | null` - `total_lines?: number | null` - `interface TextEditorCodeExecutionCreateResultBlockParam` - `type: "text_editor_code_execution_create_result"` - `is_file_update: boolean` - `interface TextEditorCodeExecutionStrReplaceResultBlockParam` - `type: "text_editor_code_execution_str_replace_result"` - `lines?: Array | null` - `new_lines?: number | null` - `new_start?: number | null` - `old_lines?: number | null` - `old_start?: number | null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface ToolSearchToolResultBlockParam` - `type: "tool_search_tool_result"` - `content: ToolSearchToolResultErrorParam | ToolSearchToolSearchResultBlockParam` - `interface ToolSearchToolResultErrorParam` - `type: "tool_search_tool_result_error"` - `error_code: ToolSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message?: string | null` - `interface ToolSearchToolSearchResultBlockParam` - `type: "tool_search_tool_search_result"` - `tool_references: Array` - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface ContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `type: "container_upload"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `role: "user" | "assistant" | "system"` - `"user"` - `"assistant"` - `"system"` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-mythos-5"` Most capable model for cybersecurity and biology research - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `(string & {})` - `cache_control?: CacheControlEphemeral | null` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `output_config?: OutputConfig` Configuration options for the model's output, such as the output format. - `effort?: "low" | "medium" | "high" | 2 more | null` How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `"max"` - `format?: JSONOutputFormat | null` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=typescript) - `type: "json_schema"` - `schema: Record` The JSON schema of the format - `system?: string | Array` System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=typescript#give-claude-a-role). - `string` - `Array` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `thinking?: ThinkingConfigParam` Configuration for Claude's thinking. With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit. Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=typescript#configuring-thinking) for each model's behavior. - `interface ThinkingConfigEnabled` - `type: "enabled"` - `budget_tokens: number` 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. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript) for details. minimum: 1024 - `display?: "summarized" | "omitted" | null` 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. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=typescript#controlling-thinking-display). - `"summarized"` - `"omitted"` - `interface ThinkingConfigDisabled` - `type: "disabled"` - `interface ThinkingConfigBetweenTools` - `type: "between_tools"` - `interface ThinkingConfigAdaptive` - `type: "adaptive"` - `display?: "summarized" | "omitted" | null` 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. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=typescript#controlling-thinking-display). - `"summarized"` - `"omitted"` - `tool_choice?: ToolChoice` 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. - `interface ToolChoiceAuto` The model will automatically decide whether to use tools. - `type: "auto"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `interface ToolChoiceAny` The model will use any available tools. - `type: "any"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `interface ToolChoiceTool` The model will use the specified tool with `tool_choice.name`. - `type: "tool"` - `name: string` The name of the tool to use. - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `interface ToolChoiceNone` The model will not be allowed to use tools. - `type: "none"` - `tools?: Array` Definitions of tools that the model may use. If 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. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=typescript), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=typescript)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `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. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And 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: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You 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: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools 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. See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=typescript) for more details. - `interface Tool` - `type?: "custom" | null` - `input_schema: InputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `type: "object"` - `properties?: Record | null` - `required?: Array | null` - `name: string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `description?: string` Description of what this tool does. Tool 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. - `eager_input_streaming?: boolean | null` 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. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolBash20250124` - `type: "bash_20250124"` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20250522` - `type: "code_execution_20250522"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20250825` - `type: "code_execution_20250825"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `type: "code_execution_20260120"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20260521` Code execution tool with REPL state persistence. - `type: "code_execution_20260521"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface BrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `type: "browser_toolset_20260801"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `configs?: BrowserToolsetConfigs | null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type?: BrowserTypeConfig | null` `type`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `close_tab?: BrowserCloseTabConfig | null` `close_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click?: BrowserDoubleClickConfig | null` `double_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `file_upload?: BrowserFileUploadConfig | null` `file_upload`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `find?: BrowserFindConfig | null` `find`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `form_input?: BrowserFormInputConfig | null` `form_input`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `get_page_text?: BrowserGetPageTextConfig | null` `get_page_text`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key?: BrowserHoldKeyConfig | null` `hold_key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hover?: BrowserHoverConfig | null` `hover`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `javascript_exec?: BrowserJavascriptExecConfig | null` `javascript_exec`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key?: BrowserKeyConfig | null` `key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click?: BrowserLeftClickConfig | null` `left_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag?: BrowserLeftClickDragConfig | null` `left_click_drag`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down?: BrowserLeftMouseDownConfig | null` `left_mouse_down`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up?: BrowserLeftMouseUpConfig | null` `left_mouse_up`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `list_tabs?: BrowserListTabsConfig | null` `list_tabs`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click?: BrowserMiddleClickConfig | null` `middle_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move?: BrowserMouseMoveConfig | null` `mouse_move`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `navigate?: BrowserNavigateConfig | null` `navigate`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `new_tab?: BrowserNewTabConfig | null` `new_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_console?: BrowserReadConsoleConfig | null` `read_console`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_network?: BrowserReadNetworkConfig | null` `read_network`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_page?: BrowserReadPageConfig | null` `read_page`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click?: BrowserRightClickConfig | null` `right_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot?: BrowserScreenshotConfig | null` `screenshot`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll?: BrowserScrollConfig | null` `scroll`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll_to?: BrowserScrollToConfig | null` `scroll_to`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `switch_tab?: BrowserSwitchTabConfig | null` `switch_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click?: BrowserTripleClickConfig | null` `triple_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait?: BrowserWaitConfig | null` `wait`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom?: BrowserZoomConfig | null` `zoom`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `interface MemoryTool20250818` - `type: "memory_20250818"` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `type: "computer_toolset_20260801"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `configs?: ComputerToolsetConfigs | null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type?: ComputerTypeConfig | null` `type`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `cursor_position?: ComputerCursorPositionConfig | null` `cursor_position`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click?: ComputerDoubleClickConfig | null` `double_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key?: ComputerHoldKeyConfig | null` `hold_key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key?: ComputerKeyConfig | null` `key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click?: ComputerLeftClickConfig | null` `left_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag?: ComputerLeftClickDragConfig | null` `left_click_drag`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down?: ComputerLeftMouseDownConfig | null` `left_mouse_down`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up?: ComputerLeftMouseUpConfig | null` `left_mouse_up`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click?: ComputerMiddleClickConfig | null` `middle_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move?: ComputerMouseMoveConfig | null` `mouse_move`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click?: ComputerRightClickConfig | null` `right_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot?: ComputerScreenshotConfig | null` `screenshot`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll?: ComputerScrollConfig | null` `scroll`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click?: ComputerTripleClickConfig | null` `triple_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait?: ComputerWaitConfig | null` `wait`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom?: ComputerZoomConfig | null` `zoom`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `interface ToolTextEditor20250124` - `type: "text_editor_20250124"` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolTextEditor20250429` - `type: "text_editor_20250429"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolTextEditor20250728` - `type: "text_editor_20250728"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `max_characters?: number | null` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface WebSearchTool20250305` - `type: "web_search_20250305"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city?: string | null` The city of the user. minLength: 1, maxLength: 255 - `country?: string | null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `region?: string | null` The region of the user. minLength: 1, maxLength: 255 - `timezone?: string | null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `interface WebFetchTool20250910` - `type: "web_fetch_20250910"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `client_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type: "all"` - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type: "none"` - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type: "only"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `type: "except"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `server_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `user_input?: WebFetchURLSourceAll | WebFetchURLSourceNone` Whether URLs in user messages are fetchable: "all" or "none". - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `interface WebSearchTool20260209` - `type: "web_search_20260209"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `interface WebFetchTool20260209` - `type: "web_fetch_20260209"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `interface WebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `type: "web_fetch_20260309"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache?: boolean` 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. - `interface WebSearchTool20260318` - `type: "web_search_20260318"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion?: "full" | "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `interface WebFetchTool20260318` - `type: "web_fetch_20260318"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion?: "full" | "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache?: boolean` 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. - `interface ToolSearchToolBm25_20251119` - `type: "tool_search_tool_bm25_20251119" | "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `name: "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolSearchToolRegex20251119` - `type: "tool_search_tool_regex_20251119" | "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `name: "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_profile_id?: string` (header parameter) The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. - `workspace_id?: string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `interface MessageTokensCount` - `input_tokens: number` The total number of tokens across the provided list of messages, system prompt, and tools. ### Example ```typescript import Anthropic from "@anthropic-ai/sdk"; const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); const messageTokensCount = await client.messages.countTokens({ messages: [{ content: "Hello, world", role: "user" }], model: "claude-opus-5" }); console.log(messageTokensCount.input_tokens); ``` #### Response (200) ```json { "input_tokens": 2095 } ``` ## Domain types ### Base64 Image Source - `interface Base64ImageSource` - `type: "base64"` - `data: string` format: byte - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` ### Base64 PDF Source - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` ### Bash Code Execution Output Block - `interface BashCodeExecutionOutputBlock` - `type: "bash_code_execution_output"` default: bash_code_execution_output - `file_id: string` ### Bash Code Execution Output Block Param - `interface BashCodeExecutionOutputBlockParam` - `type: "bash_code_execution_output"` - `file_id: string` ### Bash Code Execution Result Block - `interface BashCodeExecutionResultBlock` - `type: "bash_code_execution_result"` default: bash_code_execution_result - `content: Array` - `type: "bash_code_execution_output"` default: bash_code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` ### Bash Code Execution Result Block Param - `interface BashCodeExecutionResultBlockParam` - `type: "bash_code_execution_result"` - `content: Array` - `type: "bash_code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` ### Bash Code Execution Tool Result Block - `interface BashCodeExecutionToolResultBlock` - `type: "bash_code_execution_tool_result"` default: bash_code_execution_tool_result - `content: BashCodeExecutionToolResultError | BashCodeExecutionResultBlock` - `interface BashCodeExecutionToolResultError` - `type: "bash_code_execution_tool_result_error"` default: bash_code_execution_tool_result_error - `error_code: BashCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `interface BashCodeExecutionResultBlock` - `type: "bash_code_execution_result"` default: bash_code_execution_result - `content: Array` - `type: "bash_code_execution_output"` default: bash_code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Bash Code Execution Tool Result Block Param - `interface BashCodeExecutionToolResultBlockParam` - `type: "bash_code_execution_tool_result"` - `content: BashCodeExecutionToolResultErrorParam | BashCodeExecutionResultBlockParam` - `interface BashCodeExecutionToolResultErrorParam` - `type: "bash_code_execution_tool_result_error"` - `error_code: BashCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `interface BashCodeExecutionResultBlockParam` - `type: "bash_code_execution_result"` - `content: Array` - `type: "bash_code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` ### Bash Code Execution Tool Result Error - `interface BashCodeExecutionToolResultError` - `type: "bash_code_execution_tool_result_error"` default: bash_code_execution_tool_result_error - `error_code: BashCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` ### Bash Code Execution Tool Result Error Code - `type BashCodeExecutionToolResultErrorCode = "invalid_tool_input" | "unavailable" | "too_many_requests" | 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` ### Bash Code Execution Tool Result Error Param - `interface BashCodeExecutionToolResultErrorParam` - `type: "bash_code_execution_tool_result_error"` - `error_code: BashCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` ### Browser Click Target - `type BrowserClickTarget = BrowserCoordinateTarget | BrowserRefTarget` Where to act: either a viewport coordinate or an element reference. - `interface BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `interface BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. ### Browser Close Tab Config - `interface BrowserCloseTabConfig` `close_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Close Tab Input - `interface BrowserCloseTabInput` Close the tab with the given tab_id. - `tab_id: string` The tab to close. ### Browser Close Tab Tool Use Block - `interface BrowserCloseTabToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserCloseTabInput` Close the tab with the given tab_id. - `tab_id: string` The tab to close. - `name: "close_tab"` - `toolset_name: "browser"` ### Browser Coordinate Target - `interface BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 ### Browser Double Click Config - `interface BrowserDoubleClickConfig` `double_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Double Click Input - `interface BrowserDoubleClickInput` Double left-click at a viewport coordinate or on an element by reference. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `interface BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `interface BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Double Click Tool Use Block - `interface BrowserDoubleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserDoubleClickInput` Double left-click at a viewport coordinate or on an element by reference. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `interface BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `interface BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "double_click"` - `toolset_name: "browser"` ### Browser File Upload Config - `interface BrowserFileUploadConfig` `file_upload`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser File Upload Input - `interface BrowserFileUploadInput` Set the value of a file-input element to one or more files. The target must be an element reference; at least one of paths or document_ids is required. - `target: BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `document_ids?: Array | null` References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem. minItems: 1 - `paths?: Array | null` File paths on the browser executor's filesystem. minItems: 1 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser File Upload Tool Use Block - `interface BrowserFileUploadToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserFileUploadInput` Set the value of a file-input element to one or more files. The target must be an element reference; at least one of paths or document_ids is required. - `target: BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `document_ids?: Array | null` References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem. minItems: 1 - `paths?: Array | null` File paths on the browser executor's filesystem. minItems: 1 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "file_upload"` - `toolset_name: "browser"` ### Browser Find Config - `interface BrowserFindConfig` `find`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Find Input - `interface BrowserFindInput` Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references. - `query: string` Natural-language description of the element(s) to find. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Find Tool Use Block - `interface BrowserFindToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserFindInput` Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references. - `query: string` Natural-language description of the element(s) to find. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "find"` - `toolset_name: "browser"` ### Browser Form Input Config - `interface BrowserFormInputConfig` `form_input`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Form Input Input - `interface BrowserFormInputInput` Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects. - `target: BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `value: BrowserFormInputValue` The value to set. - `string` - `number` - `boolean` - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Form Input Tool Use Block - `interface BrowserFormInputToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserFormInputInput` Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects. - `target: BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `value: BrowserFormInputValue` The value to set. - `string` - `number` - `boolean` - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "form_input"` - `toolset_name: "browser"` ### Browser Form Input Value - `type BrowserFormInputValue = string | number | boolean` - `string` - `number` - `boolean` ### Browser Get Page Text Config - `interface BrowserGetPageTextConfig` `get_page_text`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Get Page Text Input - `interface BrowserGetPageTextInput` Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Get Page Text Tool Use Block - `interface BrowserGetPageTextToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserGetPageTextInput` Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "get_page_text"` - `toolset_name: "browser"` ### Browser Hold Key Config - `interface BrowserHoldKeyConfig` `hold_key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Hold Key Input - `interface BrowserHoldKeyInput` Hold a key or key chord down for a duration, then release it. Uses the same key names and "+" chord syntax as the key action. - `duration: number` Seconds to hold the key down (maximum 30). minimum: 0, maximum: 30 - `text: string` The key or chord to hold. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Hold Key Tool Use Block - `interface BrowserHoldKeyToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserHoldKeyInput` Hold a key or key chord down for a duration, then release it. Uses the same key names and "+" chord syntax as the key action. - `duration: number` Seconds to hold the key down (maximum 30). minimum: 0, maximum: 30 - `text: string` The key or chord to hold. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "hold_key"` - `toolset_name: "browser"` ### Browser Hover Config - `interface BrowserHoverConfig` `hover`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Hover Input - `interface BrowserHoverInput` Move the cursor to a coordinate or element without clicking. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `interface BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `interface BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Hover Tool Use Block - `interface BrowserHoverToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserHoverInput` Move the cursor to a coordinate or element without clicking. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `interface BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `interface BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "hover"` - `toolset_name: "browser"` ### Browser Javascript Exec Config - `interface BrowserJavascriptExecConfig` `javascript_exec`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Javascript Exec Input - `interface BrowserJavascriptExecInput` Execute JavaScript in the page context and return the value of the last expression. The code runs with access to the DOM, `window`, and page variables. Write the expression you want evaluated — do NOT use `return`. - `text: string` JavaScript to execute in the page context. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Javascript Exec Tool Use Block - `interface BrowserJavascriptExecToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserJavascriptExecInput` Execute JavaScript in the page context and return the value of the last expression. The code runs with access to the DOM, `window`, and page variables. Write the expression you want evaluated — do NOT use `return`. - `text: string` JavaScript to execute in the page context. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "javascript_exec"` - `toolset_name: "browser"` ### Browser Key Config - `interface BrowserKeyConfig` `key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Key Input - `interface BrowserKeyInput` Press a key or key chord. Use "+" to combine modifiers with a key (e.g. "ctrl+a", "cmd+shift+p") and space to sequence presses (e.g. "Backspace Backspace Delete"). Common names like "Return", "Tab", "Escape", "BackSpace" are supported. - `text: string` The key, chord, or space-separated sequence to press. - `repeat?: number | null` Number of times to repeat. Default 1. minimum: 1, maximum: 100 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Key Tool Use Block - `interface BrowserKeyToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserKeyInput` Press a key or key chord. Use "+" to combine modifiers with a key (e.g. "ctrl+a", "cmd+shift+p") and space to sequence presses (e.g. "Backspace Backspace Delete"). Common names like "Return", "Tab", "Escape", "BackSpace" are supported. - `text: string` The key, chord, or space-separated sequence to press. - `repeat?: number | null` Number of times to repeat. Default 1. minimum: 1, maximum: 100 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "key"` - `toolset_name: "browser"` ### Browser Left Click Config - `interface BrowserLeftClickConfig` `left_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Left Click Drag Config - `interface BrowserLeftClickDragConfig` `left_click_drag`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Left Click Drag Input - `interface BrowserLeftClickDragInput` Press at `from`, drag to `target`, release. Both must be coordinate targets. - `from: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Left Click Drag Tool Use Block - `interface BrowserLeftClickDragToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserLeftClickDragInput` Press at `from`, drag to `target`, release. Both must be coordinate targets. - `from: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "left_click_drag"` - `toolset_name: "browser"` ### Browser Left Click Input - `interface BrowserLeftClickInput` Left-click at a viewport coordinate or on an element by reference. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `interface BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `interface BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Left Click Tool Use Block - `interface BrowserLeftClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserLeftClickInput` Left-click at a viewport coordinate or on an element by reference. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `interface BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `interface BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "left_click"` - `toolset_name: "browser"` ### Browser Left Mouse Down Config - `interface BrowserLeftMouseDownConfig` `left_mouse_down`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Left Mouse Down Input - `interface BrowserLeftMouseDownInput` Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag. - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Left Mouse Down Tool Use Block - `interface BrowserLeftMouseDownToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserLeftMouseDownInput` Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag. - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "left_mouse_down"` - `toolset_name: "browser"` ### Browser Left Mouse Up Config - `interface BrowserLeftMouseUpConfig` `left_mouse_up`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Left Mouse Up Input - `interface BrowserLeftMouseUpInput` Release the left mouse button at a viewport coordinate. - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Left Mouse Up Tool Use Block - `interface BrowserLeftMouseUpToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserLeftMouseUpInput` Release the left mouse button at a viewport coordinate. - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "left_mouse_up"` - `toolset_name: "browser"` ### Browser List Tabs Config - `interface BrowserListTabsConfig` `list_tabs`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser List Tabs Input - `interface BrowserListTabsInput` List all open tabs with each tab's tab_id, title, and URL. ### Browser List Tabs Tool Use Block - `interface BrowserListTabsToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserListTabsInput` List all open tabs with each tab's tab_id, title, and URL. - `name: "list_tabs"` - `toolset_name: "browser"` ### Browser Middle Click Config - `interface BrowserMiddleClickConfig` `middle_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Middle Click Input - `interface BrowserMiddleClickInput` Middle-click at a viewport coordinate or on an element by reference. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `interface BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `interface BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Middle Click Tool Use Block - `interface BrowserMiddleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserMiddleClickInput` Middle-click at a viewport coordinate or on an element by reference. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `interface BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `interface BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "middle_click"` - `toolset_name: "browser"` ### Browser Mouse Move Config - `interface BrowserMouseMoveConfig` `mouse_move`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Mouse Move Input - `interface BrowserMouseMoveInput` Move the pointer to a viewport coordinate without clicking. - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Mouse Move Tool Use Block - `interface BrowserMouseMoveToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserMouseMoveInput` Move the pointer to a viewport coordinate without clicking. - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "mouse_move"` - `toolset_name: "browser"` ### Browser Navigate Config - `interface BrowserNavigateConfig` `navigate`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Navigate Input - `interface BrowserNavigateInput` Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://). - `url: string` The URL to navigate to, or "back" / "forward" / "reload" for history navigation. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Navigate Tool Use Block - `interface BrowserNavigateToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserNavigateInput` Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://). - `url: string` The URL to navigate to, or "back" / "forward" / "reload" for history navigation. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "navigate"` - `toolset_name: "browser"` ### Browser New Tab Config - `interface BrowserNewTabConfig` `new_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser New Tab Input - `interface BrowserNewTabInput` Open a new empty tab and return its tab_id. ### Browser New Tab Tool Use Block - `interface BrowserNewTabToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserNewTabInput` Open a new empty tab and return its tab_id. - `name: "new_tab"` - `toolset_name: "browser"` ### Browser Read Console Config - `interface BrowserReadConsoleConfig` `read_console`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Read Console Input - `interface BrowserReadConsoleInput` Return console output (log entries, errors, warnings) accumulated since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Read Console Tool Use Block - `interface BrowserReadConsoleToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserReadConsoleInput` Return console output (log entries, errors, warnings) accumulated since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "read_console"` - `toolset_name: "browser"` ### Browser Read Network Config - `interface BrowserReadNetworkConfig` `read_network`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Read Network Input - `interface BrowserReadNetworkInput` Return the network requests (method, URL, status, MIME type, timing) recorded since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Read Network Tool Use Block - `interface BrowserReadNetworkToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserReadNetworkInput` Return the network requests (method, URL, status, MIME type, timing) recorded since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "read_network"` - `toolset_name: "browser"` ### Browser Read Page Config - `interface BrowserReadPageConfig` `read_page`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Read Page Filter - `type BrowserReadPageFilter = "all" | "interactive"` - `"all"` - `"interactive"` ### Browser Read Page Input - `interface BrowserReadPageInput` Return a structured accessibility tree of the page (or the subtree rooted at `ref`), with element references like [ref_7] that can be used as targets on later actions. Output is capped at 50,000 characters — narrow with `ref` or a smaller `depth` when exceeded. - `depth?: number | null` Maximum tree depth. Default 15. minimum: 1 - `filter?: BrowserReadPageFilter | null` Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements. - `"all"` - `"interactive"` - `ref?: string | null` Element reference to read a subtree from. Omit to read from the page root. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Read Page Tool Use Block - `interface BrowserReadPageToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserReadPageInput` Return a structured accessibility tree of the page (or the subtree rooted at `ref`), with element references like [ref_7] that can be used as targets on later actions. Output is capped at 50,000 characters — narrow with `ref` or a smaller `depth` when exceeded. - `depth?: number | null` Maximum tree depth. Default 15. minimum: 1 - `filter?: BrowserReadPageFilter | null` Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements. - `"all"` - `"interactive"` - `ref?: string | null` Element reference to read a subtree from. Omit to read from the page root. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "read_page"` - `toolset_name: "browser"` ### Browser Ref Target - `interface BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. ### Browser Right Click Config - `interface BrowserRightClickConfig` `right_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Right Click Input - `interface BrowserRightClickInput` Right-click at a viewport coordinate or on an element by reference. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `interface BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `interface BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Right Click Tool Use Block - `interface BrowserRightClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserRightClickInput` Right-click at a viewport coordinate or on an element by reference. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `interface BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `interface BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "right_click"` - `toolset_name: "browser"` ### Browser Screenshot Config - `interface BrowserScreenshotConfig` `screenshot`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Screenshot Input - `interface BrowserScreenshotInput` Capture the current browser viewport. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Screenshot Tool Use Block - `interface BrowserScreenshotToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserScreenshotInput` Capture the current browser viewport. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "screenshot"` - `toolset_name: "browser"` ### Browser Scroll Config - `interface BrowserScrollConfig` `scroll`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Scroll Direction - `type BrowserScrollDirection = "up" | "down" | "left" | "right"` - `"up"` - `"down"` - `"left"` - `"right"` ### Browser Scroll Input - `interface BrowserScrollInput` Scroll at a viewport position. `target` must be a coordinate target. - `scroll_direction: BrowserScrollDirection` - `"up"` - `"down"` - `"left"` - `"right"` - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `scroll_amount?: number | null` Scroll-wheel notches (1–10). Default 3. minimum: 1, maximum: 10 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Scroll To Config - `interface BrowserScrollToConfig` `scroll_to`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Scroll To Input - `interface BrowserScrollToInput` Scroll an element into view. - `target: BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Scroll To Tool Use Block - `interface BrowserScrollToToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserScrollToInput` Scroll an element into view. - `target: BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "scroll_to"` - `toolset_name: "browser"` ### Browser Scroll Tool Use Block - `interface BrowserScrollToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserScrollInput` Scroll at a viewport position. `target` must be a coordinate target. - `scroll_direction: BrowserScrollDirection` - `"up"` - `"down"` - `"left"` - `"right"` - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `scroll_amount?: number | null` Scroll-wheel notches (1–10). Default 3. minimum: 1, maximum: 10 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "scroll"` - `toolset_name: "browser"` ### Browser State Block Param - `interface BrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `type: "browser_state"` - `tabs: Array` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `tab_id: string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `title: string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `active?: boolean` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `state_changes?: Array | null` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `interface BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `type: "tab_opened"` - `tab_id: string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `interface BrowserStateChangeDownloadStarted` A file download that started during this call. - `type: "download_started"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `interface BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `type: "download_completed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path?: string | null` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `size_bytes?: number | null` The completed download's size. minimum: 0 - `interface BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `type: "download_failed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `error?: string | null` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Browser State Change - `type BrowserStateChange = BrowserStateChangeTabOpened | BrowserStateChangeDownloadStarted | BrowserStateChangeDownloadCompleted | BrowserStateChangeDownloadFailed` - `interface BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `type: "tab_opened"` - `tab_id: string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `interface BrowserStateChangeDownloadStarted` A file download that started during this call. - `type: "download_started"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `interface BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `type: "download_completed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path?: string | null` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `size_bytes?: number | null` The completed download's size. minimum: 0 - `interface BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `type: "download_failed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `error?: string | null` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Browser State Change Download Completed - `interface BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `type: "download_completed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path?: string | null` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `size_bytes?: number | null` The completed download's size. minimum: 0 ### Browser State Change Download Failed - `interface BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `type: "download_failed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `error?: string | null` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Browser State Change Download Started - `interface BrowserStateChangeDownloadStarted` A file download that started during this call. - `type: "download_started"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Browser State Change Tab Opened - `interface BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `type: "tab_opened"` - `tab_id: string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Browser State Tab Entry - `interface BrowserStateTabEntry` One open browser tab reported in a `browser_state` block's `tabs` inventory. `tab_id` is the caller-assigned identifier for the tab; `title` and `url` describe the page the tab is currently showing and may be empty strings (a blank tab legitimately has both empty). `active` marks the tab that is active after this call; whenever `tabs` is non-empty, exactly one entry is marked. - `tab_id: string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `title: string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `active?: boolean` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. ### Browser Switch Tab Config - `interface BrowserSwitchTabConfig` `switch_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Switch Tab Input - `interface BrowserSwitchTabInput` Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to. - `tab_id: string` The tab to switch to. ### Browser Switch Tab Tool Use Block - `interface BrowserSwitchTabToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserSwitchTabInput` Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to. - `tab_id: string` The tab to switch to. - `name: "switch_tab"` - `toolset_name: "browser"` ### Browser Tool Use Block - `type BrowserToolUseBlock = BrowserNavigateToolUseBlock | BrowserListTabsToolUseBlock | BrowserNewTabToolUseBlock | 28 more` - `interface BrowserNavigateToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserNavigateInput` Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://). - `url: string` The URL to navigate to, or "back" / "forward" / "reload" for history navigation. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "navigate"` - `toolset_name: "browser"` - `interface BrowserListTabsToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserListTabsInput` List all open tabs with each tab's tab_id, title, and URL. - `name: "list_tabs"` - `toolset_name: "browser"` - `interface BrowserNewTabToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserNewTabInput` Open a new empty tab and return its tab_id. - `name: "new_tab"` - `toolset_name: "browser"` - `interface BrowserSwitchTabToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserSwitchTabInput` Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to. - `tab_id: string` The tab to switch to. - `name: "switch_tab"` - `toolset_name: "browser"` - `interface BrowserCloseTabToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserCloseTabInput` Close the tab with the given tab_id. - `tab_id: string` The tab to close. - `name: "close_tab"` - `toolset_name: "browser"` - `interface BrowserReadPageToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserReadPageInput` Return a structured accessibility tree of the page (or the subtree rooted at `ref`), with element references like [ref_7] that can be used as targets on later actions. Output is capped at 50,000 characters — narrow with `ref` or a smaller `depth` when exceeded. - `depth?: number | null` Maximum tree depth. Default 15. minimum: 1 - `filter?: BrowserReadPageFilter | null` Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements. - `"all"` - `"interactive"` - `ref?: string | null` Element reference to read a subtree from. Omit to read from the page root. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "read_page"` - `toolset_name: "browser"` - `interface BrowserGetPageTextToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserGetPageTextInput` Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "get_page_text"` - `toolset_name: "browser"` - `interface BrowserReadConsoleToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserReadConsoleInput` Return console output (log entries, errors, warnings) accumulated since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "read_console"` - `toolset_name: "browser"` - `interface BrowserReadNetworkToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserReadNetworkInput` Return the network requests (method, URL, status, MIME type, timing) recorded since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "read_network"` - `toolset_name: "browser"` - `interface BrowserFindToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserFindInput` Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references. - `query: string` Natural-language description of the element(s) to find. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "find"` - `toolset_name: "browser"` - `interface BrowserFormInputToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserFormInputInput` Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects. - `target: BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `value: BrowserFormInputValue` The value to set. - `string` - `number` - `boolean` - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "form_input"` - `toolset_name: "browser"` - `interface BrowserFileUploadToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserFileUploadInput` Set the value of a file-input element to one or more files. The target must be an element reference; at least one of paths or document_ids is required. - `target: BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `document_ids?: Array | null` References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem. minItems: 1 - `paths?: Array | null` File paths on the browser executor's filesystem. minItems: 1 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "file_upload"` - `toolset_name: "browser"` - `interface BrowserScrollToToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserScrollToInput` Scroll an element into view. - `target: BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "scroll_to"` - `toolset_name: "browser"` - `interface BrowserScreenshotToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserScreenshotInput` Capture the current browser viewport. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "screenshot"` - `toolset_name: "browser"` - `interface BrowserZoomToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserZoomInput` Return a cropped screenshot of the given viewport region, scaled up for closer inspection — useful for small icons, buttons, or text. Coordinates are in the same viewport-pixel space as a full screenshot. - `region: Array` [x0, y0, x1, y1] in viewport pixels. minItems: 4, maxItems: 4 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "zoom"` - `toolset_name: "browser"` - `interface BrowserLeftClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserLeftClickInput` Left-click at a viewport coordinate or on an element by reference. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `interface BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `interface BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "left_click"` - `toolset_name: "browser"` - `interface BrowserRightClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserRightClickInput` Right-click at a viewport coordinate or on an element by reference. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "right_click"` - `toolset_name: "browser"` - `interface BrowserMiddleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserMiddleClickInput` Middle-click at a viewport coordinate or on an element by reference. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "middle_click"` - `toolset_name: "browser"` - `interface BrowserDoubleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserDoubleClickInput` Double left-click at a viewport coordinate or on an element by reference. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "double_click"` - `toolset_name: "browser"` - `interface BrowserTripleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserTripleClickInput` Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph). - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "triple_click"` - `toolset_name: "browser"` - `interface BrowserHoverToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserHoverInput` Move the cursor to a coordinate or element without clicking. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "hover"` - `toolset_name: "browser"` - `interface BrowserLeftClickDragToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserLeftClickDragInput` Press at `from`, drag to `target`, release. Both must be coordinate targets. - `from: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "left_click_drag"` - `toolset_name: "browser"` - `interface BrowserLeftMouseDownToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserLeftMouseDownInput` Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag. - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "left_mouse_down"` - `toolset_name: "browser"` - `interface BrowserLeftMouseUpToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserLeftMouseUpInput` Release the left mouse button at a viewport coordinate. - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "left_mouse_up"` - `toolset_name: "browser"` - `interface BrowserMouseMoveToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserMouseMoveInput` Move the pointer to a viewport coordinate without clicking. - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "mouse_move"` - `toolset_name: "browser"` - `interface BrowserScrollToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserScrollInput` Scroll at a viewport position. `target` must be a coordinate target. - `scroll_direction: BrowserScrollDirection` - `"up"` - `"down"` - `"left"` - `"right"` - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `scroll_amount?: number | null` Scroll-wheel notches (1–10). Default 3. minimum: 1, maximum: 10 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "scroll"` - `toolset_name: "browser"` - `interface BrowserTypeToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserTypeInput` Type a literal string at the current focus. - `text: string` The text to type. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "type"` - `toolset_name: "browser"` - `interface BrowserKeyToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserKeyInput` Press a key or key chord. Use "+" to combine modifiers with a key (e.g. "ctrl+a", "cmd+shift+p") and space to sequence presses (e.g. "Backspace Backspace Delete"). Common names like "Return", "Tab", "Escape", "BackSpace" are supported. - `text: string` The key, chord, or space-separated sequence to press. - `repeat?: number | null` Number of times to repeat. Default 1. minimum: 1, maximum: 100 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "key"` - `toolset_name: "browser"` - `interface BrowserHoldKeyToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserHoldKeyInput` Hold a key or key chord down for a duration, then release it. Uses the same key names and "+" chord syntax as the key action. - `duration: number` Seconds to hold the key down (maximum 30). minimum: 0, maximum: 30 - `text: string` The key or chord to hold. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "hold_key"` - `toolset_name: "browser"` - `interface BrowserWaitToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserWaitInput` Pause for the given duration. - `duration: number` Seconds to wait (maximum 30). minimum: 0, maximum: 30 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "wait"` - `toolset_name: "browser"` - `interface BrowserJavascriptExecToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserJavascriptExecInput` Execute JavaScript in the page context and return the value of the last expression. The code runs with access to the DOM, `window`, and page variables. Write the expression you want evaluated — do NOT use `return`. - `text: string` JavaScript to execute in the page context. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "javascript_exec"` - `toolset_name: "browser"` ### Browser Toolset 20260801 - `interface BrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `type: "browser_toolset_20260801"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `configs?: BrowserToolsetConfigs | null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type?: BrowserTypeConfig | null` `type`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `close_tab?: BrowserCloseTabConfig | null` `close_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click?: BrowserDoubleClickConfig | null` `double_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `file_upload?: BrowserFileUploadConfig | null` `file_upload`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `find?: BrowserFindConfig | null` `find`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `form_input?: BrowserFormInputConfig | null` `form_input`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `get_page_text?: BrowserGetPageTextConfig | null` `get_page_text`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key?: BrowserHoldKeyConfig | null` `hold_key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hover?: BrowserHoverConfig | null` `hover`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `javascript_exec?: BrowserJavascriptExecConfig | null` `javascript_exec`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key?: BrowserKeyConfig | null` `key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click?: BrowserLeftClickConfig | null` `left_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag?: BrowserLeftClickDragConfig | null` `left_click_drag`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down?: BrowserLeftMouseDownConfig | null` `left_mouse_down`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up?: BrowserLeftMouseUpConfig | null` `left_mouse_up`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `list_tabs?: BrowserListTabsConfig | null` `list_tabs`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click?: BrowserMiddleClickConfig | null` `middle_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move?: BrowserMouseMoveConfig | null` `mouse_move`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `navigate?: BrowserNavigateConfig | null` `navigate`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `new_tab?: BrowserNewTabConfig | null` `new_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_console?: BrowserReadConsoleConfig | null` `read_console`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_network?: BrowserReadNetworkConfig | null` `read_network`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_page?: BrowserReadPageConfig | null` `read_page`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click?: BrowserRightClickConfig | null` `right_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot?: BrowserScreenshotConfig | null` `screenshot`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll?: BrowserScrollConfig | null` `scroll`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll_to?: BrowserScrollToConfig | null` `scroll_to`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `switch_tab?: BrowserSwitchTabConfig | null` `switch_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click?: BrowserTripleClickConfig | null` `triple_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait?: BrowserWaitConfig | null` `wait`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom?: BrowserZoomConfig | null` `zoom`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Toolset Configs - `interface BrowserToolsetConfigs` Per-member configuration for `browser_toolset_20260801`: one optional field per member tool, keyed by the member name — the same name the member's `tool_use` blocks carry. Every member is an accepted key, and a member's defaults apply wherever its key is absent. Unknown keys are rejected: the field set is this toolset version's complete member set. - `type?: BrowserTypeConfig | null` `type`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `close_tab?: BrowserCloseTabConfig | null` `close_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click?: BrowserDoubleClickConfig | null` `double_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `file_upload?: BrowserFileUploadConfig | null` `file_upload`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `find?: BrowserFindConfig | null` `find`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `form_input?: BrowserFormInputConfig | null` `form_input`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `get_page_text?: BrowserGetPageTextConfig | null` `get_page_text`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key?: BrowserHoldKeyConfig | null` `hold_key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hover?: BrowserHoverConfig | null` `hover`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `javascript_exec?: BrowserJavascriptExecConfig | null` `javascript_exec`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key?: BrowserKeyConfig | null` `key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click?: BrowserLeftClickConfig | null` `left_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag?: BrowserLeftClickDragConfig | null` `left_click_drag`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down?: BrowserLeftMouseDownConfig | null` `left_mouse_down`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up?: BrowserLeftMouseUpConfig | null` `left_mouse_up`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `list_tabs?: BrowserListTabsConfig | null` `list_tabs`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click?: BrowserMiddleClickConfig | null` `middle_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move?: BrowserMouseMoveConfig | null` `mouse_move`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `navigate?: BrowserNavigateConfig | null` `navigate`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `new_tab?: BrowserNewTabConfig | null` `new_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_console?: BrowserReadConsoleConfig | null` `read_console`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_network?: BrowserReadNetworkConfig | null` `read_network`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_page?: BrowserReadPageConfig | null` `read_page`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click?: BrowserRightClickConfig | null` `right_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot?: BrowserScreenshotConfig | null` `screenshot`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll?: BrowserScrollConfig | null` `scroll`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll_to?: BrowserScrollToConfig | null` `scroll_to`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `switch_tab?: BrowserSwitchTabConfig | null` `switch_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click?: BrowserTripleClickConfig | null` `triple_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait?: BrowserWaitConfig | null` `wait`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom?: BrowserZoomConfig | null` `zoom`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Triple Click Config - `interface BrowserTripleClickConfig` `triple_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Triple Click Input - `interface BrowserTripleClickInput` Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph). - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `interface BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `interface BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Triple Click Tool Use Block - `interface BrowserTripleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserTripleClickInput` Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph). - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `interface BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `interface BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "triple_click"` - `toolset_name: "browser"` ### Browser Type Config - `interface BrowserTypeConfig` `type`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Type Input - `interface BrowserTypeInput` Type a literal string at the current focus. - `text: string` The text to type. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Type Tool Use Block - `interface BrowserTypeToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserTypeInput` Type a literal string at the current focus. - `text: string` The text to type. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "type"` - `toolset_name: "browser"` ### Browser Wait Config - `interface BrowserWaitConfig` `wait`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Wait Input - `interface BrowserWaitInput` Pause for the given duration. - `duration: number` Seconds to wait (maximum 30). minimum: 0, maximum: 30 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Wait Tool Use Block - `interface BrowserWaitToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserWaitInput` Pause for the given duration. - `duration: number` Seconds to wait (maximum 30). minimum: 0, maximum: 30 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "wait"` - `toolset_name: "browser"` ### Browser Zoom Config - `interface BrowserZoomConfig` `zoom`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Zoom Input - `interface BrowserZoomInput` Return a cropped screenshot of the given viewport region, scaled up for closer inspection — useful for small icons, buttons, or text. Coordinates are in the same viewport-pixel space as a full screenshot. - `region: Array` [x0, y0, x1, y1] in viewport pixels. minItems: 4, maxItems: 4 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. ### Browser Zoom Tool Use Block - `interface BrowserZoomToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserZoomInput` Return a cropped screenshot of the given viewport region, scaled up for closer inspection — useful for small icons, buttons, or text. Coordinates are in the same viewport-pixel space as a full screenshot. - `region: Array` [x0, y0, x1, y1] in viewport pixels. minItems: 4, maxItems: 4 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "zoom"` - `toolset_name: "browser"` ### Cache Control Ephemeral - `interface CacheControlEphemeral` - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` ### Cache Creation - `interface CacheCreation` - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 ### Cache Miss Messages Changed - `interface CacheMissMessagesChanged` - `type: "messages_changed"` default: messages_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. ### Cache Miss Model Changed - `interface CacheMissModelChanged` - `type: "model_changed"` default: model_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. ### Cache Miss Previous Message Not Found - `interface CacheMissPreviousMessageNotFound` - `type: "previous_message_not_found"` default: previous_message_not_found ### Cache Miss Reason - `type CacheMissReason = CacheMissModelChanged | CacheMissSystemChanged | CacheMissToolsChanged | 3 more` - `interface CacheMissModelChanged` - `type: "model_changed"` default: model_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissSystemChanged` - `type: "system_changed"` default: system_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissToolsChanged` - `type: "tools_changed"` default: tools_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissMessagesChanged` - `type: "messages_changed"` default: messages_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissPreviousMessageNotFound` - `type: "previous_message_not_found"` default: previous_message_not_found - `interface CacheMissUnavailable` - `type: "unavailable"` default: unavailable ### Cache Miss System Changed - `interface CacheMissSystemChanged` - `type: "system_changed"` default: system_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. ### Cache Miss Tools Changed - `interface CacheMissToolsChanged` - `type: "tools_changed"` default: tools_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. ### Cache Miss Unavailable - `interface CacheMissUnavailable` - `type: "unavailable"` default: unavailable ### Citation Char Location - `interface CitationCharLocation` - `type: "char_location"` default: char_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` minimum: 0 ### Citation Char Location Param - `interface CitationCharLocationParam` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 ### Citation Content Block Location - `interface CitationContentBlockLocation` - `type: "content_block_location"` default: content_block_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `file_id: string | null` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 ### Citation Content Block Location Param - `interface CitationContentBlockLocationParam` - `type: "content_block_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 ### Citation Page Location - `interface CitationPageLocation` - `type: "page_location"` default: page_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` minimum: 1 ### Citation Page Location Param - `interface CitationPageLocationParam` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 ### Citation Search Result Location Param - `interface CitationSearchResultLocationParam` - `type: "search_result_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` ### Citation Web Search Result Location Param - `interface CitationWebSearchResultLocationParam` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string | null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 ### Citations Config - `interface CitationsConfig` - `enabled: boolean` default: false ### Citations Config Param - `interface CitationsConfigParam` - `enabled?: boolean` ### Citations Delta - `interface CitationsDelta` - `type: "citations_delta"` default: citations_delta - `citation: CitationCharLocation | CitationPageLocation | CitationContentBlockLocation | 2 more` - `interface CitationCharLocation` - `type: "char_location"` default: char_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` minimum: 0 - `interface CitationPageLocation` - `type: "page_location"` default: page_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocation` - `type: "content_block_location"` default: content_block_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `file_id: string | null` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationsWebSearchResultLocation` - `type: "web_search_result_location"` default: web_search_result_location - `cited_text: string` - `encrypted_index: string` - `title: string | null` maxLength: 512 - `url: string` - `interface CitationsSearchResultLocation` - `type: "search_result_location"` default: search_result_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` ### Citations Search Result Location - `interface CitationsSearchResultLocation` - `type: "search_result_location"` default: search_result_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` ### Citations Web Search Result Location - `interface CitationsWebSearchResultLocation` - `type: "web_search_result_location"` default: web_search_result_location - `cited_text: string` - `encrypted_index: string` - `title: string | null` maxLength: 512 - `url: string` ### Code Execution Output Block - `interface CodeExecutionOutputBlock` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` ### Code Execution Output Block Param - `interface CodeExecutionOutputBlockParam` - `type: "code_execution_output"` - `file_id: string` ### Code Execution Result Block - `interface CodeExecutionResultBlock` - `type: "code_execution_result"` default: code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` ### Code Execution Result Block Param - `interface CodeExecutionResultBlockParam` - `type: "code_execution_result"` - `content: Array` - `type: "code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` ### Code Execution Tool 20250522 - `interface CodeExecutionTool20250522` - `type: "code_execution_20250522"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Code Execution Tool 20250825 - `interface CodeExecutionTool20250825` - `type: "code_execution_20250825"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Code Execution Tool 20260120 - `interface CodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `type: "code_execution_20260120"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Code Execution Tool 20260521 - `interface CodeExecutionTool20260521` Code execution tool with REPL state persistence. - `type: "code_execution_20260521"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Code Execution Tool Result Block - `interface CodeExecutionToolResultBlock` - `type: "code_execution_tool_result"` default: code_execution_tool_result - `content: CodeExecutionToolResultBlockContent` - `interface CodeExecutionToolResultError` - `type: "code_execution_tool_result_error"` default: code_execution_tool_result_error - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `interface CodeExecutionResultBlock` - `type: "code_execution_result"` default: code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `interface EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` default: encrypted_code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Code Execution Tool Result Block Content - `type CodeExecutionToolResultBlockContent = CodeExecutionToolResultError | CodeExecutionResultBlock | EncryptedCodeExecutionResultBlock` - `interface CodeExecutionToolResultError` - `type: "code_execution_tool_result_error"` default: code_execution_tool_result_error - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `interface CodeExecutionResultBlock` - `type: "code_execution_result"` default: code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `interface EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` default: encrypted_code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` ### Code Execution Tool Result Block Param - `interface CodeExecutionToolResultBlockParam` - `type: "code_execution_tool_result"` - `content: CodeExecutionToolResultBlockParamContent` - `interface CodeExecutionToolResultErrorParam` - `type: "code_execution_tool_result_error"` - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `interface CodeExecutionResultBlockParam` - `type: "code_execution_result"` - `content: Array` - `type: "code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `interface EncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` - `content: Array` - `type: "code_execution_output"` - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` ### Code Execution Tool Result Block Param Content - `type CodeExecutionToolResultBlockParamContent = CodeExecutionToolResultErrorParam | CodeExecutionResultBlockParam | EncryptedCodeExecutionResultBlockParam` - `interface CodeExecutionToolResultErrorParam` - `type: "code_execution_tool_result_error"` - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `interface CodeExecutionResultBlockParam` - `type: "code_execution_result"` - `content: Array` - `type: "code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `interface EncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` - `content: Array` - `type: "code_execution_output"` - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` ### Code Execution Tool Result Error - `interface CodeExecutionToolResultError` - `type: "code_execution_tool_result_error"` default: code_execution_tool_result_error - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` ### Code Execution Tool Result Error Code - `type CodeExecutionToolResultErrorCode = "invalid_tool_input" | "unavailable" | "too_many_requests" | "execution_time_exceeded"` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` ### Code Execution Tool Result Error Param - `interface CodeExecutionToolResultErrorParam` - `type: "code_execution_tool_result_error"` - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` ### Computer Cursor Position Config - `interface ComputerCursorPositionConfig` `cursor_position`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Cursor Position Input - `interface ComputerCursorPositionInput` Get the current (x, y) pixel coordinate of the cursor. ### Computer Cursor Position Tool Use Block - `interface ComputerCursorPositionToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerCursorPositionInput` Get the current (x, y) pixel coordinate of the cursor. - `name: "cursor_position"` - `toolset_name: "computer"` ### Computer Double Click Config - `interface ComputerDoubleClickConfig` `double_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Double Click Input - `interface ComputerDoubleClickInput` Double-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Computer Double Click Tool Use Block - `interface ComputerDoubleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerDoubleClickInput` Double-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "double_click"` - `toolset_name: "computer"` ### Computer Hold Key Config - `interface ComputerHoldKeyConfig` `hold_key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Hold Key Input - `interface ComputerHoldKeyInput` Hold down a key or key-combination for a specified duration. Uses the same key syntax as `key`. - `duration: number` Duration to hold the key, in seconds. maximum: 300 - `text: string` The key or key-combination to hold. ### Computer Hold Key Tool Use Block - `interface ComputerHoldKeyToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerHoldKeyInput` Hold down a key or key-combination for a specified duration. Uses the same key syntax as `key`. - `duration: number` Duration to hold the key, in seconds. maximum: 300 - `text: string` The key or key-combination to hold. - `name: "hold_key"` - `toolset_name: "computer"` ### Computer Key Config - `interface ComputerKeyConfig` `key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Key Input - `interface ComputerKeyInput` Press a key or key-combination on the keyboard. Use "+" to combine modifiers with a key (e.g. "ctrl+s", "alt+Tab", "ctrl+shift+Escape"). Key names are case-insensitive; common names like "Return", "Tab", "Escape", "Up", "Down", "Left", "Right", "Home", "End", "Page_Up", "Page_Down", "Delete", "BackSpace" are supported. - `text: string` The key or key-combination to press. - `repeat?: number | null` Number of times to repeat the key press. Default is 1. minimum: 1, maximum: 100 ### Computer Key Tool Use Block - `interface ComputerKeyToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerKeyInput` Press a key or key-combination on the keyboard. Use "+" to combine modifiers with a key (e.g. "ctrl+s", "alt+Tab", "ctrl+shift+Escape"). Key names are case-insensitive; common names like "Return", "Tab", "Escape", "Up", "Down", "Left", "Right", "Home", "End", "Page_Up", "Page_Down", "Delete", "BackSpace" are supported. - `text: string` The key or key-combination to press. - `repeat?: number | null` Number of times to repeat the key press. Default is 1. minimum: 1, maximum: 100 - `name: "key"` - `toolset_name: "computer"` ### Computer Left Click Config - `interface ComputerLeftClickConfig` `left_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Left Click Drag Config - `interface ComputerLeftClickDragConfig` `left_click_drag`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Left Click Drag Input - `interface ComputerLeftClickDragInput` Click and drag the cursor from `start_coordinate` to `coordinate`. - `coordinate: Array` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `start_coordinate: Array` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Computer Left Click Drag Tool Use Block - `interface ComputerLeftClickDragToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerLeftClickDragInput` Click and drag the cursor from `start_coordinate` to `coordinate`. - `coordinate: Array` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `start_coordinate: Array` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "left_click_drag"` - `toolset_name: "computer"` ### Computer Left Click Input - `interface ComputerLeftClickInput` Click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Computer Left Click Tool Use Block - `interface ComputerLeftClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerLeftClickInput` Click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "left_click"` - `toolset_name: "computer"` ### Computer Left Mouse Down Config - `interface ComputerLeftMouseDownConfig` `left_mouse_down`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Left Mouse Down Input - `interface ComputerLeftMouseDownInput` Press and hold the left mouse button at the current cursor position. ### Computer Left Mouse Down Tool Use Block - `interface ComputerLeftMouseDownToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerLeftMouseDownInput` Press and hold the left mouse button at the current cursor position. - `name: "left_mouse_down"` - `toolset_name: "computer"` ### Computer Left Mouse Up Config - `interface ComputerLeftMouseUpConfig` `left_mouse_up`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Left Mouse Up Input - `interface ComputerLeftMouseUpInput` Release the left mouse button. ### Computer Left Mouse Up Tool Use Block - `interface ComputerLeftMouseUpToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerLeftMouseUpInput` Release the left mouse button. - `name: "left_mouse_up"` - `toolset_name: "computer"` ### Computer Middle Click Config - `interface ComputerMiddleClickConfig` `middle_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Middle Click Input - `interface ComputerMiddleClickInput` Click the middle mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Computer Middle Click Tool Use Block - `interface ComputerMiddleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerMiddleClickInput` Click the middle mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "middle_click"` - `toolset_name: "computer"` ### Computer Mouse Move Config - `interface ComputerMouseMoveConfig` `mouse_move`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Mouse Move Input - `interface ComputerMouseMoveInput` Move the cursor to a specified (x, y) pixel coordinate. Use this ONLY to hover without clicking; otherwise use a click action directly. - `coordinate: Array` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 ### Computer Mouse Move Tool Use Block - `interface ComputerMouseMoveToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerMouseMoveInput` Move the cursor to a specified (x, y) pixel coordinate. Use this ONLY to hover without clicking; otherwise use a click action directly. - `coordinate: Array` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `name: "mouse_move"` - `toolset_name: "computer"` ### Computer Right Click Config - `interface ComputerRightClickConfig` `right_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Right Click Input - `interface ComputerRightClickInput` Click the right mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Computer Right Click Tool Use Block - `interface ComputerRightClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerRightClickInput` Click the right mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "right_click"` - `toolset_name: "computer"` ### Computer Screenshot Config - `interface ComputerScreenshotConfig` `screenshot`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Screenshot Input - `interface ComputerScreenshotInput` Take a screenshot of the screen. ### Computer Screenshot Tool Use Block - `interface ComputerScreenshotToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerScreenshotInput` Take a screenshot of the screen. - `name: "screenshot"` - `toolset_name: "computer"` ### Computer Scroll Config - `interface ComputerScrollConfig` `scroll`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Scroll Direction - `type ComputerScrollDirection = "up" | "down" | "left" | "right"` - `"up"` - `"down"` - `"left"` - `"right"` ### Computer Scroll Input - `interface ComputerScrollInput` Scroll the screen at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. Do NOT use PageUp/PageDown to scroll. - `scroll_amount: number` Number of 'clicks' of the scroll wheel. - `scroll_direction: ComputerScrollDirection` - `"up"` - `"down"` - `"left"` - `"right"` - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Computer Scroll Tool Use Block - `interface ComputerScrollToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerScrollInput` Scroll the screen at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. Do NOT use PageUp/PageDown to scroll. - `scroll_amount: number` Number of 'clicks' of the scroll wheel. - `scroll_direction: ComputerScrollDirection` - `"up"` - `"down"` - `"left"` - `"right"` - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "scroll"` - `toolset_name: "computer"` ### Computer Tool Use Block - `type ComputerToolUseBlock = ComputerKeyToolUseBlock | ComputerHoldKeyToolUseBlock | ComputerTypeToolUseBlock | 14 more` - `interface ComputerKeyToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerKeyInput` Press a key or key-combination on the keyboard. Use "+" to combine modifiers with a key (e.g. "ctrl+s", "alt+Tab", "ctrl+shift+Escape"). Key names are case-insensitive; common names like "Return", "Tab", "Escape", "Up", "Down", "Left", "Right", "Home", "End", "Page_Up", "Page_Down", "Delete", "BackSpace" are supported. - `text: string` The key or key-combination to press. - `repeat?: number | null` Number of times to repeat the key press. Default is 1. minimum: 1, maximum: 100 - `name: "key"` - `toolset_name: "computer"` - `interface ComputerHoldKeyToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerHoldKeyInput` Hold down a key or key-combination for a specified duration. Uses the same key syntax as `key`. - `duration: number` Duration to hold the key, in seconds. maximum: 300 - `text: string` The key or key-combination to hold. - `name: "hold_key"` - `toolset_name: "computer"` - `interface ComputerTypeToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerTypeInput` Type a string of text on the keyboard. - `text: string` The text to type. - `name: "type"` - `toolset_name: "computer"` - `interface ComputerCursorPositionToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerCursorPositionInput` Get the current (x, y) pixel coordinate of the cursor. - `name: "cursor_position"` - `toolset_name: "computer"` - `interface ComputerMouseMoveToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerMouseMoveInput` Move the cursor to a specified (x, y) pixel coordinate. Use this ONLY to hover without clicking; otherwise use a click action directly. - `coordinate: Array` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `name: "mouse_move"` - `toolset_name: "computer"` - `interface ComputerLeftMouseDownToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerLeftMouseDownInput` Press and hold the left mouse button at the current cursor position. - `name: "left_mouse_down"` - `toolset_name: "computer"` - `interface ComputerLeftMouseUpToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerLeftMouseUpInput` Release the left mouse button. - `name: "left_mouse_up"` - `toolset_name: "computer"` - `interface ComputerLeftClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerLeftClickInput` Click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "left_click"` - `toolset_name: "computer"` - `interface ComputerLeftClickDragToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerLeftClickDragInput` Click and drag the cursor from `start_coordinate` to `coordinate`. - `coordinate: Array` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `start_coordinate: Array` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "left_click_drag"` - `toolset_name: "computer"` - `interface ComputerRightClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerRightClickInput` Click the right mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "right_click"` - `toolset_name: "computer"` - `interface ComputerMiddleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerMiddleClickInput` Click the middle mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "middle_click"` - `toolset_name: "computer"` - `interface ComputerDoubleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerDoubleClickInput` Double-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "double_click"` - `toolset_name: "computer"` - `interface ComputerTripleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerTripleClickInput` Triple-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "triple_click"` - `toolset_name: "computer"` - `interface ComputerScrollToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerScrollInput` Scroll the screen at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. Do NOT use PageUp/PageDown to scroll. - `scroll_amount: number` Number of 'clicks' of the scroll wheel. - `scroll_direction: ComputerScrollDirection` - `"up"` - `"down"` - `"left"` - `"right"` - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "scroll"` - `toolset_name: "computer"` - `interface ComputerWaitToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerWaitInput` Wait for a specified duration. - `duration: number` Duration to wait, in seconds. maximum: 300 - `name: "wait"` - `toolset_name: "computer"` - `interface ComputerScreenshotToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerScreenshotInput` Take a screenshot of the screen. - `name: "screenshot"` - `toolset_name: "computer"` - `interface ComputerZoomToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerZoomInput` Take a screenshot of a rectangular region. Region coordinates are in the full-screenshot space (not physical display pixels). The crop is scaled up to fill the image budget so fine details become legible. - `region: Array` (x0, y0, x1, y1): The region to capture. minItems: 4, maxItems: 4 - `name: "zoom"` - `toolset_name: "computer"` ### Computer Toolset 20260801 - `interface ComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `type: "computer_toolset_20260801"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `configs?: ComputerToolsetConfigs | null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type?: ComputerTypeConfig | null` `type`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `cursor_position?: ComputerCursorPositionConfig | null` `cursor_position`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click?: ComputerDoubleClickConfig | null` `double_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key?: ComputerHoldKeyConfig | null` `hold_key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key?: ComputerKeyConfig | null` `key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click?: ComputerLeftClickConfig | null` `left_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag?: ComputerLeftClickDragConfig | null` `left_click_drag`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down?: ComputerLeftMouseDownConfig | null` `left_mouse_down`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up?: ComputerLeftMouseUpConfig | null` `left_mouse_up`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click?: ComputerMiddleClickConfig | null` `middle_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move?: ComputerMouseMoveConfig | null` `mouse_move`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click?: ComputerRightClickConfig | null` `right_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot?: ComputerScreenshotConfig | null` `screenshot`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll?: ComputerScrollConfig | null` `scroll`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click?: ComputerTripleClickConfig | null` `triple_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait?: ComputerWaitConfig | null` `wait`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom?: ComputerZoomConfig | null` `zoom`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Toolset Configs - `interface ComputerToolsetConfigs` Per-member configuration for `computer_toolset_20260801`: one optional field per member tool, keyed by the member name — the same name the member's `tool_use` blocks carry. Every member is an accepted key, and a member's defaults apply wherever its key is absent. Unknown keys are rejected: the field set is this toolset version's complete member set. - `type?: ComputerTypeConfig | null` `type`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `cursor_position?: ComputerCursorPositionConfig | null` `cursor_position`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click?: ComputerDoubleClickConfig | null` `double_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key?: ComputerHoldKeyConfig | null` `hold_key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key?: ComputerKeyConfig | null` `key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click?: ComputerLeftClickConfig | null` `left_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag?: ComputerLeftClickDragConfig | null` `left_click_drag`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down?: ComputerLeftMouseDownConfig | null` `left_mouse_down`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up?: ComputerLeftMouseUpConfig | null` `left_mouse_up`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click?: ComputerMiddleClickConfig | null` `middle_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move?: ComputerMouseMoveConfig | null` `mouse_move`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click?: ComputerRightClickConfig | null` `right_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot?: ComputerScreenshotConfig | null` `screenshot`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll?: ComputerScrollConfig | null` `scroll`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click?: ComputerTripleClickConfig | null` `triple_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait?: ComputerWaitConfig | null` `wait`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom?: ComputerZoomConfig | null` `zoom`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Triple Click Config - `interface ComputerTripleClickConfig` `triple_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Triple Click Input - `interface ComputerTripleClickInput` Triple-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Computer Triple Click Tool Use Block - `interface ComputerTripleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerTripleClickInput` Triple-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "triple_click"` - `toolset_name: "computer"` ### Computer Type Config - `interface ComputerTypeConfig` `type`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Type Input - `interface ComputerTypeInput` Type a string of text on the keyboard. - `text: string` The text to type. ### Computer Type Tool Use Block - `interface ComputerTypeToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerTypeInput` Type a string of text on the keyboard. - `text: string` The text to type. - `name: "type"` - `toolset_name: "computer"` ### Computer Wait Config - `interface ComputerWaitConfig` `wait`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Wait Input - `interface ComputerWaitInput` Wait for a specified duration. - `duration: number` Duration to wait, in seconds. maximum: 300 ### Computer Wait Tool Use Block - `interface ComputerWaitToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerWaitInput` Wait for a specified duration. - `duration: number` Duration to wait, in seconds. maximum: 300 - `name: "wait"` - `toolset_name: "computer"` ### Computer Zoom Config - `interface ComputerZoomConfig` `zoom`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Zoom Input - `interface ComputerZoomInput` Take a screenshot of a rectangular region. Region coordinates are in the full-screenshot space (not physical display pixels). The crop is scaled up to fill the image budget so fine details become legible. - `region: Array` (x0, y0, x1, y1): The region to capture. minItems: 4, maxItems: 4 ### Computer Zoom Tool Use Block - `interface ComputerZoomToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: ComputerZoomInput` Take a screenshot of a rectangular region. Region coordinates are in the full-screenshot space (not physical display pixels). The crop is scaled up to fill the image budget so fine details become legible. - `region: Array` (x0, y0, x1, y1): The region to capture. minItems: 4, maxItems: 4 - `name: "zoom"` - `toolset_name: "computer"` ### Container - `interface Container` Information about the container used in the request (for the code execution tool) - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. format: date-time - `skills: Array | null` Skills loaded in the container - `type: "anthropic" | "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version: string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 ### Container Params - `interface ContainerParams` Container parameters with skills to be loaded. - `id?: string | null` Container id - `skills?: Array | null` List of skills to load in the container maxItems: 20 - `type: "anthropic" | "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version?: string` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 ### Container Skill - `interface ContainerSkill` A skill that was loaded in a container (response model). - `type: "anthropic" | "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version: string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 ### Container Upload Block - `interface ContainerUploadBlock` Response model for a file uploaded to the container. - `type: "container_upload"` default: container_upload - `file_id: string` ### Container Upload Block Param - `interface ContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `type: "container_upload"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` ### Content Block - `type ContentBlock = TextBlock | ThinkingBlock | RedactedThinkingBlock | 9 more` - `interface TextBlock` - `type: "text"` default: text - `citations: Array | null` Citations supporting the text block. The 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`. - `interface CitationCharLocation` - `type: "char_location"` default: char_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` minimum: 0 - `interface CitationPageLocation` - `type: "page_location"` default: page_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocation` - `type: "content_block_location"` default: content_block_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `file_id: string | null` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationsWebSearchResultLocation` - `type: "web_search_result_location"` default: web_search_result_location - `cited_text: string` - `encrypted_index: string` - `title: string | null` maxLength: 512 - `url: string` - `interface CitationsSearchResultLocation` - `type: "search_result_location"` default: search_result_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `text: string` - `interface ThinkingBlock` - `type: "thinking"` default: thinking - `signature: string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript) for details. - `thinking: string` The text of Claude's thinking process for this block. - `interface RedactedThinkingBlock` - `type: "redacted_thinking"` default: redacted_thinking - `data: string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript#redacted-thinking-blocks) for details. - `interface ToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: Record` - `name: string` minLength: 1 - `toolset_name?: string | null` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ServerToolUseBlock` - `type: "server_tool_use"` default: server_tool_use - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `input: Record` - `name: "web_search" | "web_fetch" | "code_execution" | 4 more` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `interface WebSearchToolResultBlock` - `type: "web_search_tool_result"` default: web_search_tool_result - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `content: WebSearchToolResultBlockContent` - `interface WebSearchToolResultError` - `type: "web_search_tool_result_error"` default: web_search_tool_result_error - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `Array` - `type: "web_search_result"` default: web_search_result - `encrypted_content: string` - `page_age: string | null` - `title: string` - `url: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface WebFetchToolResultBlock` - `type: "web_fetch_tool_result"` default: web_fetch_tool_result - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `content: WebFetchToolResultErrorBlock | WebFetchBlock` - `interface WebFetchToolResultErrorBlock` - `type: "web_fetch_tool_result_error"` default: web_fetch_tool_result_error - `error_code: WebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `interface WebFetchBlock` - `type: "web_fetch_result"` default: web_fetch_result - `content: DocumentBlock` - `type: "document"` default: document - `citations: CitationsConfig | null` Citation configuration for the document - `enabled: boolean` default: false - `source: Base64PDFSource | PlainTextSource` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `title: string | null` The title of the document - `retrieved_at: string | null` ISO 8601 timestamp when the content was retrieved - `url: string` Fetched content URL - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface CodeExecutionToolResultBlock` - `type: "code_execution_tool_result"` default: code_execution_tool_result - `content: CodeExecutionToolResultBlockContent` - `interface CodeExecutionToolResultError` - `type: "code_execution_tool_result_error"` default: code_execution_tool_result_error - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `interface CodeExecutionResultBlock` - `type: "code_execution_result"` default: code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `interface EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` default: encrypted_code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface BashCodeExecutionToolResultBlock` - `type: "bash_code_execution_tool_result"` default: bash_code_execution_tool_result - `content: BashCodeExecutionToolResultError | BashCodeExecutionResultBlock` - `interface BashCodeExecutionToolResultError` - `type: "bash_code_execution_tool_result_error"` default: bash_code_execution_tool_result_error - `error_code: BashCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `interface BashCodeExecutionResultBlock` - `type: "bash_code_execution_result"` default: bash_code_execution_result - `content: Array` - `type: "bash_code_execution_output"` default: bash_code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface TextEditorCodeExecutionToolResultBlock` - `type: "text_editor_code_execution_tool_result"` default: text_editor_code_execution_tool_result - `content: TextEditorCodeExecutionToolResultError | TextEditorCodeExecutionViewResultBlock | TextEditorCodeExecutionCreateResultBlock | TextEditorCodeExecutionStrReplaceResultBlock` - `interface TextEditorCodeExecutionToolResultError` - `type: "text_editor_code_execution_tool_result_error"` default: text_editor_code_execution_tool_result_error - `error_code: TextEditorCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message: string | null` - `interface TextEditorCodeExecutionViewResultBlock` - `type: "text_editor_code_execution_view_result"` default: text_editor_code_execution_view_result - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `interface TextEditorCodeExecutionCreateResultBlock` - `type: "text_editor_code_execution_create_result"` default: text_editor_code_execution_create_result - `is_file_update: boolean` - `interface TextEditorCodeExecutionStrReplaceResultBlock` - `type: "text_editor_code_execution_str_replace_result"` default: text_editor_code_execution_str_replace_result - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ToolSearchToolResultBlock` - `type: "tool_search_tool_result"` default: tool_search_tool_result - `content: ToolSearchToolResultError | ToolSearchToolSearchResultBlock` - `interface ToolSearchToolResultError` - `type: "tool_search_tool_result_error"` default: tool_search_tool_result_error - `error_code: ToolSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message: string | null` - `interface ToolSearchToolSearchResultBlock` - `type: "tool_search_tool_search_result"` default: tool_search_tool_search_result - `tool_references: Array` - `type: "tool_reference"` default: tool_reference - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ContainerUploadBlock` Response model for a file uploaded to the container. - `type: "container_upload"` default: container_upload - `file_id: string` ### Content Block Param - `type ContentBlockParam = TextBlockParam | ImageBlockParam | DocumentBlockParam | 13 more` - `interface TextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `citations?: Array | null` - `interface CitationCharLocationParam` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `interface CitationPageLocationParam` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocationParam` - `type: "content_block_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationWebSearchResultLocationParam` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string | null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `interface CitationSearchResultLocationParam` - `type: "search_result_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `interface ImageBlockParam` - `type: "image"` - `source: Base64ImageSource | URLImageSource | FileImageSource` - `interface Base64ImageSource` - `type: "base64"` - `data: string` format: byte - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `interface URLImageSource` - `type: "url"` - `url: string` - `interface FileImageSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `transformations?: ImageTransformationsParam | null` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `oversized_image?: "downsize" | "error"` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `"downsize"` - `"error"` - `interface DocumentBlockParam` - `type: "document"` - `source: Base64PDFSource | PlainTextSource | ContentBlockSource | 2 more` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `interface ContentBlockSource` - `type: "content"` - `content: string | Array` - `string` - `Array` - `interface TextBlockParam` - `interface ImageBlockParam` - `interface URLPDFSource` - `type: "url"` - `url: string` - `interface FileDocumentSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` - `enabled?: boolean` - `context?: string | null` minLength: 1 - `title?: string | null` minLength: 1, maxLength: 500 - `interface SearchResultBlockParam` - `type: "search_result"` - `content: Array` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `source: string` - `title: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam` - `interface ThinkingBlockParam` - `type: "thinking"` - `signature: string` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `thinking: string` The `thinking` text of this block as returned by the API. - `interface RedactedThinkingBlockParam` - `type: "redacted_thinking"` - `data: string` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `interface ToolUseBlockParam` - `type: "tool_use"` - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `input: Record` - `name: string` minLength: 1, maxLength: 200 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `toolset_name?: string | null` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ToolResultBlockParam` - `type: "tool_result"` - `tool_use_id: string` pattern: ^[a-zA-Z0-9_-]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | Array` - `string` - `Array` - `interface TextBlockParam` - `interface ImageBlockParam` - `interface SearchResultBlockParam` - `interface DocumentBlockParam` - `interface ToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface BrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `type: "browser_state"` - `tabs: Array` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `tab_id: string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `title: string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `active?: boolean` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `state_changes?: Array | null` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `interface BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `type: "tab_opened"` - `tab_id: string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `interface BrowserStateChangeDownloadStarted` A file download that started during this call. - `type: "download_started"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `interface BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `type: "download_completed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path?: string | null` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `size_bytes?: number | null` The completed download's size. minimum: 0 - `interface BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `type: "download_failed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `error?: string | null` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `is_error?: boolean` - `toolset_name?: string | null` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ServerToolUseBlockParam` - `type: "server_tool_use"` - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: Record` - `name: "web_search" | "web_fetch" | "code_execution" | 4 more` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `interface WebSearchToolResultBlockParam` - `type: "web_search_tool_result"` - `content: WebSearchToolResultBlockParamContent` - `Array` - `type: "web_search_result"` - `encrypted_content: string` - `title: string` - `url: string` - `page_age?: string | null` - `interface WebSearchToolRequestError` - `type: "web_search_tool_result_error"` - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `interface WebFetchToolResultBlockParam` - `type: "web_fetch_tool_result"` - `content: WebFetchToolResultErrorBlockParam | WebFetchBlockParam` - `interface WebFetchToolResultErrorBlockParam` - `type: "web_fetch_tool_result_error"` - `error_code: WebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `interface WebFetchBlockParam` - `type: "web_fetch_result"` - `content: DocumentBlockParam` - `url: string` Fetched content URL - `retrieved_at?: string | null` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `interface CodeExecutionToolResultBlockParam` - `type: "code_execution_tool_result"` - `content: CodeExecutionToolResultBlockParamContent` - `interface CodeExecutionToolResultErrorParam` - `type: "code_execution_tool_result_error"` - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `interface CodeExecutionResultBlockParam` - `type: "code_execution_result"` - `content: Array` - `type: "code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `interface EncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` - `content: Array` - `type: "code_execution_output"` - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface BashCodeExecutionToolResultBlockParam` - `type: "bash_code_execution_tool_result"` - `content: BashCodeExecutionToolResultErrorParam | BashCodeExecutionResultBlockParam` - `interface BashCodeExecutionToolResultErrorParam` - `type: "bash_code_execution_tool_result_error"` - `error_code: BashCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `interface BashCodeExecutionResultBlockParam` - `type: "bash_code_execution_result"` - `content: Array` - `type: "bash_code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface TextEditorCodeExecutionToolResultBlockParam` - `type: "text_editor_code_execution_tool_result"` - `content: TextEditorCodeExecutionToolResultErrorParam | TextEditorCodeExecutionViewResultBlockParam | TextEditorCodeExecutionCreateResultBlockParam | TextEditorCodeExecutionStrReplaceResultBlockParam` - `interface TextEditorCodeExecutionToolResultErrorParam` - `type: "text_editor_code_execution_tool_result_error"` - `error_code: TextEditorCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message?: string | null` - `interface TextEditorCodeExecutionViewResultBlockParam` - `type: "text_editor_code_execution_view_result"` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines?: number | null` - `start_line?: number | null` - `total_lines?: number | null` - `interface TextEditorCodeExecutionCreateResultBlockParam` - `type: "text_editor_code_execution_create_result"` - `is_file_update: boolean` - `interface TextEditorCodeExecutionStrReplaceResultBlockParam` - `type: "text_editor_code_execution_str_replace_result"` - `lines?: Array | null` - `new_lines?: number | null` - `new_start?: number | null` - `old_lines?: number | null` - `old_start?: number | null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface ToolSearchToolResultBlockParam` - `type: "tool_search_tool_result"` - `content: ToolSearchToolResultErrorParam | ToolSearchToolSearchResultBlockParam` - `interface ToolSearchToolResultErrorParam` - `type: "tool_search_tool_result_error"` - `error_code: ToolSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message?: string | null` - `interface ToolSearchToolSearchResultBlockParam` - `type: "tool_search_tool_search_result"` - `tool_references: Array` - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface ContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `type: "container_upload"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. ### Content Block Source - `interface ContentBlockSource` - `type: "content"` - `content: string | Array` - `string` - `Array` - `interface TextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `citations?: Array | null` - `interface CitationCharLocationParam` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `interface CitationPageLocationParam` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocationParam` - `type: "content_block_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationWebSearchResultLocationParam` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string | null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `interface CitationSearchResultLocationParam` - `type: "search_result_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `interface ImageBlockParam` - `type: "image"` - `source: Base64ImageSource | URLImageSource | FileImageSource` - `interface Base64ImageSource` - `type: "base64"` - `data: string` format: byte - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `interface URLImageSource` - `type: "url"` - `url: string` - `interface FileImageSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `transformations?: ImageTransformationsParam | null` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `oversized_image?: "downsize" | "error"` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `"downsize"` - `"error"` ### Content Block Source Content - `type ContentBlockSourceContent = TextBlockParam | ImageBlockParam` - `interface TextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `citations?: Array | null` - `interface CitationCharLocationParam` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `interface CitationPageLocationParam` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocationParam` - `type: "content_block_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationWebSearchResultLocationParam` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string | null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `interface CitationSearchResultLocationParam` - `type: "search_result_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `interface ImageBlockParam` - `type: "image"` - `source: Base64ImageSource | URLImageSource | FileImageSource` - `interface Base64ImageSource` - `type: "base64"` - `data: string` format: byte - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `interface URLImageSource` - `type: "url"` - `url: string` - `interface FileImageSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `transformations?: ImageTransformationsParam | null` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `oversized_image?: "downsize" | "error"` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `"downsize"` - `"error"` ### Diagnostics - `interface Diagnostics` Request-level diagnostics: why the prompt cache could not fully reuse the prefix of the request named by `diagnostics.previous_message_id`. - `cache_miss_reason: CacheMissReason | null` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `interface CacheMissModelChanged` - `type: "model_changed"` default: model_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissSystemChanged` - `type: "system_changed"` default: system_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissToolsChanged` - `type: "tools_changed"` default: tools_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissMessagesChanged` - `type: "messages_changed"` default: messages_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissPreviousMessageNotFound` - `type: "previous_message_not_found"` default: previous_message_not_found - `interface CacheMissUnavailable` - `type: "unavailable"` default: unavailable ### Diagnostics Param - `interface DiagnosticsParam` Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting. - `previous_message_id?: string | null` The `id` (`msg_...`) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns `diagnostics.cache_miss_reason` when the prompt-cache prefix could not be reused. Pass `null` on the first turn to opt in without a prior message to compare. maxLength: 256 ### Direct Caller - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` ### Document Block - `interface DocumentBlock` - `type: "document"` default: document - `citations: CitationsConfig | null` Citation configuration for the document - `enabled: boolean` default: false - `source: Base64PDFSource | PlainTextSource` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `title: string | null` The title of the document ### Document Block Param - `interface DocumentBlockParam` - `type: "document"` - `source: Base64PDFSource | PlainTextSource | ContentBlockSource | 2 more` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `interface ContentBlockSource` - `type: "content"` - `content: string | Array` - `string` - `Array` - `interface TextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `citations?: Array | null` - `interface CitationCharLocationParam` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `interface CitationPageLocationParam` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocationParam` - `type: "content_block_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationWebSearchResultLocationParam` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string | null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `interface CitationSearchResultLocationParam` - `type: "search_result_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `interface ImageBlockParam` - `type: "image"` - `source: Base64ImageSource | URLImageSource | FileImageSource` - `interface Base64ImageSource` - `type: "base64"` - `data: string` format: byte - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `interface URLImageSource` - `type: "url"` - `url: string` - `interface FileImageSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `transformations?: ImageTransformationsParam | null` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `oversized_image?: "downsize" | "error"` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `"downsize"` - `"error"` - `interface URLPDFSource` - `type: "url"` - `url: string` - `interface FileDocumentSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` - `enabled?: boolean` - `context?: string | null` minLength: 1 - `title?: string | null` minLength: 1, maxLength: 500 ### Encrypted Code Execution Result Block - `interface EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` default: encrypted_code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` ### Encrypted Code Execution Result Block Param - `interface EncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` - `content: Array` - `type: "code_execution_output"` - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` ### File Document Source - `interface FileDocumentSource` - `type: "file"` - `file_id: string` ### File Image Source - `interface FileImageSource` - `type: "file"` - `file_id: string` ### Image Block Param - `interface ImageBlockParam` - `type: "image"` - `source: Base64ImageSource | URLImageSource | FileImageSource` - `interface Base64ImageSource` - `type: "base64"` - `data: string` format: byte - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `interface URLImageSource` - `type: "url"` - `url: string` - `interface FileImageSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `transformations?: ImageTransformationsParam | null` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `oversized_image?: "downsize" | "error"` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `"downsize"` - `"error"` ### Image Transformations Param - `interface ImageTransformationsParam` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `oversized_image?: "downsize" | "error"` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `"downsize"` - `"error"` ### Input JSON Delta - `interface InputJSONDelta` - `type: "input_json_delta"` default: input_json_delta - `partial_json: string` ### JSON Output Format - `interface JSONOutputFormat` - `type: "json_schema"` - `schema: Record` The JSON schema of the format ### Memory Tool 20250818 - `interface MemoryTool20250818` - `type: "memory_20250818"` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Message - `interface Message` - `type: "message"` Object type. For Messages, this is always `"message"`. default: message - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: Container | null` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. format: date-time - `skills: Array | null` Skills loaded in the container - `type: "anthropic" | "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version: string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `content: Array` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If 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. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `interface TextBlock` - `type: "text"` default: text - `citations: Array | null` Citations supporting the text block. The 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`. - `interface CitationCharLocation` - `type: "char_location"` default: char_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` minimum: 0 - `interface CitationPageLocation` - `type: "page_location"` default: page_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocation` - `type: "content_block_location"` default: content_block_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `file_id: string | null` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationsWebSearchResultLocation` - `type: "web_search_result_location"` default: web_search_result_location - `cited_text: string` - `encrypted_index: string` - `title: string | null` maxLength: 512 - `url: string` - `interface CitationsSearchResultLocation` - `type: "search_result_location"` default: search_result_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `text: string` - `interface ThinkingBlock` - `type: "thinking"` default: thinking - `signature: string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript) for details. - `thinking: string` The text of Claude's thinking process for this block. - `interface RedactedThinkingBlock` - `type: "redacted_thinking"` default: redacted_thinking - `data: string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript#redacted-thinking-blocks) for details. - `interface ToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: Record` - `name: string` minLength: 1 - `toolset_name?: string | null` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ServerToolUseBlock` - `type: "server_tool_use"` default: server_tool_use - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `input: Record` - `name: "web_search" | "web_fetch" | "code_execution" | 4 more` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `interface WebSearchToolResultBlock` - `type: "web_search_tool_result"` default: web_search_tool_result - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `content: WebSearchToolResultBlockContent` - `interface WebSearchToolResultError` - `type: "web_search_tool_result_error"` default: web_search_tool_result_error - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `Array` - `type: "web_search_result"` default: web_search_result - `encrypted_content: string` - `page_age: string | null` - `title: string` - `url: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface WebFetchToolResultBlock` - `type: "web_fetch_tool_result"` default: web_fetch_tool_result - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `content: WebFetchToolResultErrorBlock | WebFetchBlock` - `interface WebFetchToolResultErrorBlock` - `type: "web_fetch_tool_result_error"` default: web_fetch_tool_result_error - `error_code: WebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `interface WebFetchBlock` - `type: "web_fetch_result"` default: web_fetch_result - `content: DocumentBlock` - `type: "document"` default: document - `citations: CitationsConfig | null` Citation configuration for the document - `enabled: boolean` default: false - `source: Base64PDFSource | PlainTextSource` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `title: string | null` The title of the document - `retrieved_at: string | null` ISO 8601 timestamp when the content was retrieved - `url: string` Fetched content URL - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface CodeExecutionToolResultBlock` - `type: "code_execution_tool_result"` default: code_execution_tool_result - `content: CodeExecutionToolResultBlockContent` - `interface CodeExecutionToolResultError` - `type: "code_execution_tool_result_error"` default: code_execution_tool_result_error - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `interface CodeExecutionResultBlock` - `type: "code_execution_result"` default: code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `interface EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` default: encrypted_code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface BashCodeExecutionToolResultBlock` - `type: "bash_code_execution_tool_result"` default: bash_code_execution_tool_result - `content: BashCodeExecutionToolResultError | BashCodeExecutionResultBlock` - `interface BashCodeExecutionToolResultError` - `type: "bash_code_execution_tool_result_error"` default: bash_code_execution_tool_result_error - `error_code: BashCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `interface BashCodeExecutionResultBlock` - `type: "bash_code_execution_result"` default: bash_code_execution_result - `content: Array` - `type: "bash_code_execution_output"` default: bash_code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface TextEditorCodeExecutionToolResultBlock` - `type: "text_editor_code_execution_tool_result"` default: text_editor_code_execution_tool_result - `content: TextEditorCodeExecutionToolResultError | TextEditorCodeExecutionViewResultBlock | TextEditorCodeExecutionCreateResultBlock | TextEditorCodeExecutionStrReplaceResultBlock` - `interface TextEditorCodeExecutionToolResultError` - `type: "text_editor_code_execution_tool_result_error"` default: text_editor_code_execution_tool_result_error - `error_code: TextEditorCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message: string | null` - `interface TextEditorCodeExecutionViewResultBlock` - `type: "text_editor_code_execution_view_result"` default: text_editor_code_execution_view_result - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `interface TextEditorCodeExecutionCreateResultBlock` - `type: "text_editor_code_execution_create_result"` default: text_editor_code_execution_create_result - `is_file_update: boolean` - `interface TextEditorCodeExecutionStrReplaceResultBlock` - `type: "text_editor_code_execution_str_replace_result"` default: text_editor_code_execution_str_replace_result - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ToolSearchToolResultBlock` - `type: "tool_search_tool_result"` default: tool_search_tool_result - `content: ToolSearchToolResultError | ToolSearchToolSearchResultBlock` - `interface ToolSearchToolResultError` - `type: "tool_search_tool_result_error"` default: tool_search_tool_result_error - `error_code: ToolSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message: string | null` - `interface ToolSearchToolSearchResultBlock` - `type: "tool_search_tool_search_result"` default: tool_search_tool_search_result - `tool_references: Array` - `type: "tool_reference"` default: tool_reference - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ContainerUploadBlock` Response model for a file uploaded to the container. - `type: "container_upload"` default: container_upload - `file_id: string` - `diagnostics: Diagnostics | null` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `cache_miss_reason: CacheMissReason | null` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `interface CacheMissModelChanged` - `type: "model_changed"` default: model_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissSystemChanged` - `type: "system_changed"` default: system_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissToolsChanged` - `type: "tools_changed"` default: tools_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissMessagesChanged` - `type: "messages_changed"` default: messages_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissPreviousMessageNotFound` - `type: "previous_message_not_found"` default: previous_message_not_found - `interface CacheMissUnavailable` - `type: "unavailable"` default: unavailable - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-mythos-5"` Most capable model for cybersecurity and biology research - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `(string & {})` - `role: "assistant"` Conversational role of the generated message. This will always be `"assistant"`. default: assistant - `stop_details: RefusalStopDetails | null` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `type: "refusal"` default: refusal - `category: "cyber" | "bio" | "frontier_llm" | 2 more | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `"bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `"frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `"reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=typescript). - `"general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `explanation: string | null` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `stop_reason: StopReason | null` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"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. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations * `"model_context_window_exceeded"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string | null` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `usage: Usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under 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. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `cache_creation: CacheCreation | null` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `cache_creation_input_tokens: number | null` The number of input tokens used to create the cache entry. minimum: 0 - `cache_read_input_tokens: number | null` The number of input tokens read from the cache. minimum: 0 - `inference_geo: string | null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. minimum: 0 - `output_tokens: number` The number of output tokens which were used. minimum: 0 - `output_tokens_details: OutputTokensDetails | null` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `thinking_tokens: number` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. default: 0, minimum: 0 - `server_tool_use: ServerToolUsage | null` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. default: 0, minimum: 0 - `web_search_requests: number` The number of web search tool requests. default: 0, minimum: 0 - `service_tier: "standard" | "priority" | "batch" | null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` ### Message Count Tokens Tool - `type MessageCountTokensTool = Tool | ToolBash20250124 | CodeExecutionTool20250522 | 18 more` - `interface Tool` - `type?: "custom" | null` - `input_schema: InputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `type: "object"` - `properties?: Record | null` - `required?: Array | null` - `name: string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `description?: string` Description of what this tool does. Tool 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. - `eager_input_streaming?: boolean | null` 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. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolBash20250124` - `type: "bash_20250124"` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20250522` - `type: "code_execution_20250522"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20250825` - `type: "code_execution_20250825"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `type: "code_execution_20260120"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20260521` Code execution tool with REPL state persistence. - `type: "code_execution_20260521"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface BrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `type: "browser_toolset_20260801"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `configs?: BrowserToolsetConfigs | null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type?: BrowserTypeConfig | null` `type`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `close_tab?: BrowserCloseTabConfig | null` `close_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click?: BrowserDoubleClickConfig | null` `double_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `file_upload?: BrowserFileUploadConfig | null` `file_upload`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `find?: BrowserFindConfig | null` `find`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `form_input?: BrowserFormInputConfig | null` `form_input`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `get_page_text?: BrowserGetPageTextConfig | null` `get_page_text`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key?: BrowserHoldKeyConfig | null` `hold_key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hover?: BrowserHoverConfig | null` `hover`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `javascript_exec?: BrowserJavascriptExecConfig | null` `javascript_exec`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key?: BrowserKeyConfig | null` `key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click?: BrowserLeftClickConfig | null` `left_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag?: BrowserLeftClickDragConfig | null` `left_click_drag`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down?: BrowserLeftMouseDownConfig | null` `left_mouse_down`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up?: BrowserLeftMouseUpConfig | null` `left_mouse_up`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `list_tabs?: BrowserListTabsConfig | null` `list_tabs`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click?: BrowserMiddleClickConfig | null` `middle_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move?: BrowserMouseMoveConfig | null` `mouse_move`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `navigate?: BrowserNavigateConfig | null` `navigate`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `new_tab?: BrowserNewTabConfig | null` `new_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_console?: BrowserReadConsoleConfig | null` `read_console`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_network?: BrowserReadNetworkConfig | null` `read_network`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_page?: BrowserReadPageConfig | null` `read_page`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click?: BrowserRightClickConfig | null` `right_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot?: BrowserScreenshotConfig | null` `screenshot`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll?: BrowserScrollConfig | null` `scroll`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll_to?: BrowserScrollToConfig | null` `scroll_to`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `switch_tab?: BrowserSwitchTabConfig | null` `switch_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click?: BrowserTripleClickConfig | null` `triple_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait?: BrowserWaitConfig | null` `wait`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom?: BrowserZoomConfig | null` `zoom`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `interface MemoryTool20250818` - `type: "memory_20250818"` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `type: "computer_toolset_20260801"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `configs?: ComputerToolsetConfigs | null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type?: ComputerTypeConfig | null` `type`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `cursor_position?: ComputerCursorPositionConfig | null` `cursor_position`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click?: ComputerDoubleClickConfig | null` `double_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key?: ComputerHoldKeyConfig | null` `hold_key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key?: ComputerKeyConfig | null` `key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click?: ComputerLeftClickConfig | null` `left_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag?: ComputerLeftClickDragConfig | null` `left_click_drag`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down?: ComputerLeftMouseDownConfig | null` `left_mouse_down`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up?: ComputerLeftMouseUpConfig | null` `left_mouse_up`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click?: ComputerMiddleClickConfig | null` `middle_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move?: ComputerMouseMoveConfig | null` `mouse_move`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click?: ComputerRightClickConfig | null` `right_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot?: ComputerScreenshotConfig | null` `screenshot`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll?: ComputerScrollConfig | null` `scroll`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click?: ComputerTripleClickConfig | null` `triple_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait?: ComputerWaitConfig | null` `wait`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom?: ComputerZoomConfig | null` `zoom`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `interface ToolTextEditor20250124` - `type: "text_editor_20250124"` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolTextEditor20250429` - `type: "text_editor_20250429"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolTextEditor20250728` - `type: "text_editor_20250728"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `max_characters?: number | null` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface WebSearchTool20250305` - `type: "web_search_20250305"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city?: string | null` The city of the user. minLength: 1, maxLength: 255 - `country?: string | null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `region?: string | null` The region of the user. minLength: 1, maxLength: 255 - `timezone?: string | null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `interface WebFetchTool20250910` - `type: "web_fetch_20250910"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `enabled?: boolean` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `client_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type: "all"` - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type: "none"` - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type: "only"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `type: "except"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `server_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `user_input?: WebFetchURLSourceAll | WebFetchURLSourceNone` Whether URLs in user messages are fetchable: "all" or "none". - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `interface WebSearchTool20260209` - `type: "web_search_20260209"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `interface WebFetchTool20260209` - `type: "web_fetch_20260209"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `interface WebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `type: "web_fetch_20260309"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache?: boolean` 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. - `interface WebSearchTool20260318` - `type: "web_search_20260318"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion?: "full" | "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `interface WebFetchTool20260318` - `type: "web_fetch_20260318"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion?: "full" | "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache?: boolean` 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. - `interface ToolSearchToolBm25_20251119` - `type: "tool_search_tool_bm25_20251119" | "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `name: "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolSearchToolRegex20251119` - `type: "tool_search_tool_regex_20251119" | "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `name: "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Message Create Params Container - `type MessageCreateParamsContainer = ContainerParams | string | null` Container identifier for reuse across requests. - `interface ContainerParams` Container parameters with skills to be loaded. - `id?: string | null` Container id - `skills?: Array | null` List of skills to load in the container maxItems: 20 - `type: "anthropic" | "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version?: string` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 - `string` ### Message Delta Usage - `interface MessageDeltaUsage` - `cache_creation_input_tokens: number | null` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `cache_read_input_tokens: number | null` The cumulative number of input tokens read from the cache. minimum: 0 - `input_tokens: number | null` The cumulative number of input tokens which were used. minimum: 0 - `output_tokens: number` The cumulative number of output tokens which were used. - `output_tokens_details: OutputTokensDetails | null` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `thinking_tokens: number` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. default: 0, minimum: 0 - `server_tool_use: ServerToolUsage | null` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. default: 0, minimum: 0 - `web_search_requests: number` The number of web search tool requests. default: 0, minimum: 0 ### Message Param - `interface MessageParam` - `content: string | Array` - `string` - `Array` - `interface TextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `citations?: Array | null` - `interface CitationCharLocationParam` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `interface CitationPageLocationParam` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocationParam` - `type: "content_block_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationWebSearchResultLocationParam` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string | null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `interface CitationSearchResultLocationParam` - `type: "search_result_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `interface ImageBlockParam` - `type: "image"` - `source: Base64ImageSource | URLImageSource | FileImageSource` - `interface Base64ImageSource` - `type: "base64"` - `data: string` format: byte - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `interface URLImageSource` - `type: "url"` - `url: string` - `interface FileImageSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `transformations?: ImageTransformationsParam | null` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `oversized_image?: "downsize" | "error"` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `"downsize"` - `"error"` - `interface DocumentBlockParam` - `type: "document"` - `source: Base64PDFSource | PlainTextSource | ContentBlockSource | 2 more` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `interface ContentBlockSource` - `type: "content"` - `content: string | Array` - `string` - `Array` - `interface TextBlockParam` - `interface ImageBlockParam` - `interface URLPDFSource` - `type: "url"` - `url: string` - `interface FileDocumentSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` - `enabled?: boolean` - `context?: string | null` minLength: 1 - `title?: string | null` minLength: 1, maxLength: 500 - `interface SearchResultBlockParam` - `type: "search_result"` - `content: Array` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `source: string` - `title: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam` - `interface ThinkingBlockParam` - `type: "thinking"` - `signature: string` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `thinking: string` The `thinking` text of this block as returned by the API. - `interface RedactedThinkingBlockParam` - `type: "redacted_thinking"` - `data: string` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `interface ToolUseBlockParam` - `type: "tool_use"` - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `input: Record` - `name: string` minLength: 1, maxLength: 200 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `toolset_name?: string | null` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ToolResultBlockParam` - `type: "tool_result"` - `tool_use_id: string` pattern: ^[a-zA-Z0-9_-]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | Array` - `string` - `Array` - `interface TextBlockParam` - `interface ImageBlockParam` - `interface SearchResultBlockParam` - `interface DocumentBlockParam` - `interface ToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface BrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `type: "browser_state"` - `tabs: Array` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `tab_id: string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `title: string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `active?: boolean` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `state_changes?: Array | null` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `interface BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `type: "tab_opened"` - `tab_id: string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `interface BrowserStateChangeDownloadStarted` A file download that started during this call. - `type: "download_started"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `interface BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `type: "download_completed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path?: string | null` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `size_bytes?: number | null` The completed download's size. minimum: 0 - `interface BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `type: "download_failed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `error?: string | null` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `is_error?: boolean` - `toolset_name?: string | null` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ServerToolUseBlockParam` - `type: "server_tool_use"` - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: Record` - `name: "web_search" | "web_fetch" | "code_execution" | 4 more` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `interface WebSearchToolResultBlockParam` - `type: "web_search_tool_result"` - `content: WebSearchToolResultBlockParamContent` - `Array` - `type: "web_search_result"` - `encrypted_content: string` - `title: string` - `url: string` - `page_age?: string | null` - `interface WebSearchToolRequestError` - `type: "web_search_tool_result_error"` - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `interface WebFetchToolResultBlockParam` - `type: "web_fetch_tool_result"` - `content: WebFetchToolResultErrorBlockParam | WebFetchBlockParam` - `interface WebFetchToolResultErrorBlockParam` - `type: "web_fetch_tool_result_error"` - `error_code: WebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `interface WebFetchBlockParam` - `type: "web_fetch_result"` - `content: DocumentBlockParam` - `url: string` Fetched content URL - `retrieved_at?: string | null` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `interface CodeExecutionToolResultBlockParam` - `type: "code_execution_tool_result"` - `content: CodeExecutionToolResultBlockParamContent` - `interface CodeExecutionToolResultErrorParam` - `type: "code_execution_tool_result_error"` - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `interface CodeExecutionResultBlockParam` - `type: "code_execution_result"` - `content: Array` - `type: "code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `interface EncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` - `content: Array` - `type: "code_execution_output"` - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface BashCodeExecutionToolResultBlockParam` - `type: "bash_code_execution_tool_result"` - `content: BashCodeExecutionToolResultErrorParam | BashCodeExecutionResultBlockParam` - `interface BashCodeExecutionToolResultErrorParam` - `type: "bash_code_execution_tool_result_error"` - `error_code: BashCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `interface BashCodeExecutionResultBlockParam` - `type: "bash_code_execution_result"` - `content: Array` - `type: "bash_code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface TextEditorCodeExecutionToolResultBlockParam` - `type: "text_editor_code_execution_tool_result"` - `content: TextEditorCodeExecutionToolResultErrorParam | TextEditorCodeExecutionViewResultBlockParam | TextEditorCodeExecutionCreateResultBlockParam | TextEditorCodeExecutionStrReplaceResultBlockParam` - `interface TextEditorCodeExecutionToolResultErrorParam` - `type: "text_editor_code_execution_tool_result_error"` - `error_code: TextEditorCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message?: string | null` - `interface TextEditorCodeExecutionViewResultBlockParam` - `type: "text_editor_code_execution_view_result"` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines?: number | null` - `start_line?: number | null` - `total_lines?: number | null` - `interface TextEditorCodeExecutionCreateResultBlockParam` - `type: "text_editor_code_execution_create_result"` - `is_file_update: boolean` - `interface TextEditorCodeExecutionStrReplaceResultBlockParam` - `type: "text_editor_code_execution_str_replace_result"` - `lines?: Array | null` - `new_lines?: number | null` - `new_start?: number | null` - `old_lines?: number | null` - `old_start?: number | null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface ToolSearchToolResultBlockParam` - `type: "tool_search_tool_result"` - `content: ToolSearchToolResultErrorParam | ToolSearchToolSearchResultBlockParam` - `interface ToolSearchToolResultErrorParam` - `type: "tool_search_tool_result_error"` - `error_code: ToolSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message?: string | null` - `interface ToolSearchToolSearchResultBlockParam` - `type: "tool_search_tool_search_result"` - `tool_references: Array` - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface ContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `type: "container_upload"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `role: "user" | "assistant" | "system"` - `"user"` - `"assistant"` - `"system"` ### Message Tokens Count - `interface MessageTokensCount` - `input_tokens: number` The total number of tokens across the provided list of messages, system prompt, and tools. ### Metadata - `interface Metadata` - `user_id?: string | null` An external identifier for the user who is associated with the request. This 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. maxLength: 512 ### Model - `type Model = "claude-haiku-5-5" | "claude-sonnet-5-5" | "claude-fable-5-1" | 17 more | (string & {})` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-mythos-5"` Most capable model for cybersecurity and biology research - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `(string & {})` ### Output Config - `interface OutputConfig` - `effort?: "low" | "medium" | "high" | 2 more | null` How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `"max"` - `format?: JSONOutputFormat | null` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=typescript) - `type: "json_schema"` - `schema: Record` The JSON schema of the format ### Output Tokens Details - `interface OutputTokensDetails` - `thinking_tokens: number` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. default: 0, minimum: 0 ### Plain Text Source - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` ### Raw Content Block Delta - `type RawContentBlockDelta = TextDelta | InputJSONDelta | CitationsDelta | 2 more` - `interface TextDelta` - `type: "text_delta"` default: text_delta - `text: string` - `interface InputJSONDelta` - `type: "input_json_delta"` default: input_json_delta - `partial_json: string` - `interface CitationsDelta` - `type: "citations_delta"` default: citations_delta - `citation: CitationCharLocation | CitationPageLocation | CitationContentBlockLocation | 2 more` - `interface CitationCharLocation` - `type: "char_location"` default: char_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` minimum: 0 - `interface CitationPageLocation` - `type: "page_location"` default: page_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocation` - `type: "content_block_location"` default: content_block_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `file_id: string | null` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationsWebSearchResultLocation` - `type: "web_search_result_location"` default: web_search_result_location - `cited_text: string` - `encrypted_index: string` - `title: string | null` maxLength: 512 - `url: string` - `interface CitationsSearchResultLocation` - `type: "search_result_location"` default: search_result_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `interface ThinkingDelta` - `type: "thinking_delta"` default: thinking_delta - `thinking: string` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. - `interface SignatureDelta` - `type: "signature_delta"` default: signature_delta - `signature: string` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. ### Raw Content Block Delta Event - `interface RawContentBlockDeltaEvent` - `type: "content_block_delta"` default: content_block_delta - `delta: RawContentBlockDelta` - `interface TextDelta` - `type: "text_delta"` default: text_delta - `text: string` - `interface InputJSONDelta` - `type: "input_json_delta"` default: input_json_delta - `partial_json: string` - `interface CitationsDelta` - `type: "citations_delta"` default: citations_delta - `citation: CitationCharLocation | CitationPageLocation | CitationContentBlockLocation | 2 more` - `interface CitationCharLocation` - `type: "char_location"` default: char_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` minimum: 0 - `interface CitationPageLocation` - `type: "page_location"` default: page_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocation` - `type: "content_block_location"` default: content_block_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `file_id: string | null` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationsWebSearchResultLocation` - `type: "web_search_result_location"` default: web_search_result_location - `cited_text: string` - `encrypted_index: string` - `title: string | null` maxLength: 512 - `url: string` - `interface CitationsSearchResultLocation` - `type: "search_result_location"` default: search_result_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `interface ThinkingDelta` - `type: "thinking_delta"` default: thinking_delta - `thinking: string` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. - `interface SignatureDelta` - `type: "signature_delta"` default: signature_delta - `signature: string` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. - `index: number` ### Raw Content Block Start Event - `interface RawContentBlockStartEvent` - `type: "content_block_start"` default: content_block_start - `content_block: TextBlock | ThinkingBlock | RedactedThinkingBlock | 9 more` - `interface TextBlock` - `type: "text"` default: text - `citations: Array | null` Citations supporting the text block. The 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`. - `interface CitationCharLocation` - `type: "char_location"` default: char_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` minimum: 0 - `interface CitationPageLocation` - `type: "page_location"` default: page_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocation` - `type: "content_block_location"` default: content_block_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `file_id: string | null` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationsWebSearchResultLocation` - `type: "web_search_result_location"` default: web_search_result_location - `cited_text: string` - `encrypted_index: string` - `title: string | null` maxLength: 512 - `url: string` - `interface CitationsSearchResultLocation` - `type: "search_result_location"` default: search_result_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `text: string` - `interface ThinkingBlock` - `type: "thinking"` default: thinking - `signature: string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript) for details. - `thinking: string` The text of Claude's thinking process for this block. - `interface RedactedThinkingBlock` - `type: "redacted_thinking"` default: redacted_thinking - `data: string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript#redacted-thinking-blocks) for details. - `interface ToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: Record` - `name: string` minLength: 1 - `toolset_name?: string | null` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ServerToolUseBlock` - `type: "server_tool_use"` default: server_tool_use - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `input: Record` - `name: "web_search" | "web_fetch" | "code_execution" | 4 more` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `interface WebSearchToolResultBlock` - `type: "web_search_tool_result"` default: web_search_tool_result - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `content: WebSearchToolResultBlockContent` - `interface WebSearchToolResultError` - `type: "web_search_tool_result_error"` default: web_search_tool_result_error - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `Array` - `type: "web_search_result"` default: web_search_result - `encrypted_content: string` - `page_age: string | null` - `title: string` - `url: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface WebFetchToolResultBlock` - `type: "web_fetch_tool_result"` default: web_fetch_tool_result - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `content: WebFetchToolResultErrorBlock | WebFetchBlock` - `interface WebFetchToolResultErrorBlock` - `type: "web_fetch_tool_result_error"` default: web_fetch_tool_result_error - `error_code: WebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `interface WebFetchBlock` - `type: "web_fetch_result"` default: web_fetch_result - `content: DocumentBlock` - `type: "document"` default: document - `citations: CitationsConfig | null` Citation configuration for the document - `enabled: boolean` default: false - `source: Base64PDFSource | PlainTextSource` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `title: string | null` The title of the document - `retrieved_at: string | null` ISO 8601 timestamp when the content was retrieved - `url: string` Fetched content URL - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface CodeExecutionToolResultBlock` - `type: "code_execution_tool_result"` default: code_execution_tool_result - `content: CodeExecutionToolResultBlockContent` - `interface CodeExecutionToolResultError` - `type: "code_execution_tool_result_error"` default: code_execution_tool_result_error - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `interface CodeExecutionResultBlock` - `type: "code_execution_result"` default: code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `interface EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` default: encrypted_code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface BashCodeExecutionToolResultBlock` - `type: "bash_code_execution_tool_result"` default: bash_code_execution_tool_result - `content: BashCodeExecutionToolResultError | BashCodeExecutionResultBlock` - `interface BashCodeExecutionToolResultError` - `type: "bash_code_execution_tool_result_error"` default: bash_code_execution_tool_result_error - `error_code: BashCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `interface BashCodeExecutionResultBlock` - `type: "bash_code_execution_result"` default: bash_code_execution_result - `content: Array` - `type: "bash_code_execution_output"` default: bash_code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface TextEditorCodeExecutionToolResultBlock` - `type: "text_editor_code_execution_tool_result"` default: text_editor_code_execution_tool_result - `content: TextEditorCodeExecutionToolResultError | TextEditorCodeExecutionViewResultBlock | TextEditorCodeExecutionCreateResultBlock | TextEditorCodeExecutionStrReplaceResultBlock` - `interface TextEditorCodeExecutionToolResultError` - `type: "text_editor_code_execution_tool_result_error"` default: text_editor_code_execution_tool_result_error - `error_code: TextEditorCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message: string | null` - `interface TextEditorCodeExecutionViewResultBlock` - `type: "text_editor_code_execution_view_result"` default: text_editor_code_execution_view_result - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `interface TextEditorCodeExecutionCreateResultBlock` - `type: "text_editor_code_execution_create_result"` default: text_editor_code_execution_create_result - `is_file_update: boolean` - `interface TextEditorCodeExecutionStrReplaceResultBlock` - `type: "text_editor_code_execution_str_replace_result"` default: text_editor_code_execution_str_replace_result - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ToolSearchToolResultBlock` - `type: "tool_search_tool_result"` default: tool_search_tool_result - `content: ToolSearchToolResultError | ToolSearchToolSearchResultBlock` - `interface ToolSearchToolResultError` - `type: "tool_search_tool_result_error"` default: tool_search_tool_result_error - `error_code: ToolSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message: string | null` - `interface ToolSearchToolSearchResultBlock` - `type: "tool_search_tool_search_result"` default: tool_search_tool_search_result - `tool_references: Array` - `type: "tool_reference"` default: tool_reference - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ContainerUploadBlock` Response model for a file uploaded to the container. - `type: "container_upload"` default: container_upload - `file_id: string` - `index: number` ### Raw Content Block Stop Event - `interface RawContentBlockStopEvent` - `type: "content_block_stop"` default: content_block_stop - `index: number` ### Raw Message Delta Event - `interface RawMessageDeltaEvent` - `type: "message_delta"` default: message_delta - `delta: Delta` - `container: Container | null` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. format: date-time - `skills: Array | null` Skills loaded in the container - `type: "anthropic" | "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version: string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `stop_details: RefusalStopDetails | null` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `type: "refusal"` default: refusal - `category: "cyber" | "bio" | "frontier_llm" | 2 more | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `"bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `"frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `"reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=typescript). - `"general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `explanation: string | null` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `stop_reason: StopReason | null` - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string | null` - `usage: MessageDeltaUsage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under 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. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `cache_creation_input_tokens: number | null` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `cache_read_input_tokens: number | null` The cumulative number of input tokens read from the cache. minimum: 0 - `input_tokens: number | null` The cumulative number of input tokens which were used. minimum: 0 - `output_tokens: number` The cumulative number of output tokens which were used. - `output_tokens_details: OutputTokensDetails | null` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `thinking_tokens: number` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. default: 0, minimum: 0 - `server_tool_use: ServerToolUsage | null` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. default: 0, minimum: 0 - `web_search_requests: number` The number of web search tool requests. default: 0, minimum: 0 ### Raw Message Start Event - `interface RawMessageStartEvent` - `type: "message_start"` default: message_start - `message: Message` - `type: "message"` Object type. For Messages, this is always `"message"`. default: message - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: Container | null` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. format: date-time - `skills: Array | null` Skills loaded in the container - `type: "anthropic" | "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version: string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `content: Array` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If 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. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `interface TextBlock` - `type: "text"` default: text - `citations: Array | null` Citations supporting the text block. The 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`. - `interface CitationCharLocation` - `type: "char_location"` default: char_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` minimum: 0 - `interface CitationPageLocation` - `type: "page_location"` default: page_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocation` - `type: "content_block_location"` default: content_block_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `file_id: string | null` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationsWebSearchResultLocation` - `type: "web_search_result_location"` default: web_search_result_location - `cited_text: string` - `encrypted_index: string` - `title: string | null` maxLength: 512 - `url: string` - `interface CitationsSearchResultLocation` - `type: "search_result_location"` default: search_result_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `text: string` - `interface ThinkingBlock` - `type: "thinking"` default: thinking - `signature: string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript) for details. - `thinking: string` The text of Claude's thinking process for this block. - `interface RedactedThinkingBlock` - `type: "redacted_thinking"` default: redacted_thinking - `data: string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript#redacted-thinking-blocks) for details. - `interface ToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: Record` - `name: string` minLength: 1 - `toolset_name?: string | null` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ServerToolUseBlock` - `type: "server_tool_use"` default: server_tool_use - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `input: Record` - `name: "web_search" | "web_fetch" | "code_execution" | 4 more` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `interface WebSearchToolResultBlock` - `type: "web_search_tool_result"` default: web_search_tool_result - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `content: WebSearchToolResultBlockContent` - `interface WebSearchToolResultError` - `type: "web_search_tool_result_error"` default: web_search_tool_result_error - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `Array` - `type: "web_search_result"` default: web_search_result - `encrypted_content: string` - `page_age: string | null` - `title: string` - `url: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface WebFetchToolResultBlock` - `type: "web_fetch_tool_result"` default: web_fetch_tool_result - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `content: WebFetchToolResultErrorBlock | WebFetchBlock` - `interface WebFetchToolResultErrorBlock` - `type: "web_fetch_tool_result_error"` default: web_fetch_tool_result_error - `error_code: WebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `interface WebFetchBlock` - `type: "web_fetch_result"` default: web_fetch_result - `content: DocumentBlock` - `type: "document"` default: document - `citations: CitationsConfig | null` Citation configuration for the document - `enabled: boolean` default: false - `source: Base64PDFSource | PlainTextSource` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `title: string | null` The title of the document - `retrieved_at: string | null` ISO 8601 timestamp when the content was retrieved - `url: string` Fetched content URL - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface CodeExecutionToolResultBlock` - `type: "code_execution_tool_result"` default: code_execution_tool_result - `content: CodeExecutionToolResultBlockContent` - `interface CodeExecutionToolResultError` - `type: "code_execution_tool_result_error"` default: code_execution_tool_result_error - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `interface CodeExecutionResultBlock` - `type: "code_execution_result"` default: code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `interface EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` default: encrypted_code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface BashCodeExecutionToolResultBlock` - `type: "bash_code_execution_tool_result"` default: bash_code_execution_tool_result - `content: BashCodeExecutionToolResultError | BashCodeExecutionResultBlock` - `interface BashCodeExecutionToolResultError` - `type: "bash_code_execution_tool_result_error"` default: bash_code_execution_tool_result_error - `error_code: BashCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `interface BashCodeExecutionResultBlock` - `type: "bash_code_execution_result"` default: bash_code_execution_result - `content: Array` - `type: "bash_code_execution_output"` default: bash_code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface TextEditorCodeExecutionToolResultBlock` - `type: "text_editor_code_execution_tool_result"` default: text_editor_code_execution_tool_result - `content: TextEditorCodeExecutionToolResultError | TextEditorCodeExecutionViewResultBlock | TextEditorCodeExecutionCreateResultBlock | TextEditorCodeExecutionStrReplaceResultBlock` - `interface TextEditorCodeExecutionToolResultError` - `type: "text_editor_code_execution_tool_result_error"` default: text_editor_code_execution_tool_result_error - `error_code: TextEditorCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message: string | null` - `interface TextEditorCodeExecutionViewResultBlock` - `type: "text_editor_code_execution_view_result"` default: text_editor_code_execution_view_result - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `interface TextEditorCodeExecutionCreateResultBlock` - `type: "text_editor_code_execution_create_result"` default: text_editor_code_execution_create_result - `is_file_update: boolean` - `interface TextEditorCodeExecutionStrReplaceResultBlock` - `type: "text_editor_code_execution_str_replace_result"` default: text_editor_code_execution_str_replace_result - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ToolSearchToolResultBlock` - `type: "tool_search_tool_result"` default: tool_search_tool_result - `content: ToolSearchToolResultError | ToolSearchToolSearchResultBlock` - `interface ToolSearchToolResultError` - `type: "tool_search_tool_result_error"` default: tool_search_tool_result_error - `error_code: ToolSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message: string | null` - `interface ToolSearchToolSearchResultBlock` - `type: "tool_search_tool_search_result"` default: tool_search_tool_search_result - `tool_references: Array` - `type: "tool_reference"` default: tool_reference - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ContainerUploadBlock` Response model for a file uploaded to the container. - `type: "container_upload"` default: container_upload - `file_id: string` - `diagnostics: Diagnostics | null` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `cache_miss_reason: CacheMissReason | null` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `interface CacheMissModelChanged` - `type: "model_changed"` default: model_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissSystemChanged` - `type: "system_changed"` default: system_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissToolsChanged` - `type: "tools_changed"` default: tools_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissMessagesChanged` - `type: "messages_changed"` default: messages_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissPreviousMessageNotFound` - `type: "previous_message_not_found"` default: previous_message_not_found - `interface CacheMissUnavailable` - `type: "unavailable"` default: unavailable - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-mythos-5"` Most capable model for cybersecurity and biology research - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `(string & {})` - `role: "assistant"` Conversational role of the generated message. This will always be `"assistant"`. default: assistant - `stop_details: RefusalStopDetails | null` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `type: "refusal"` default: refusal - `category: "cyber" | "bio" | "frontier_llm" | 2 more | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `"bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `"frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `"reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=typescript). - `"general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `explanation: string | null` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `stop_reason: StopReason | null` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"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. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations * `"model_context_window_exceeded"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string | null` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `usage: Usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under 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. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `cache_creation: CacheCreation | null` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `cache_creation_input_tokens: number | null` The number of input tokens used to create the cache entry. minimum: 0 - `cache_read_input_tokens: number | null` The number of input tokens read from the cache. minimum: 0 - `inference_geo: string | null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. minimum: 0 - `output_tokens: number` The number of output tokens which were used. minimum: 0 - `output_tokens_details: OutputTokensDetails | null` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `thinking_tokens: number` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. default: 0, minimum: 0 - `server_tool_use: ServerToolUsage | null` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. default: 0, minimum: 0 - `web_search_requests: number` The number of web search tool requests. default: 0, minimum: 0 - `service_tier: "standard" | "priority" | "batch" | null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` ### Raw Message Stop Event - `interface RawMessageStopEvent` - `type: "message_stop"` default: message_stop ### Raw Message Stream Event - `type RawMessageStreamEvent = RawMessageStartEvent | RawMessageDeltaEvent | RawMessageStopEvent | 3 more` - `interface RawMessageStartEvent` - `type: "message_start"` default: message_start - `message: Message` - `type: "message"` Object type. For Messages, this is always `"message"`. default: message - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: Container | null` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. format: date-time - `skills: Array | null` Skills loaded in the container - `type: "anthropic" | "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version: string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `content: Array` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If 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. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `interface TextBlock` - `type: "text"` default: text - `citations: Array | null` Citations supporting the text block. The 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`. - `interface CitationCharLocation` - `type: "char_location"` default: char_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` minimum: 0 - `interface CitationPageLocation` - `type: "page_location"` default: page_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocation` - `type: "content_block_location"` default: content_block_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `file_id: string | null` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationsWebSearchResultLocation` - `type: "web_search_result_location"` default: web_search_result_location - `cited_text: string` - `encrypted_index: string` - `title: string | null` maxLength: 512 - `url: string` - `interface CitationsSearchResultLocation` - `type: "search_result_location"` default: search_result_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `text: string` - `interface ThinkingBlock` - `type: "thinking"` default: thinking - `signature: string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript) for details. - `thinking: string` The text of Claude's thinking process for this block. - `interface RedactedThinkingBlock` - `type: "redacted_thinking"` default: redacted_thinking - `data: string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript#redacted-thinking-blocks) for details. - `interface ToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: Record` - `name: string` minLength: 1 - `toolset_name?: string | null` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ServerToolUseBlock` - `type: "server_tool_use"` default: server_tool_use - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `input: Record` - `name: "web_search" | "web_fetch" | "code_execution" | 4 more` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `interface WebSearchToolResultBlock` - `type: "web_search_tool_result"` default: web_search_tool_result - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `content: WebSearchToolResultBlockContent` - `interface WebSearchToolResultError` - `type: "web_search_tool_result_error"` default: web_search_tool_result_error - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `Array` - `type: "web_search_result"` default: web_search_result - `encrypted_content: string` - `page_age: string | null` - `title: string` - `url: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface WebFetchToolResultBlock` - `type: "web_fetch_tool_result"` default: web_fetch_tool_result - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `content: WebFetchToolResultErrorBlock | WebFetchBlock` - `interface WebFetchToolResultErrorBlock` - `type: "web_fetch_tool_result_error"` default: web_fetch_tool_result_error - `error_code: WebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `interface WebFetchBlock` - `type: "web_fetch_result"` default: web_fetch_result - `content: DocumentBlock` - `type: "document"` default: document - `citations: CitationsConfig | null` Citation configuration for the document - `enabled: boolean` default: false - `source: Base64PDFSource | PlainTextSource` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `title: string | null` The title of the document - `retrieved_at: string | null` ISO 8601 timestamp when the content was retrieved - `url: string` Fetched content URL - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface CodeExecutionToolResultBlock` - `type: "code_execution_tool_result"` default: code_execution_tool_result - `content: CodeExecutionToolResultBlockContent` - `interface CodeExecutionToolResultError` - `type: "code_execution_tool_result_error"` default: code_execution_tool_result_error - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `interface CodeExecutionResultBlock` - `type: "code_execution_result"` default: code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `interface EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` default: encrypted_code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface BashCodeExecutionToolResultBlock` - `type: "bash_code_execution_tool_result"` default: bash_code_execution_tool_result - `content: BashCodeExecutionToolResultError | BashCodeExecutionResultBlock` - `interface BashCodeExecutionToolResultError` - `type: "bash_code_execution_tool_result_error"` default: bash_code_execution_tool_result_error - `error_code: BashCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `interface BashCodeExecutionResultBlock` - `type: "bash_code_execution_result"` default: bash_code_execution_result - `content: Array` - `type: "bash_code_execution_output"` default: bash_code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface TextEditorCodeExecutionToolResultBlock` - `type: "text_editor_code_execution_tool_result"` default: text_editor_code_execution_tool_result - `content: TextEditorCodeExecutionToolResultError | TextEditorCodeExecutionViewResultBlock | TextEditorCodeExecutionCreateResultBlock | TextEditorCodeExecutionStrReplaceResultBlock` - `interface TextEditorCodeExecutionToolResultError` - `type: "text_editor_code_execution_tool_result_error"` default: text_editor_code_execution_tool_result_error - `error_code: TextEditorCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message: string | null` - `interface TextEditorCodeExecutionViewResultBlock` - `type: "text_editor_code_execution_view_result"` default: text_editor_code_execution_view_result - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `interface TextEditorCodeExecutionCreateResultBlock` - `type: "text_editor_code_execution_create_result"` default: text_editor_code_execution_create_result - `is_file_update: boolean` - `interface TextEditorCodeExecutionStrReplaceResultBlock` - `type: "text_editor_code_execution_str_replace_result"` default: text_editor_code_execution_str_replace_result - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ToolSearchToolResultBlock` - `type: "tool_search_tool_result"` default: tool_search_tool_result - `content: ToolSearchToolResultError | ToolSearchToolSearchResultBlock` - `interface ToolSearchToolResultError` - `type: "tool_search_tool_result_error"` default: tool_search_tool_result_error - `error_code: ToolSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message: string | null` - `interface ToolSearchToolSearchResultBlock` - `type: "tool_search_tool_search_result"` default: tool_search_tool_search_result - `tool_references: Array` - `type: "tool_reference"` default: tool_reference - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ContainerUploadBlock` Response model for a file uploaded to the container. - `type: "container_upload"` default: container_upload - `file_id: string` - `diagnostics: Diagnostics | null` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `cache_miss_reason: CacheMissReason | null` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `interface CacheMissModelChanged` - `type: "model_changed"` default: model_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissSystemChanged` - `type: "system_changed"` default: system_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissToolsChanged` - `type: "tools_changed"` default: tools_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissMessagesChanged` - `type: "messages_changed"` default: messages_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissPreviousMessageNotFound` - `type: "previous_message_not_found"` default: previous_message_not_found - `interface CacheMissUnavailable` - `type: "unavailable"` default: unavailable - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-mythos-5"` Most capable model for cybersecurity and biology research - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `(string & {})` - `role: "assistant"` Conversational role of the generated message. This will always be `"assistant"`. default: assistant - `stop_details: RefusalStopDetails | null` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `type: "refusal"` default: refusal - `category: "cyber" | "bio" | "frontier_llm" | 2 more | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `"bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `"frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `"reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=typescript). - `"general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `explanation: string | null` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `stop_reason: StopReason | null` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"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. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations * `"model_context_window_exceeded"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string | null` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `usage: Usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under 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. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `cache_creation: CacheCreation | null` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `cache_creation_input_tokens: number | null` The number of input tokens used to create the cache entry. minimum: 0 - `cache_read_input_tokens: number | null` The number of input tokens read from the cache. minimum: 0 - `inference_geo: string | null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. minimum: 0 - `output_tokens: number` The number of output tokens which were used. minimum: 0 - `output_tokens_details: OutputTokensDetails | null` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `thinking_tokens: number` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. default: 0, minimum: 0 - `server_tool_use: ServerToolUsage | null` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. default: 0, minimum: 0 - `web_search_requests: number` The number of web search tool requests. default: 0, minimum: 0 - `service_tier: "standard" | "priority" | "batch" | null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `interface RawMessageDeltaEvent` - `type: "message_delta"` default: message_delta - `delta: Delta` - `container: Container | null` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `stop_details: RefusalStopDetails | null` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `stop_reason: StopReason | null` - `stop_sequence: string | null` - `usage: MessageDeltaUsage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under 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. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `cache_creation_input_tokens: number | null` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `cache_read_input_tokens: number | null` The cumulative number of input tokens read from the cache. minimum: 0 - `input_tokens: number | null` The cumulative number of input tokens which were used. minimum: 0 - `output_tokens: number` The cumulative number of output tokens which were used. - `output_tokens_details: OutputTokensDetails | null` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `server_tool_use: ServerToolUsage | null` The number of server tool requests. - `interface RawMessageStopEvent` - `type: "message_stop"` default: message_stop - `interface RawContentBlockStartEvent` - `type: "content_block_start"` default: content_block_start - `content_block: TextBlock | ThinkingBlock | RedactedThinkingBlock | 9 more` - `interface TextBlock` - `interface ThinkingBlock` - `interface RedactedThinkingBlock` - `interface ToolUseBlock` - `interface ServerToolUseBlock` - `interface WebSearchToolResultBlock` - `interface WebFetchToolResultBlock` - `interface CodeExecutionToolResultBlock` - `interface BashCodeExecutionToolResultBlock` - `interface TextEditorCodeExecutionToolResultBlock` - `interface ToolSearchToolResultBlock` - `interface ContainerUploadBlock` Response model for a file uploaded to the container. - `index: number` - `interface RawContentBlockDeltaEvent` - `type: "content_block_delta"` default: content_block_delta - `delta: RawContentBlockDelta` - `interface TextDelta` - `type: "text_delta"` default: text_delta - `text: string` - `interface InputJSONDelta` - `type: "input_json_delta"` default: input_json_delta - `partial_json: string` - `interface CitationsDelta` - `type: "citations_delta"` default: citations_delta - `citation: CitationCharLocation | CitationPageLocation | CitationContentBlockLocation | 2 more` - `interface CitationCharLocation` - `interface CitationPageLocation` - `interface CitationContentBlockLocation` - `interface CitationsWebSearchResultLocation` - `interface CitationsSearchResultLocation` - `interface ThinkingDelta` - `type: "thinking_delta"` default: thinking_delta - `thinking: string` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. - `interface SignatureDelta` - `type: "signature_delta"` default: signature_delta - `signature: string` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. - `index: number` - `interface RawContentBlockStopEvent` - `type: "content_block_stop"` default: content_block_stop - `index: number` ### Redacted Thinking Block - `interface RedactedThinkingBlock` - `type: "redacted_thinking"` default: redacted_thinking - `data: string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript#redacted-thinking-blocks) for details. ### Redacted Thinking Block Param - `interface RedactedThinkingBlockParam` - `type: "redacted_thinking"` - `data: string` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. ### Refusal Stop Details - `interface RefusalStopDetails` Structured information about a refusal. - `type: "refusal"` default: refusal - `category: "cyber" | "bio" | "frontier_llm" | 2 more | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `"bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `"frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `"reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=typescript). - `"general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `explanation: string | null` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. ### Search Result Block Param - `interface SearchResultBlockParam` - `type: "search_result"` - `content: Array` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `citations?: Array | null` - `interface CitationCharLocationParam` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `interface CitationPageLocationParam` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocationParam` - `type: "content_block_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationWebSearchResultLocationParam` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string | null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `interface CitationSearchResultLocationParam` - `type: "search_result_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `source: string` - `title: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam` - `enabled?: boolean` ### Server Tool Caller - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Server Tool Caller 20260120 - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Server Tool Usage - `interface ServerToolUsage` - `web_fetch_requests: number` The number of web fetch tool requests. default: 0, minimum: 0 - `web_search_requests: number` The number of web search tool requests. default: 0, minimum: 0 ### Server Tool Use Block - `interface ServerToolUseBlock` - `type: "server_tool_use"` default: server_tool_use - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: Record` - `name: "web_search" | "web_fetch" | "code_execution" | 4 more` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` ### Server Tool Use Block Param - `interface ServerToolUseBlockParam` - `type: "server_tool_use"` - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: Record` - `name: "web_search" | "web_fetch" | "code_execution" | 4 more` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Signature Delta - `interface SignatureDelta` - `type: "signature_delta"` default: signature_delta - `signature: string` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. ### Skill Params - `interface SkillParams` Specification for a skill to be loaded in a container (request model). - `type: "anthropic" | "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version?: string` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 ### Stop Reason - `type StopReason = "end_turn" | "max_tokens" | "stop_sequence" | 4 more` - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"refusal"` - `"model_context_window_exceeded"` ### Text Block - `interface TextBlock` - `type: "text"` default: text - `citations: Array | null` Citations supporting the text block. The 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`. - `interface CitationCharLocation` - `type: "char_location"` default: char_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` minimum: 0 - `interface CitationPageLocation` - `type: "page_location"` default: page_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocation` - `type: "content_block_location"` default: content_block_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `file_id: string | null` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationsWebSearchResultLocation` - `type: "web_search_result_location"` default: web_search_result_location - `cited_text: string` - `encrypted_index: string` - `title: string | null` maxLength: 512 - `url: string` - `interface CitationsSearchResultLocation` - `type: "search_result_location"` default: search_result_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `text: string` ### Text Block Param - `interface TextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `citations?: Array | null` - `interface CitationCharLocationParam` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `interface CitationPageLocationParam` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocationParam` - `type: "content_block_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationWebSearchResultLocationParam` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string | null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `interface CitationSearchResultLocationParam` - `type: "search_result_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` ### Text Citation - `type TextCitation = CitationCharLocation | CitationPageLocation | CitationContentBlockLocation | 2 more` - `interface CitationCharLocation` - `type: "char_location"` default: char_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` minimum: 0 - `interface CitationPageLocation` - `type: "page_location"` default: page_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocation` - `type: "content_block_location"` default: content_block_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `file_id: string | null` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationsWebSearchResultLocation` - `type: "web_search_result_location"` default: web_search_result_location - `cited_text: string` - `encrypted_index: string` - `title: string | null` maxLength: 512 - `url: string` - `interface CitationsSearchResultLocation` - `type: "search_result_location"` default: search_result_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` ### Text Citation Param - `type TextCitationParam = CitationCharLocationParam | CitationPageLocationParam | CitationContentBlockLocationParam | 2 more` - `interface CitationCharLocationParam` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `interface CitationPageLocationParam` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocationParam` - `type: "content_block_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationWebSearchResultLocationParam` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string | null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `interface CitationSearchResultLocationParam` - `type: "search_result_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` ### Text Delta - `interface TextDelta` - `type: "text_delta"` default: text_delta - `text: string` ### Text Editor Code Execution Create Result Block - `interface TextEditorCodeExecutionCreateResultBlock` - `type: "text_editor_code_execution_create_result"` default: text_editor_code_execution_create_result - `is_file_update: boolean` ### Text Editor Code Execution Create Result Block Param - `interface TextEditorCodeExecutionCreateResultBlockParam` - `type: "text_editor_code_execution_create_result"` - `is_file_update: boolean` ### Text Editor Code Execution Str Replace Result Block - `interface TextEditorCodeExecutionStrReplaceResultBlock` - `type: "text_editor_code_execution_str_replace_result"` default: text_editor_code_execution_str_replace_result - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` ### Text Editor Code Execution Str Replace Result Block Param - `interface TextEditorCodeExecutionStrReplaceResultBlockParam` - `type: "text_editor_code_execution_str_replace_result"` - `lines?: Array | null` - `new_lines?: number | null` - `new_start?: number | null` - `old_lines?: number | null` - `old_start?: number | null` ### Text Editor Code Execution Tool Result Block - `interface TextEditorCodeExecutionToolResultBlock` - `type: "text_editor_code_execution_tool_result"` default: text_editor_code_execution_tool_result - `content: TextEditorCodeExecutionToolResultError | TextEditorCodeExecutionViewResultBlock | TextEditorCodeExecutionCreateResultBlock | TextEditorCodeExecutionStrReplaceResultBlock` - `interface TextEditorCodeExecutionToolResultError` - `type: "text_editor_code_execution_tool_result_error"` default: text_editor_code_execution_tool_result_error - `error_code: TextEditorCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message: string | null` - `interface TextEditorCodeExecutionViewResultBlock` - `type: "text_editor_code_execution_view_result"` default: text_editor_code_execution_view_result - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `interface TextEditorCodeExecutionCreateResultBlock` - `type: "text_editor_code_execution_create_result"` default: text_editor_code_execution_create_result - `is_file_update: boolean` - `interface TextEditorCodeExecutionStrReplaceResultBlock` - `type: "text_editor_code_execution_str_replace_result"` default: text_editor_code_execution_str_replace_result - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Text Editor Code Execution Tool Result Block Param - `interface TextEditorCodeExecutionToolResultBlockParam` - `type: "text_editor_code_execution_tool_result"` - `content: TextEditorCodeExecutionToolResultErrorParam | TextEditorCodeExecutionViewResultBlockParam | TextEditorCodeExecutionCreateResultBlockParam | TextEditorCodeExecutionStrReplaceResultBlockParam` - `interface TextEditorCodeExecutionToolResultErrorParam` - `type: "text_editor_code_execution_tool_result_error"` - `error_code: TextEditorCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message?: string | null` - `interface TextEditorCodeExecutionViewResultBlockParam` - `type: "text_editor_code_execution_view_result"` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines?: number | null` - `start_line?: number | null` - `total_lines?: number | null` - `interface TextEditorCodeExecutionCreateResultBlockParam` - `type: "text_editor_code_execution_create_result"` - `is_file_update: boolean` - `interface TextEditorCodeExecutionStrReplaceResultBlockParam` - `type: "text_editor_code_execution_str_replace_result"` - `lines?: Array | null` - `new_lines?: number | null` - `new_start?: number | null` - `old_lines?: number | null` - `old_start?: number | null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` ### Text Editor Code Execution Tool Result Error - `interface TextEditorCodeExecutionToolResultError` - `type: "text_editor_code_execution_tool_result_error"` default: text_editor_code_execution_tool_result_error - `error_code: TextEditorCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message: string | null` ### Text Editor Code Execution Tool Result Error Code - `type TextEditorCodeExecutionToolResultErrorCode = "invalid_tool_input" | "unavailable" | "too_many_requests" | 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` ### Text Editor Code Execution Tool Result Error Param - `interface TextEditorCodeExecutionToolResultErrorParam` - `type: "text_editor_code_execution_tool_result_error"` - `error_code: TextEditorCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message?: string | null` ### Text Editor Code Execution View Result Block - `interface TextEditorCodeExecutionViewResultBlock` - `type: "text_editor_code_execution_view_result"` default: text_editor_code_execution_view_result - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` ### Text Editor Code Execution View Result Block Param - `interface TextEditorCodeExecutionViewResultBlockParam` - `type: "text_editor_code_execution_view_result"` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines?: number | null` - `start_line?: number | null` - `total_lines?: number | null` ### Thinking Block - `interface ThinkingBlock` - `type: "thinking"` default: thinking - `signature: string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript) for details. - `thinking: string` The text of Claude's thinking process for this block. ### Thinking Block Param - `interface ThinkingBlockParam` - `type: "thinking"` - `signature: string` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `thinking: string` The `thinking` text of this block as returned by the API. ### Thinking Config Adaptive - `interface ThinkingConfigAdaptive` - `type: "adaptive"` - `display?: "summarized" | "omitted" | null` 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. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=typescript#controlling-thinking-display). - `"summarized"` - `"omitted"` ### Thinking Config Between Tools - `interface ThinkingConfigBetweenTools` - `type: "between_tools"` ### Thinking Config Disabled - `interface ThinkingConfigDisabled` - `type: "disabled"` ### Thinking Config Enabled - `interface ThinkingConfigEnabled` - `type: "enabled"` - `budget_tokens: number` 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. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript) for details. minimum: 1024 - `display?: "summarized" | "omitted" | null` 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. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=typescript#controlling-thinking-display). - `"summarized"` - `"omitted"` ### Thinking Config Param - `type ThinkingConfigParam = ThinkingConfigEnabled | ThinkingConfigDisabled | ThinkingConfigBetweenTools | ThinkingConfigAdaptive` Configuration for Claude's thinking. With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit. Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=typescript#configuring-thinking) for each model's behavior. - `interface ThinkingConfigEnabled` - `type: "enabled"` - `budget_tokens: number` 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. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript) for details. minimum: 1024 - `display?: "summarized" | "omitted" | null` 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. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=typescript#controlling-thinking-display). - `"summarized"` - `"omitted"` - `interface ThinkingConfigDisabled` - `type: "disabled"` - `interface ThinkingConfigBetweenTools` - `type: "between_tools"` - `interface ThinkingConfigAdaptive` - `type: "adaptive"` - `display?: "summarized" | "omitted" | null` 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. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=typescript#controlling-thinking-display). - `"summarized"` - `"omitted"` ### Thinking Delta - `interface ThinkingDelta` - `type: "thinking_delta"` default: thinking_delta - `thinking: string` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. ### Tool - `interface Tool` - `type?: "custom" | null` - `input_schema: InputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `type: "object"` - `properties?: Record | null` - `required?: Array | null` - `name: string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `description?: string` Description of what this tool does. Tool 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. - `eager_input_streaming?: boolean | null` 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. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Tool Bash 20250124 - `interface ToolBash20250124` - `type: "bash_20250124"` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Tool Choice - `type ToolChoice = ToolChoiceAuto | ToolChoiceAny | ToolChoiceTool | ToolChoiceNone` 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. - `interface ToolChoiceAuto` The model will automatically decide whether to use tools. - `type: "auto"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `interface ToolChoiceAny` The model will use any available tools. - `type: "any"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `interface ToolChoiceTool` The model will use the specified tool with `tool_choice.name`. - `type: "tool"` - `name: string` The name of the tool to use. - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `interface ToolChoiceNone` The model will not be allowed to use tools. - `type: "none"` ### Tool Choice Any - `interface ToolChoiceAny` The model will use any available tools. - `type: "any"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. ### Tool Choice Auto - `interface ToolChoiceAuto` The model will automatically decide whether to use tools. - `type: "auto"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. ### Tool Choice None - `interface ToolChoiceNone` The model will not be allowed to use tools. - `type: "none"` ### Tool Choice Tool - `interface ToolChoiceTool` The model will use the specified tool with `tool_choice.name`. - `type: "tool"` - `name: string` The name of the tool to use. - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. ### Tool Reference Block - `interface ToolReferenceBlock` - `type: "tool_reference"` default: tool_reference - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ ### Tool Reference Block Param - `interface ToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` ### Tool Result Block Param - `interface ToolResultBlockParam` - `type: "tool_result"` - `tool_use_id: string` pattern: ^[a-zA-Z0-9_-]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `content?: string | Array` - `string` - `Array` - `interface TextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `interface CitationCharLocationParam` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `interface CitationPageLocationParam` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocationParam` - `type: "content_block_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationWebSearchResultLocationParam` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string | null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `interface CitationSearchResultLocationParam` - `type: "search_result_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `interface ImageBlockParam` - `type: "image"` - `source: Base64ImageSource | URLImageSource | FileImageSource` - `interface Base64ImageSource` - `type: "base64"` - `data: string` format: byte - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `interface URLImageSource` - `type: "url"` - `url: string` - `interface FileImageSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `transformations?: ImageTransformationsParam | null` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `oversized_image?: "downsize" | "error"` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `"downsize"` - `"error"` - `interface SearchResultBlockParam` - `type: "search_result"` - `content: Array` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `source: string` - `title: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam` - `enabled?: boolean` - `interface DocumentBlockParam` - `type: "document"` - `source: Base64PDFSource | PlainTextSource | ContentBlockSource | 2 more` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `interface ContentBlockSource` - `type: "content"` - `content: string | Array` - `string` - `Array` - `interface TextBlockParam` - `interface ImageBlockParam` - `interface URLPDFSource` - `type: "url"` - `url: string` - `interface FileDocumentSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` - `context?: string | null` minLength: 1 - `title?: string | null` minLength: 1, maxLength: 500 - `interface ToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface BrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `type: "browser_state"` - `tabs: Array` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `tab_id: string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `title: string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `active?: boolean` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `state_changes?: Array | null` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `interface BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `type: "tab_opened"` - `tab_id: string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `interface BrowserStateChangeDownloadStarted` A file download that started during this call. - `type: "download_started"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `interface BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `type: "download_completed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path?: string | null` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `size_bytes?: number | null` The completed download's size. minimum: 0 - `interface BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `type: "download_failed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `error?: string | null` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `is_error?: boolean` - `toolset_name?: string | null` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ ### Tool Search Tool Bm25 20251119 - `interface ToolSearchToolBm25_20251119` - `type: "tool_search_tool_bm25_20251119" | "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `name: "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Tool Search Tool Regex 20251119 - `interface ToolSearchToolRegex20251119` - `type: "tool_search_tool_regex_20251119" | "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `name: "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Tool Search Tool Result Block - `interface ToolSearchToolResultBlock` - `type: "tool_search_tool_result"` default: tool_search_tool_result - `content: ToolSearchToolResultError | ToolSearchToolSearchResultBlock` - `interface ToolSearchToolResultError` - `type: "tool_search_tool_result_error"` default: tool_search_tool_result_error - `error_code: ToolSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message: string | null` - `interface ToolSearchToolSearchResultBlock` - `type: "tool_search_tool_search_result"` default: tool_search_tool_search_result - `tool_references: Array` - `type: "tool_reference"` default: tool_reference - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Tool Search Tool Result Block Param - `interface ToolSearchToolResultBlockParam` - `type: "tool_search_tool_result"` - `content: ToolSearchToolResultErrorParam | ToolSearchToolSearchResultBlockParam` - `interface ToolSearchToolResultErrorParam` - `type: "tool_search_tool_result_error"` - `error_code: ToolSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message?: string | null` - `interface ToolSearchToolSearchResultBlockParam` - `type: "tool_search_tool_search_result"` - `tool_references: Array` - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. ### Tool Search Tool Result Error - `interface ToolSearchToolResultError` - `type: "tool_search_tool_result_error"` default: tool_search_tool_result_error - `error_code: ToolSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message: string | null` ### Tool Search Tool Result Error Code - `type ToolSearchToolResultErrorCode = "invalid_tool_input" | "unavailable" | "too_many_requests" | "execution_time_exceeded"` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` ### Tool Search Tool Result Error Param - `interface ToolSearchToolResultErrorParam` - `type: "tool_search_tool_result_error"` - `error_code: ToolSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message?: string | null` ### Tool Search Tool Search Result Block - `interface ToolSearchToolSearchResultBlock` - `type: "tool_search_tool_search_result"` default: tool_search_tool_search_result - `tool_references: Array` - `type: "tool_reference"` default: tool_reference - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ ### Tool Search Tool Search Result Block Param - `interface ToolSearchToolSearchResultBlockParam` - `type: "tool_search_tool_search_result"` - `tool_references: Array` - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` ### Tool Text Editor 20250124 - `interface ToolTextEditor20250124` - `type: "text_editor_20250124"` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Tool Text Editor 20250429 - `interface ToolTextEditor20250429` - `type: "text_editor_20250429"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Tool Text Editor 20250728 - `interface ToolTextEditor20250728` - `type: "text_editor_20250728"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `max_characters?: number | null` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Tool Union - `type ToolUnion = Tool | ToolBash20250124 | CodeExecutionTool20250522 | 18 more` - `interface Tool` - `type?: "custom" | null` - `input_schema: InputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `type: "object"` - `properties?: Record | null` - `required?: Array | null` - `name: string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `description?: string` Description of what this tool does. Tool 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. - `eager_input_streaming?: boolean | null` 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. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolBash20250124` - `type: "bash_20250124"` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20250522` - `type: "code_execution_20250522"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20250825` - `type: "code_execution_20250825"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `type: "code_execution_20260120"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20260521` Code execution tool with REPL state persistence. - `type: "code_execution_20260521"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface BrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `type: "browser_toolset_20260801"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `configs?: BrowserToolsetConfigs | null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type?: BrowserTypeConfig | null` `type`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `close_tab?: BrowserCloseTabConfig | null` `close_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click?: BrowserDoubleClickConfig | null` `double_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `file_upload?: BrowserFileUploadConfig | null` `file_upload`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `find?: BrowserFindConfig | null` `find`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `form_input?: BrowserFormInputConfig | null` `form_input`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `get_page_text?: BrowserGetPageTextConfig | null` `get_page_text`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key?: BrowserHoldKeyConfig | null` `hold_key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hover?: BrowserHoverConfig | null` `hover`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `javascript_exec?: BrowserJavascriptExecConfig | null` `javascript_exec`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key?: BrowserKeyConfig | null` `key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click?: BrowserLeftClickConfig | null` `left_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag?: BrowserLeftClickDragConfig | null` `left_click_drag`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down?: BrowserLeftMouseDownConfig | null` `left_mouse_down`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up?: BrowserLeftMouseUpConfig | null` `left_mouse_up`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `list_tabs?: BrowserListTabsConfig | null` `list_tabs`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click?: BrowserMiddleClickConfig | null` `middle_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move?: BrowserMouseMoveConfig | null` `mouse_move`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `navigate?: BrowserNavigateConfig | null` `navigate`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `new_tab?: BrowserNewTabConfig | null` `new_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_console?: BrowserReadConsoleConfig | null` `read_console`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_network?: BrowserReadNetworkConfig | null` `read_network`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_page?: BrowserReadPageConfig | null` `read_page`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click?: BrowserRightClickConfig | null` `right_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot?: BrowserScreenshotConfig | null` `screenshot`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll?: BrowserScrollConfig | null` `scroll`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll_to?: BrowserScrollToConfig | null` `scroll_to`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `switch_tab?: BrowserSwitchTabConfig | null` `switch_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click?: BrowserTripleClickConfig | null` `triple_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait?: BrowserWaitConfig | null` `wait`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom?: BrowserZoomConfig | null` `zoom`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `interface MemoryTool20250818` - `type: "memory_20250818"` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `type: "computer_toolset_20260801"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `configs?: ComputerToolsetConfigs | null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type?: ComputerTypeConfig | null` `type`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `cursor_position?: ComputerCursorPositionConfig | null` `cursor_position`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click?: ComputerDoubleClickConfig | null` `double_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key?: ComputerHoldKeyConfig | null` `hold_key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key?: ComputerKeyConfig | null` `key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click?: ComputerLeftClickConfig | null` `left_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag?: ComputerLeftClickDragConfig | null` `left_click_drag`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down?: ComputerLeftMouseDownConfig | null` `left_mouse_down`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up?: ComputerLeftMouseUpConfig | null` `left_mouse_up`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click?: ComputerMiddleClickConfig | null` `middle_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move?: ComputerMouseMoveConfig | null` `mouse_move`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click?: ComputerRightClickConfig | null` `right_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot?: ComputerScreenshotConfig | null` `screenshot`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll?: ComputerScrollConfig | null` `scroll`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click?: ComputerTripleClickConfig | null` `triple_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait?: ComputerWaitConfig | null` `wait`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom?: ComputerZoomConfig | null` `zoom`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `interface ToolTextEditor20250124` - `type: "text_editor_20250124"` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolTextEditor20250429` - `type: "text_editor_20250429"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolTextEditor20250728` - `type: "text_editor_20250728"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `max_characters?: number | null` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface WebSearchTool20250305` - `type: "web_search_20250305"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city?: string | null` The city of the user. minLength: 1, maxLength: 255 - `country?: string | null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `region?: string | null` The region of the user. minLength: 1, maxLength: 255 - `timezone?: string | null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `interface WebFetchTool20250910` - `type: "web_fetch_20250910"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `enabled?: boolean` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `client_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type: "all"` - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type: "none"` - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type: "only"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `type: "except"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `server_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `user_input?: WebFetchURLSourceAll | WebFetchURLSourceNone` Whether URLs in user messages are fetchable: "all" or "none". - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `interface WebSearchTool20260209` - `type: "web_search_20260209"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `interface WebFetchTool20260209` - `type: "web_fetch_20260209"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `interface WebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `type: "web_fetch_20260309"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache?: boolean` 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. - `interface WebSearchTool20260318` - `type: "web_search_20260318"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion?: "full" | "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `interface WebFetchTool20260318` - `type: "web_fetch_20260318"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion?: "full" | "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache?: boolean` 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. - `interface ToolSearchToolBm25_20251119` - `type: "tool_search_tool_bm25_20251119" | "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `name: "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolSearchToolRegex20251119` - `type: "tool_search_tool_regex_20251119" | "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `name: "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs ### Tool Use Block - `interface ToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: Record` - `name: string` minLength: 1 - `toolset_name?: string | null` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ ### Tool Use Block Param - `interface ToolUseBlockParam` - `type: "tool_use"` - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `input: Record` - `name: string` minLength: 1, maxLength: 200 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `toolset_name?: string | null` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ ### Tool Use Caller - `type ToolUseCaller = DirectCaller | ServerToolCaller | ServerToolCaller20260120` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Toolset Tool Use Block - `type ToolsetToolUseBlock = BrowserToolUseBlock | ComputerToolUseBlock | ToolUseBlock` - `type BrowserToolUseBlock = BrowserNavigateToolUseBlock | BrowserListTabsToolUseBlock | BrowserNewTabToolUseBlock | 28 more` - `interface BrowserNavigateToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: BrowserNavigateInput` Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://). - `url: string` The URL to navigate to, or "back" / "forward" / "reload" for history navigation. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "navigate"` - `toolset_name: "browser"` - `interface BrowserListTabsToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserListTabsInput` List all open tabs with each tab's tab_id, title, and URL. - `name: "list_tabs"` - `toolset_name: "browser"` - `interface BrowserNewTabToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserNewTabInput` Open a new empty tab and return its tab_id. - `name: "new_tab"` - `toolset_name: "browser"` - `interface BrowserSwitchTabToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserSwitchTabInput` Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to. - `tab_id: string` The tab to switch to. - `name: "switch_tab"` - `toolset_name: "browser"` - `interface BrowserCloseTabToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserCloseTabInput` Close the tab with the given tab_id. - `tab_id: string` The tab to close. - `name: "close_tab"` - `toolset_name: "browser"` - `interface BrowserReadPageToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserReadPageInput` Return a structured accessibility tree of the page (or the subtree rooted at `ref`), with element references like [ref_7] that can be used as targets on later actions. Output is capped at 50,000 characters — narrow with `ref` or a smaller `depth` when exceeded. - `depth?: number | null` Maximum tree depth. Default 15. minimum: 1 - `filter?: BrowserReadPageFilter | null` Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements. - `"all"` - `"interactive"` - `ref?: string | null` Element reference to read a subtree from. Omit to read from the page root. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "read_page"` - `toolset_name: "browser"` - `interface BrowserGetPageTextToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserGetPageTextInput` Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "get_page_text"` - `toolset_name: "browser"` - `interface BrowserReadConsoleToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserReadConsoleInput` Return console output (log entries, errors, warnings) accumulated since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "read_console"` - `toolset_name: "browser"` - `interface BrowserReadNetworkToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserReadNetworkInput` Return the network requests (method, URL, status, MIME type, timing) recorded since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "read_network"` - `toolset_name: "browser"` - `interface BrowserFindToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserFindInput` Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references. - `query: string` Natural-language description of the element(s) to find. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "find"` - `toolset_name: "browser"` - `interface BrowserFormInputToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserFormInputInput` Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects. - `target: BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `type: "ref"` - `ref: string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `value: BrowserFormInputValue` The value to set. - `string` - `number` - `boolean` - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "form_input"` - `toolset_name: "browser"` - `interface BrowserFileUploadToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserFileUploadInput` Set the value of a file-input element to one or more files. The target must be an element reference; at least one of paths or document_ids is required. - `target: BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `document_ids?: Array | null` References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem. minItems: 1 - `paths?: Array | null` File paths on the browser executor's filesystem. minItems: 1 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "file_upload"` - `toolset_name: "browser"` - `interface BrowserScrollToToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserScrollToInput` Scroll an element into view. - `target: BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "scroll_to"` - `toolset_name: "browser"` - `interface BrowserScreenshotToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserScreenshotInput` Capture the current browser viewport. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "screenshot"` - `toolset_name: "browser"` - `interface BrowserZoomToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserZoomInput` Return a cropped screenshot of the given viewport region, scaled up for closer inspection — useful for small icons, buttons, or text. Coordinates are in the same viewport-pixel space as a full screenshot. - `region: Array` [x0, y0, x1, y1] in viewport pixels. minItems: 4, maxItems: 4 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "zoom"` - `toolset_name: "browser"` - `interface BrowserLeftClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserLeftClickInput` Left-click at a viewport coordinate or on an element by reference. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `interface BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `type: "coordinate"` - `x: number` Pixels from the left edge of the viewport. minimum: 0 - `y: number` Pixels from the top edge of the viewport. minimum: 0 - `interface BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "left_click"` - `toolset_name: "browser"` - `interface BrowserRightClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserRightClickInput` Right-click at a viewport coordinate or on an element by reference. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "right_click"` - `toolset_name: "browser"` - `interface BrowserMiddleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserMiddleClickInput` Middle-click at a viewport coordinate or on an element by reference. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "middle_click"` - `toolset_name: "browser"` - `interface BrowserDoubleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserDoubleClickInput` Double left-click at a viewport coordinate or on an element by reference. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "double_click"` - `toolset_name: "browser"` - `interface BrowserTripleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserTripleClickInput` Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph). - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `modifiers?: string | null` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "triple_click"` - `toolset_name: "browser"` - `interface BrowserHoverToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserHoverInput` Move the cursor to a coordinate or element without clicking. - `target: BrowserClickTarget` Where to act: either a viewport coordinate or an element reference. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "hover"` - `toolset_name: "browser"` - `interface BrowserLeftClickDragToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserLeftClickDragInput` Press at `from`, drag to `target`, release. Both must be coordinate targets. - `from: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "left_click_drag"` - `toolset_name: "browser"` - `interface BrowserLeftMouseDownToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserLeftMouseDownInput` Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag. - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "left_mouse_down"` - `toolset_name: "browser"` - `interface BrowserLeftMouseUpToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserLeftMouseUpInput` Release the left mouse button at a viewport coordinate. - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "left_mouse_up"` - `toolset_name: "browser"` - `interface BrowserMouseMoveToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserMouseMoveInput` Move the pointer to a viewport coordinate without clicking. - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "mouse_move"` - `toolset_name: "browser"` - `interface BrowserScrollToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserScrollInput` Scroll at a viewport position. `target` must be a coordinate target. - `scroll_direction: BrowserScrollDirection` - `"up"` - `"down"` - `"left"` - `"right"` - `target: BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `scroll_amount?: number | null` Scroll-wheel notches (1–10). Default 3. minimum: 1, maximum: 10 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "scroll"` - `toolset_name: "browser"` - `interface BrowserTypeToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserTypeInput` Type a literal string at the current focus. - `text: string` The text to type. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "type"` - `toolset_name: "browser"` - `interface BrowserKeyToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserKeyInput` Press a key or key chord. Use "+" to combine modifiers with a key (e.g. "ctrl+a", "cmd+shift+p") and space to sequence presses (e.g. "Backspace Backspace Delete"). Common names like "Return", "Tab", "Escape", "BackSpace" are supported. - `text: string` The key, chord, or space-separated sequence to press. - `repeat?: number | null` Number of times to repeat. Default 1. minimum: 1, maximum: 100 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "key"` - `toolset_name: "browser"` - `interface BrowserHoldKeyToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserHoldKeyInput` Hold a key or key chord down for a duration, then release it. Uses the same key names and "+" chord syntax as the key action. - `duration: number` Seconds to hold the key down (maximum 30). minimum: 0, maximum: 30 - `text: string` The key or chord to hold. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "hold_key"` - `toolset_name: "browser"` - `interface BrowserWaitToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserWaitInput` Pause for the given duration. - `duration: number` Seconds to wait (maximum 30). minimum: 0, maximum: 30 - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "wait"` - `toolset_name: "browser"` - `interface BrowserJavascriptExecToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: BrowserJavascriptExecInput` Execute JavaScript in the page context and return the value of the last expression. The code runs with access to the DOM, `window`, and page variables. Write the expression you want evaluated — do NOT use `return`. - `text: string` JavaScript to execute in the page context. - `tab_id?: string | null` Tab to act on. Defaults to the active tab when omitted. - `name: "javascript_exec"` - `toolset_name: "browser"` - `type ComputerToolUseBlock = ComputerKeyToolUseBlock | ComputerHoldKeyToolUseBlock | ComputerTypeToolUseBlock | 14 more` - `interface ComputerKeyToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerKeyInput` Press a key or key-combination on the keyboard. Use "+" to combine modifiers with a key (e.g. "ctrl+s", "alt+Tab", "ctrl+shift+Escape"). Key names are case-insensitive; common names like "Return", "Tab", "Escape", "Up", "Down", "Left", "Right", "Home", "End", "Page_Up", "Page_Down", "Delete", "BackSpace" are supported. - `text: string` The key or key-combination to press. - `repeat?: number | null` Number of times to repeat the key press. Default is 1. minimum: 1, maximum: 100 - `name: "key"` - `toolset_name: "computer"` - `interface ComputerHoldKeyToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerHoldKeyInput` Hold down a key or key-combination for a specified duration. Uses the same key syntax as `key`. - `duration: number` Duration to hold the key, in seconds. maximum: 300 - `text: string` The key or key-combination to hold. - `name: "hold_key"` - `toolset_name: "computer"` - `interface ComputerTypeToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerTypeInput` Type a string of text on the keyboard. - `text: string` The text to type. - `name: "type"` - `toolset_name: "computer"` - `interface ComputerCursorPositionToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerCursorPositionInput` Get the current (x, y) pixel coordinate of the cursor. - `name: "cursor_position"` - `toolset_name: "computer"` - `interface ComputerMouseMoveToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerMouseMoveInput` Move the cursor to a specified (x, y) pixel coordinate. Use this ONLY to hover without clicking; otherwise use a click action directly. - `coordinate: Array` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `name: "mouse_move"` - `toolset_name: "computer"` - `interface ComputerLeftMouseDownToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerLeftMouseDownInput` Press and hold the left mouse button at the current cursor position. - `name: "left_mouse_down"` - `toolset_name: "computer"` - `interface ComputerLeftMouseUpToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerLeftMouseUpInput` Release the left mouse button. - `name: "left_mouse_up"` - `toolset_name: "computer"` - `interface ComputerLeftClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerLeftClickInput` Click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "left_click"` - `toolset_name: "computer"` - `interface ComputerLeftClickDragToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerLeftClickDragInput` Click and drag the cursor from `start_coordinate` to `coordinate`. - `coordinate: Array` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `start_coordinate: Array` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "left_click_drag"` - `toolset_name: "computer"` - `interface ComputerRightClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerRightClickInput` Click the right mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "right_click"` - `toolset_name: "computer"` - `interface ComputerMiddleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerMiddleClickInput` Click the middle mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "middle_click"` - `toolset_name: "computer"` - `interface ComputerDoubleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerDoubleClickInput` Double-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "double_click"` - `toolset_name: "computer"` - `interface ComputerTripleClickToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerTripleClickInput` Triple-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "triple_click"` - `toolset_name: "computer"` - `interface ComputerScrollToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerScrollInput` Scroll the screen at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. Do NOT use PageUp/PageDown to scroll. - `scroll_amount: number` Number of 'clicks' of the scroll wheel. - `scroll_direction: ComputerScrollDirection` - `"up"` - `"down"` - `"left"` - `"right"` - `coordinate?: Array | null` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `text?: string | null` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `name: "scroll"` - `toolset_name: "computer"` - `interface ComputerWaitToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerWaitInput` Wait for a specified duration. - `duration: number` Duration to wait, in seconds. maximum: 300 - `name: "wait"` - `toolset_name: "computer"` - `interface ComputerScreenshotToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerScreenshotInput` Take a screenshot of the screen. - `name: "screenshot"` - `toolset_name: "computer"` - `interface ComputerZoomToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: ToolUseCaller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `input: ComputerZoomInput` Take a screenshot of a rectangular region. Region coordinates are in the full-screenshot space (not physical display pixels). The crop is scaled up to fill the image budget so fine details become legible. - `region: Array` (x0, y0, x1, y1): The region to capture. minItems: 4, maxItems: 4 - `name: "zoom"` - `toolset_name: "computer"` - `interface ToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `input: Record` - `name: string` minLength: 1 - `toolset_name?: string | null` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ ### URL Image Source - `interface URLImageSource` - `type: "url"` - `url: string` ### URL PDF Source - `interface URLPDFSource` - `type: "url"` - `url: string` ### Usage - `interface Usage` - `cache_creation: CacheCreation | null` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `cache_creation_input_tokens: number | null` The number of input tokens used to create the cache entry. minimum: 0 - `cache_read_input_tokens: number | null` The number of input tokens read from the cache. minimum: 0 - `inference_geo: string | null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. minimum: 0 - `output_tokens: number` The number of output tokens which were used. minimum: 0 - `output_tokens_details: OutputTokensDetails | null` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `thinking_tokens: number` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. default: 0, minimum: 0 - `server_tool_use: ServerToolUsage | null` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. default: 0, minimum: 0 - `web_search_requests: number` The number of web search tool requests. default: 0, minimum: 0 - `service_tier: "standard" | "priority" | "batch" | null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` ### User Location - `interface UserLocation` - `type: "approximate"` - `city?: string | null` The city of the user. minLength: 1, maxLength: 255 - `country?: string | null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `region?: string | null` The region of the user. minLength: 1, maxLength: 255 - `timezone?: string | null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 ### Web Fetch Block - `interface WebFetchBlock` - `type: "web_fetch_result"` default: web_fetch_result - `content: DocumentBlock` - `type: "document"` default: document - `citations: CitationsConfig | null` Citation configuration for the document - `enabled: boolean` default: false - `source: Base64PDFSource | PlainTextSource` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `title: string | null` The title of the document - `retrieved_at: string | null` ISO 8601 timestamp when the content was retrieved - `url: string` Fetched content URL ### Web Fetch Block Param - `interface WebFetchBlockParam` - `type: "web_fetch_result"` - `content: DocumentBlockParam` - `type: "document"` - `source: Base64PDFSource | PlainTextSource | ContentBlockSource | 2 more` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `interface ContentBlockSource` - `type: "content"` - `content: string | Array` - `string` - `Array` - `interface TextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `citations?: Array | null` - `interface CitationCharLocationParam` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `interface CitationPageLocationParam` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocationParam` - `type: "content_block_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationWebSearchResultLocationParam` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string | null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `interface CitationSearchResultLocationParam` - `type: "search_result_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `interface ImageBlockParam` - `type: "image"` - `source: Base64ImageSource | URLImageSource | FileImageSource` - `interface Base64ImageSource` - `type: "base64"` - `data: string` format: byte - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `interface URLImageSource` - `type: "url"` - `url: string` - `interface FileImageSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `transformations?: ImageTransformationsParam | null` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `oversized_image?: "downsize" | "error"` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `"downsize"` - `"error"` - `interface URLPDFSource` - `type: "url"` - `url: string` - `interface FileDocumentSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` - `enabled?: boolean` - `context?: string | null` minLength: 1 - `title?: string | null` minLength: 1, maxLength: 500 - `url: string` Fetched content URL - `retrieved_at?: string | null` ISO 8601 timestamp when the content was retrieved ### Web Fetch Tool 20250910 - `interface WebFetchTool20250910` - `type: "web_fetch_20250910"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `enabled?: boolean` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `client_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type: "all"` - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type: "none"` - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type: "only"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `type: "except"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `server_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `user_input?: WebFetchURLSourceAll | WebFetchURLSourceNone` Whether URLs in user messages are fetchable: "all" or "none". - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. ### Web Fetch Tool 20260209 - `interface WebFetchTool20260209` - `type: "web_fetch_20260209"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `enabled?: boolean` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `client_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type: "all"` - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type: "none"` - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type: "only"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `type: "except"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `server_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `user_input?: WebFetchURLSourceAll | WebFetchURLSourceNone` Whether URLs in user messages are fetchable: "all" or "none". - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. ### Web Fetch Tool 20260309 - `interface WebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `type: "web_fetch_20260309"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `enabled?: boolean` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `client_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type: "all"` - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type: "none"` - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type: "only"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `type: "except"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `server_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `user_input?: WebFetchURLSourceAll | WebFetchURLSourceNone` Whether URLs in user messages are fetchable: "all" or "none". - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `use_cache?: boolean` 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. ### Web Fetch Tool 20260318 - `interface WebFetchTool20260318` - `type: "web_fetch_20260318"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `enabled?: boolean` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion?: "full" | "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `client_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type: "all"` - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type: "none"` - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type: "only"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `type: "except"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `server_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `user_input?: WebFetchURLSourceAll | WebFetchURLSourceNone` Whether URLs in user messages are fetchable: "all" or "none". - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `use_cache?: boolean` 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. ### Web Fetch Tool Result Block - `interface WebFetchToolResultBlock` - `type: "web_fetch_tool_result"` default: web_fetch_tool_result - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `content: WebFetchToolResultErrorBlock | WebFetchBlock` - `interface WebFetchToolResultErrorBlock` - `type: "web_fetch_tool_result_error"` default: web_fetch_tool_result_error - `error_code: WebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `interface WebFetchBlock` - `type: "web_fetch_result"` default: web_fetch_result - `content: DocumentBlock` - `type: "document"` default: document - `citations: CitationsConfig | null` Citation configuration for the document - `enabled: boolean` default: false - `source: Base64PDFSource | PlainTextSource` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `title: string | null` The title of the document - `retrieved_at: string | null` ISO 8601 timestamp when the content was retrieved - `url: string` Fetched content URL - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Web Fetch Tool Result Block Param - `interface WebFetchToolResultBlockParam` - `type: "web_fetch_tool_result"` - `content: WebFetchToolResultErrorBlockParam | WebFetchBlockParam` - `interface WebFetchToolResultErrorBlockParam` - `type: "web_fetch_tool_result_error"` - `error_code: WebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `interface WebFetchBlockParam` - `type: "web_fetch_result"` - `content: DocumentBlockParam` - `type: "document"` - `source: Base64PDFSource | PlainTextSource | ContentBlockSource | 2 more` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `interface ContentBlockSource` - `type: "content"` - `content: string | Array` - `string` - `Array` - `interface TextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `citations?: Array | null` - `interface CitationCharLocationParam` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `interface CitationPageLocationParam` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocationParam` - `type: "content_block_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationWebSearchResultLocationParam` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string | null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `interface CitationSearchResultLocationParam` - `type: "search_result_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `interface ImageBlockParam` - `type: "image"` - `source: Base64ImageSource | URLImageSource | FileImageSource` - `interface Base64ImageSource` - `type: "base64"` - `data: string` format: byte - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `interface URLImageSource` - `type: "url"` - `url: string` - `interface FileImageSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `transformations?: ImageTransformationsParam | null` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `oversized_image?: "downsize" | "error"` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `"downsize"` - `"error"` - `interface URLPDFSource` - `type: "url"` - `url: string` - `interface FileDocumentSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` - `enabled?: boolean` - `context?: string | null` minLength: 1 - `title?: string | null` minLength: 1, maxLength: 500 - `url: string` Fetched content URL - `retrieved_at?: string | null` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Web Fetch Tool Result Error Block - `interface WebFetchToolResultErrorBlock` - `type: "web_fetch_tool_result_error"` default: web_fetch_tool_result_error - `error_code: WebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` ### Web Fetch Tool Result Error Block Param - `interface WebFetchToolResultErrorBlockParam` - `type: "web_fetch_tool_result_error"` - `error_code: WebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` ### Web Fetch Tool Result Error Code - `type WebFetchToolResultErrorCode = "invalid_tool_input" | "url_too_long" | "url_not_allowed" | 7 more` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` ### Web Fetch URL Source All - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type: "all"` ### Web Fetch URL Source Except - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `type: "except"` - `tools: Array` - `type: "tool_reference"` - `name: string` ### Web Fetch URL Source None - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type: "none"` ### Web Fetch URL Source Only - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type: "only"` - `tools: Array` - `type: "tool_reference"` - `name: string` ### Web Fetch URL Source Tool Reference - `interface WebFetchURLSourceToolReference` One entry of a tool filter's `tools`: it must name a tool declared in this request's `tools[]`. - `type: "tool_reference"` - `name: string` ### Web Fetch URL Sources - `interface WebFetchURLSources` Which sources contribute to the set of URLs web fetch may fetch. Each key is a tagged variant: `user_input` is `all` or `none`; the two tool filters are `all`, `none`, `only` (only the named tools' results) or `except` (every result but the named tools'). A named tool must be declared in this request's `tools[]`. - `client_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type: "all"` - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type: "none"` - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type: "only"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `type: "except"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `server_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `user_input?: WebFetchURLSourceAll | WebFetchURLSourceNone` Whether URLs in user messages are fetchable: "all" or "none". - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. ### Web Search Result Block - `interface WebSearchResultBlock` - `type: "web_search_result"` default: web_search_result - `encrypted_content: string` - `page_age: string | null` - `title: string` - `url: string` ### Web Search Result Block Param - `interface WebSearchResultBlockParam` - `type: "web_search_result"` - `encrypted_content: string` - `title: string` - `url: string` - `page_age?: string | null` ### Web Search Tool 20250305 - `interface WebSearchTool20250305` - `type: "web_search_20250305"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city?: string | null` The city of the user. minLength: 1, maxLength: 255 - `country?: string | null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `region?: string | null` The region of the user. minLength: 1, maxLength: 255 - `timezone?: string | null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 ### Web Search Tool 20260209 - `interface WebSearchTool20260209` - `type: "web_search_20260209"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city?: string | null` The city of the user. minLength: 1, maxLength: 255 - `country?: string | null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `region?: string | null` The region of the user. minLength: 1, maxLength: 255 - `timezone?: string | null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 ### Web Search Tool 20260318 - `interface WebSearchTool20260318` - `type: "web_search_20260318"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion?: "full" | "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city?: string | null` The city of the user. minLength: 1, maxLength: 255 - `country?: string | null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `region?: string | null` The region of the user. minLength: 1, maxLength: 255 - `timezone?: string | null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 ### Web Search Tool Request Error - `interface WebSearchToolRequestError` - `type: "web_search_tool_result_error"` - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` ### Web Search Tool Result Block - `interface WebSearchToolResultBlock` - `type: "web_search_tool_result"` default: web_search_tool_result - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `content: WebSearchToolResultBlockContent` - `interface WebSearchToolResultError` - `type: "web_search_tool_result_error"` default: web_search_tool_result_error - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `Array` - `type: "web_search_result"` default: web_search_result - `encrypted_content: string` - `page_age: string | null` - `title: string` - `url: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Web Search Tool Result Block Content - `type WebSearchToolResultBlockContent = WebSearchToolResultError | Array` - `interface WebSearchToolResultError` - `type: "web_search_tool_result_error"` default: web_search_tool_result_error - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `Array` - `type: "web_search_result"` default: web_search_result - `encrypted_content: string` - `page_age: string | null` - `title: string` - `url: string` ### Web Search Tool Result Block Param - `interface WebSearchToolResultBlockParam` - `type: "web_search_tool_result"` - `content: WebSearchToolResultBlockParamContent` - `Array` - `type: "web_search_result"` - `encrypted_content: string` - `title: string` - `url: string` - `page_age?: string | null` - `interface WebSearchToolRequestError` - `type: "web_search_tool_result_error"` - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Web Search Tool Result Block Param Content - `type WebSearchToolResultBlockParamContent = Array | WebSearchToolRequestError` - `Array` - `type: "web_search_result"` - `encrypted_content: string` - `title: string` - `url: string` - `page_age?: string | null` - `interface WebSearchToolRequestError` - `type: "web_search_tool_result_error"` - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` ### Web Search Tool Result Error - `interface WebSearchToolResultError` - `type: "web_search_tool_result_error"` default: web_search_tool_result_error - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` ### Web Search Tool Result Error Code - `type WebSearchToolResultErrorCode = "invalid_tool_input" | "unavailable" | "max_uses_exceeded" | 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` ## Messages › Batches ### Create a Message Batch `client.messages.batches.create(params, options?): MessageBatch` **POST** `/v1/messages/batches` Send a batch of Message creation requests. The Message Batches API can be used to process multiple Messages API requests at once. Once a Message Batch is created, it begins processing immediately. Batches can take up to 24 hours to complete. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=typescript) #### Parameters - `params: BatchCreateParams` - `requests: Array` List of requests for prompt completion. Each is an individual request to create a Message. minItems: 1, maxItems: 100000 - `custom_id: string` Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order. Must be unique for each request within the Message Batch. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]{1,64}$ - `params: Params` Messages API creation parameters for the individual request. See the [Messages API reference](https://platform.claude.com/docs/en/api/messages?sdk_languages=typescript) for full documentation on available parameters. - `max_tokens: number` The maximum number of tokens to generate before stopping. Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=typescript) for details. minimum: 0 - `messages: Array` Input messages. Our 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. Each 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. If 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. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=typescript#prefill-not-supported). Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude, for models that support prefill: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each 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: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=typescript). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=typescript#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `content: string | Array` - `string` - `Array` - `interface TextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl?: "5m" | "1h"` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=typescript) for details. - `"5m"` - `"1h"` - `citations?: Array | null` - `interface CitationCharLocationParam` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `interface CitationPageLocationParam` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocationParam` - `type: "content_block_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` minLength: 1, maxLength: 500 - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationWebSearchResultLocationParam` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string | null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `interface CitationSearchResultLocationParam` - `type: "search_result_location"` - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `interface ImageBlockParam` - `type: "image"` - `source: Base64ImageSource | URLImageSource | FileImageSource` - `interface Base64ImageSource` - `type: "base64"` - `data: string` format: byte - `media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `interface URLImageSource` - `type: "url"` - `url: string` - `interface FileImageSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `transformations?: ImageTransformationsParam | null` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `oversized_image?: "downsize" | "error"` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `"downsize"` - `"error"` - `interface DocumentBlockParam` - `type: "document"` - `source: Base64PDFSource | PlainTextSource | ContentBlockSource | 2 more` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `interface ContentBlockSource` - `type: "content"` - `content: string | Array` - `string` - `Array` - `interface TextBlockParam` - `interface ImageBlockParam` - `interface URLPDFSource` - `type: "url"` - `url: string` - `interface FileDocumentSource` - `type: "file"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` - `enabled?: boolean` - `context?: string | null` minLength: 1 - `title?: string | null` minLength: 1, maxLength: 500 - `interface SearchResultBlockParam` - `type: "search_result"` - `content: Array` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `source: string` - `title: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam` - `interface ThinkingBlockParam` - `type: "thinking"` - `signature: string` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `thinking: string` The `thinking` text of this block as returned by the API. - `interface RedactedThinkingBlockParam` - `type: "redacted_thinking"` - `data: string` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `interface ToolUseBlockParam` - `type: "tool_use"` - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `input: Record` - `name: string` minLength: 1, maxLength: 200 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `toolset_name?: string | null` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ToolResultBlockParam` - `type: "tool_result"` - `tool_use_id: string` pattern: ^[a-zA-Z0-9_-]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `content?: string | Array` - `string` - `Array` - `interface TextBlockParam` - `interface ImageBlockParam` - `interface SearchResultBlockParam` - `interface DocumentBlockParam` - `interface ToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface BrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `type: "browser_state"` - `tabs: Array` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `tab_id: string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `title: string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `active?: boolean` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `state_changes?: Array | null` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `interface BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `type: "tab_opened"` - `tab_id: string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `interface BrowserStateChangeDownloadStarted` A file download that started during this call. - `type: "download_started"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `interface BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `type: "download_completed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path?: string | null` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `size_bytes?: number | null` The completed download's size. minimum: 0 - `interface BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `type: "download_failed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `error?: string | null` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `is_error?: boolean` - `toolset_name?: string | null` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ServerToolUseBlockParam` - `type: "server_tool_use"` - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: Record` - `name: "web_search" | "web_fetch" | "code_execution" | 4 more` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `interface WebSearchToolResultBlockParam` - `type: "web_search_tool_result"` - `content: WebSearchToolResultBlockParamContent` - `Array` - `type: "web_search_result"` - `encrypted_content: string` - `title: string` - `url: string` - `page_age?: string | null` - `interface WebSearchToolRequestError` - `type: "web_search_tool_result_error"` - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `interface WebFetchToolResultBlockParam` - `type: "web_fetch_tool_result"` - `content: WebFetchToolResultErrorBlockParam | WebFetchBlockParam` - `interface WebFetchToolResultErrorBlockParam` - `type: "web_fetch_tool_result_error"` - `error_code: WebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `interface WebFetchBlockParam` - `type: "web_fetch_result"` - `content: DocumentBlockParam` - `url: string` Fetched content URL - `retrieved_at?: string | null` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `caller?: DirectCaller | ServerToolCaller | ServerToolCaller20260120` - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `interface CodeExecutionToolResultBlockParam` - `type: "code_execution_tool_result"` - `content: CodeExecutionToolResultBlockParamContent` - `interface CodeExecutionToolResultErrorParam` - `type: "code_execution_tool_result_error"` - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `interface CodeExecutionResultBlockParam` - `type: "code_execution_result"` - `content: Array` - `type: "code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `interface EncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` - `content: Array` - `type: "code_execution_output"` - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface BashCodeExecutionToolResultBlockParam` - `type: "bash_code_execution_tool_result"` - `content: BashCodeExecutionToolResultErrorParam | BashCodeExecutionResultBlockParam` - `interface BashCodeExecutionToolResultErrorParam` - `type: "bash_code_execution_tool_result_error"` - `error_code: BashCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `interface BashCodeExecutionResultBlockParam` - `type: "bash_code_execution_result"` - `content: Array` - `type: "bash_code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface TextEditorCodeExecutionToolResultBlockParam` - `type: "text_editor_code_execution_tool_result"` - `content: TextEditorCodeExecutionToolResultErrorParam | TextEditorCodeExecutionViewResultBlockParam | TextEditorCodeExecutionCreateResultBlockParam | TextEditorCodeExecutionStrReplaceResultBlockParam` - `interface TextEditorCodeExecutionToolResultErrorParam` - `type: "text_editor_code_execution_tool_result_error"` - `error_code: TextEditorCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message?: string | null` - `interface TextEditorCodeExecutionViewResultBlockParam` - `type: "text_editor_code_execution_view_result"` - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines?: number | null` - `start_line?: number | null` - `total_lines?: number | null` - `interface TextEditorCodeExecutionCreateResultBlockParam` - `type: "text_editor_code_execution_create_result"` - `is_file_update: boolean` - `interface TextEditorCodeExecutionStrReplaceResultBlockParam` - `type: "text_editor_code_execution_str_replace_result"` - `lines?: Array | null` - `new_lines?: number | null` - `new_start?: number | null` - `old_lines?: number | null` - `old_start?: number | null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface ToolSearchToolResultBlockParam` - `type: "tool_search_tool_result"` - `content: ToolSearchToolResultErrorParam | ToolSearchToolSearchResultBlockParam` - `interface ToolSearchToolResultErrorParam` - `type: "tool_search_tool_result_error"` - `error_code: ToolSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message?: string | null` - `interface ToolSearchToolSearchResultBlockParam` - `type: "tool_search_tool_search_result"` - `tool_references: Array` - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `interface ContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `type: "container_upload"` - `file_id: string` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `role: "user" | "assistant" | "system"` - `"user"` - `"assistant"` - `"system"` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-mythos-5"` Most capable model for cybersecurity and biology research - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `(string & {})` - `cache_control?: CacheControlEphemeral | null` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `container?: MessageCreateParamsContainer | null` Container identifier for reuse across requests. - `interface ContainerParams` Container parameters with skills to be loaded. - `id?: string | null` Container id - `skills?: Array | null` List of skills to load in the container maxItems: 20 - `type: "anthropic" | "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version?: string` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 - `string` - `diagnostics?: DiagnosticsParam | null` Request-level diagnostics. Supply `previous_message_id` to have the response include `diagnostics.cache_miss_reason` explaining any prompt-cache divergence from that prior request. - `previous_message_id?: string | null` The `id` (`msg_...`) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns `diagnostics.cache_miss_reason` when the prompt-cache prefix could not be reused. Pass `null` on the first turn to opt in without a prior message to compare. maxLength: 256 - `inference_geo?: string | null` Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. - `metadata?: Metadata` An object describing metadata about the request. - `user_id?: string | null` An external identifier for the user who is associated with the request. This 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. maxLength: 512 - `output_config?: OutputConfig` Configuration options for the model's output, such as the output format. - `effort?: "low" | "medium" | "high" | 2 more | null` How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `"max"` - `format?: JSONOutputFormat | null` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=typescript) - `type: "json_schema"` - `schema: Record` The JSON schema of the format - `service_tier?: "auto" | "standard_only"` Determines whether to use priority capacity (if available) or standard capacity for this request. Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers?sdk_languages=typescript) for details. - `"auto"` - `"standard_only"` - `stop_sequences?: Array` Custom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`. If 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. - `stream?: boolean` Whether to incrementally stream the response using server-sent events. When `true`, SDKs return a raw event stream. In the TypeScript, Python and Ruby SDKs, the recommended way to stream is `messages.stream()`. It sets `stream` for you and accumulates the events into the final message. See [Streaming with SDKs](https://platform.claude.com/docs/en/build-with-claude/streaming?sdk_languages=typescript#streaming-with-sdks) for an example in each language. - `system?: string | Array` System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=typescript#give-claude-a-role). - `string` - `Array` - `type: "text"` - `text: string` minLength: 1 - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: Array | null` - `thinking?: ThinkingConfigParam` Configuration for Claude's thinking. With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit. Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=typescript#configuring-thinking) for each model's behavior. - `interface ThinkingConfigEnabled` - `type: "enabled"` - `budget_tokens: number` 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. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript) for details. minimum: 1024 - `display?: "summarized" | "omitted" | null` 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. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=typescript#controlling-thinking-display). - `"summarized"` - `"omitted"` - `interface ThinkingConfigDisabled` - `type: "disabled"` - `interface ThinkingConfigBetweenTools` - `type: "between_tools"` - `interface ThinkingConfigAdaptive` - `type: "adaptive"` - `display?: "summarized" | "omitted" | null` 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. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=typescript#controlling-thinking-display). - `"summarized"` - `"omitted"` - `tool_choice?: ToolChoice` 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. - `interface ToolChoiceAuto` The model will automatically decide whether to use tools. - `type: "auto"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `interface ToolChoiceAny` The model will use any available tools. - `type: "any"` - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `interface ToolChoiceTool` The model will use the specified tool with `tool_choice.name`. - `type: "tool"` - `name: string` The name of the tool to use. - `disable_parallel_tool_use?: boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `interface ToolChoiceNone` The model will not be allowed to use tools. - `type: "none"` - `tools?: Array` Definitions of tools that the model may use. If 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. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=typescript), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=typescript)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `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. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And 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: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You 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: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools 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. See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=typescript) for more details. - `interface Tool` - `type?: "custom" | null` - `input_schema: InputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `type: "object"` - `properties?: Record | null` - `required?: Array | null` - `name: string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `description?: string` Description of what this tool does. Tool 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. - `eager_input_streaming?: boolean | null` 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. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolBash20250124` - `type: "bash_20250124"` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20250522` - `type: "code_execution_20250522"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20250825` - `type: "code_execution_20250825"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `type: "code_execution_20260120"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface CodeExecutionTool20260521` Code execution tool with REPL state persistence. - `type: "code_execution_20260521"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface BrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `type: "browser_toolset_20260801"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `configs?: BrowserToolsetConfigs | null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type?: BrowserTypeConfig | null` `type`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `close_tab?: BrowserCloseTabConfig | null` `close_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click?: BrowserDoubleClickConfig | null` `double_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `file_upload?: BrowserFileUploadConfig | null` `file_upload`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `find?: BrowserFindConfig | null` `find`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `form_input?: BrowserFormInputConfig | null` `form_input`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `get_page_text?: BrowserGetPageTextConfig | null` `get_page_text`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key?: BrowserHoldKeyConfig | null` `hold_key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hover?: BrowserHoverConfig | null` `hover`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `javascript_exec?: BrowserJavascriptExecConfig | null` `javascript_exec`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key?: BrowserKeyConfig | null` `key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click?: BrowserLeftClickConfig | null` `left_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag?: BrowserLeftClickDragConfig | null` `left_click_drag`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down?: BrowserLeftMouseDownConfig | null` `left_mouse_down`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up?: BrowserLeftMouseUpConfig | null` `left_mouse_up`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `list_tabs?: BrowserListTabsConfig | null` `list_tabs`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click?: BrowserMiddleClickConfig | null` `middle_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move?: BrowserMouseMoveConfig | null` `mouse_move`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `navigate?: BrowserNavigateConfig | null` `navigate`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `new_tab?: BrowserNewTabConfig | null` `new_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_console?: BrowserReadConsoleConfig | null` `read_console`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_network?: BrowserReadNetworkConfig | null` `read_network`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_page?: BrowserReadPageConfig | null` `read_page`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click?: BrowserRightClickConfig | null` `right_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot?: BrowserScreenshotConfig | null` `screenshot`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll?: BrowserScrollConfig | null` `scroll`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll_to?: BrowserScrollToConfig | null` `scroll_to`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `switch_tab?: BrowserSwitchTabConfig | null` `switch_tab`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click?: BrowserTripleClickConfig | null` `triple_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait?: BrowserWaitConfig | null` `wait`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom?: BrowserZoomConfig | null` `zoom`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `interface MemoryTool20250818` - `type: "memory_20250818"` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `type: "computer_toolset_20260801"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `configs?: ComputerToolsetConfigs | null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type?: ComputerTypeConfig | null` `type`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `cursor_position?: ComputerCursorPositionConfig | null` `cursor_position`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click?: ComputerDoubleClickConfig | null` `double_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key?: ComputerHoldKeyConfig | null` `hold_key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key?: ComputerKeyConfig | null` `key`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click?: ComputerLeftClickConfig | null` `left_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag?: ComputerLeftClickDragConfig | null` `left_click_drag`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down?: ComputerLeftMouseDownConfig | null` `left_mouse_down`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up?: ComputerLeftMouseUpConfig | null` `left_mouse_up`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click?: ComputerMiddleClickConfig | null` `middle_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move?: ComputerMouseMoveConfig | null` `mouse_move`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click?: ComputerRightClickConfig | null` `right_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot?: ComputerScreenshotConfig | null` `screenshot`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll?: ComputerScrollConfig | null` `scroll`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click?: ComputerTripleClickConfig | null` `triple_click`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait?: ComputerWaitConfig | null` `wait`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom?: ComputerZoomConfig | null` `zoom`'s config overrides. - `defer_loading?: boolean | null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled?: boolean | null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `interface ToolTextEditor20250124` - `type: "text_editor_20250124"` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolTextEditor20250429` - `type: "text_editor_20250429"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolTextEditor20250728` - `type: "text_editor_20250728"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples?: Array>` - `max_characters?: number | null` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface WebSearchTool20250305` - `type: "web_search_20250305"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city?: string | null` The city of the user. minLength: 1, maxLength: 255 - `country?: string | null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `region?: string | null` The region of the user. minLength: 1, maxLength: 255 - `timezone?: string | null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `interface WebFetchTool20250910` - `type: "web_fetch_20250910"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `client_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type: "all"` - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type: "none"` - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type: "only"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `type: "except"` - `tools: Array` - `type: "tool_reference"` - `name: string` - `server_tool_results?: WebFetchURLSourceAll | WebFetchURLSourceNone | WebFetchURLSourceOnly | WebFetchURLSourceExcept` Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute. - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `interface WebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `interface WebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `user_input?: WebFetchURLSourceAll | WebFetchURLSourceNone` Whether URLs in user messages are fetchable: "all" or "none". - `interface WebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `interface WebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `interface WebSearchTool20260209` - `type: "web_search_20260209"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `interface WebFetchTool20260209` - `type: "web_fetch_20260209"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `interface WebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `type: "web_fetch_20260309"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache?: boolean` 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. - `interface WebSearchTool20260318` - `type: "web_search_20260318"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains?: Array | null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion?: "full" | "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `user_location?: UserLocation | null` Parameters for the user's location. Used to provide more relevant search results. - `interface WebFetchTool20260318` - `type: "web_fetch_20260318"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains?: Array | null` List of domains to allow fetching from - `blocked_domains?: Array | null` List of domains to block fetching from - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `citations?: CitationsConfigParam | null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens?: number | null` 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. minimum: 1 - `max_uses?: number | null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion?: "full" | "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `url_sources?: WebFetchURLSources | null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache?: boolean` 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. - `interface ToolSearchToolBm25_20251119` - `type: "tool_search_tool_bm25_20251119" | "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `name: "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `interface ToolSearchToolRegex20251119` - `type: "tool_search_tool_regex_20251119" | "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `name: "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120" | "code_execution_20260521">` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control?: CacheControlEphemeral | null` Create a cache control breakpoint at this content block. - `defer_loading?: boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict?: boolean` When true, guarantees schema validation on tool names and inputs - `temperature?: number` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. Amount of randomness injected into the response. Defaults 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. Note that even with `temperature` of `0.0`, the results will not be fully deterministic. minimum: 0, maximum: 1 - `top_k?: number` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error. Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). Recommended for advanced use cases only. minimum: 0 - `top_p?: number` **Deprecated**: 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. Use nucleus sampling. In 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`. Recommended for advanced use cases only. minimum: 0, maximum: 1 - `user_profile_id?: string` (header parameter) The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. - `workspace_id?: string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `interface MessageBatch` - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. default: message_batch - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string | null` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `cancel_initiated_at: string | null` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. format: date-time - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `ended_at: string | null` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. format: date-time - `expires_at: string` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. format: date-time - `processing_status: "in_progress" | "canceling" | "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: MessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `canceled: number` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. default: 0 - `errored: number` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. default: 0 - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. default: 0 - `processing: number` Number of requests in the Message Batch that are processing. default: 0 - `succeeded: number` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. default: 0 - `results_url: string | null` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. #### Example ```typescript import Anthropic from "@anthropic-ai/sdk"; const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); const messageBatch = await client.messages.batches.create({ requests: [ { custom_id: "my-custom-id-1", params: { max_tokens: 1024, messages: [{ content: "Hello, world", role: "user" }], model: "claude-opus-5" } } ] }); console.log(messageBatch.id); ``` ##### Response (200) ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ### Retrieve a Message Batch `client.messages.batches.retrieve(messageBatchID, params?, options?): MessageBatch` **GET** `/v1/messages/batches/{message_batch_id}` This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the `results_url` field in the response. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=typescript) #### Parameters - `messageBatchID: string` (path parameter) ID of the Message Batch. - `params: BatchRetrieveParams` - `workspace_id?: string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `interface MessageBatch` - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. default: message_batch - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string | null` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `cancel_initiated_at: string | null` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. format: date-time - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `ended_at: string | null` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. format: date-time - `expires_at: string` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. format: date-time - `processing_status: "in_progress" | "canceling" | "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: MessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `canceled: number` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. default: 0 - `errored: number` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. default: 0 - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. default: 0 - `processing: number` Number of requests in the Message Batch that are processing. default: 0 - `succeeded: number` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. default: 0 - `results_url: string | null` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. #### Example ```typescript import Anthropic from "@anthropic-ai/sdk"; const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); const messageBatch = await client.messages.batches.retrieve("message_batch_id"); console.log(messageBatch.id); ``` ##### Response (200) ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ### List Message Batches `client.messages.batches.list(params?, options?): Page` **GET** `/v1/messages/batches` List all Message Batches within a Workspace. Most recently created batches are returned first. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=typescript) #### Parameters - `params: BatchListParams` - `after_id?: string` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `before_id?: string` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `limit?: number` (query parameter) Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. minimum: 1, maximum: 1000 - `workspace_id?: string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `interface MessageBatch` - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. default: message_batch - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string | null` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `cancel_initiated_at: string | null` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. format: date-time - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `ended_at: string | null` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. format: date-time - `expires_at: string` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. format: date-time - `processing_status: "in_progress" | "canceling" | "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: MessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `canceled: number` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. default: 0 - `errored: number` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. default: 0 - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. default: 0 - `processing: number` Number of requests in the Message Batch that are processing. default: 0 - `succeeded: number` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. default: 0 - `results_url: string | null` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. #### Example ```typescript import Anthropic from "@anthropic-ai/sdk"; const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const messageBatch of client.messages.batches.list()) { console.log(messageBatch.id); } ``` ##### Response (200) ```json { "data": [ { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ### Cancel a Message Batch `client.messages.batches.cancel(messageBatchID, params?, options?): MessageBatch` **POST** `/v1/messages/batches/{message_batch_id}/cancel` Batches may be canceled any time before processing ends. Once cancellation is initiated, the batch enters a `canceling` state, at which time the system may complete any in-progress, non-interruptible requests before finalizing cancellation. The number of canceled requests is specified in `request_counts`. To determine which requests were canceled, check the individual results within the batch. Note that cancellation may not result in any canceled requests if they were non-interruptible. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=typescript) #### Parameters - `messageBatchID: string` (path parameter) ID of the Message Batch. - `params: BatchCancelParams` - `workspace_id?: string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `interface MessageBatch` - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. default: message_batch - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string | null` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `cancel_initiated_at: string | null` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. format: date-time - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `ended_at: string | null` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. format: date-time - `expires_at: string` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. format: date-time - `processing_status: "in_progress" | "canceling" | "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: MessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `canceled: number` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. default: 0 - `errored: number` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. default: 0 - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. default: 0 - `processing: number` Number of requests in the Message Batch that are processing. default: 0 - `succeeded: number` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. default: 0 - `results_url: string | null` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. #### Example ```typescript import Anthropic from "@anthropic-ai/sdk"; const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); const messageBatch = await client.messages.batches.cancel("message_batch_id"); console.log(messageBatch.id); ``` ##### Response (200) ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ### Delete a Message Batch `client.messages.batches.delete(messageBatchID, params?, options?): DeletedMessageBatch` **DELETE** `/v1/messages/batches/{message_batch_id}` Delete a Message Batch. Message Batches can only be deleted once they've finished processing. If you'd like to delete an in-progress batch, you must first cancel it. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=typescript) #### Parameters - `messageBatchID: string` (path parameter) ID of the Message Batch. - `params: BatchDeleteParams` - `workspace_id?: string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `interface DeletedMessageBatch` - `type: "message_batch_deleted"` Deleted object type. For Message Batches, this is always `"message_batch_deleted"`. default: message_batch_deleted - `id: string` ID of the Message Batch. #### Example ```typescript import Anthropic from "@anthropic-ai/sdk"; const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); const deletedMessageBatch = await client.messages.batches.delete("message_batch_id"); console.log(deletedMessageBatch.id); ``` ##### Response (200) ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "type": "message_batch_deleted" } ``` ### Retrieve Message Batch results `client.messages.batches.results(messageBatchID, params?, options?): MessageBatchIndividualResponse | Stream` **GET** `/v1/messages/batches/{message_batch_id}/results` Streams the results of a Message Batch as a `.jsonl` file. Each line in the file is a JSON object containing the result of a single request in the Message Batch. Results are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=typescript) #### Parameters - `messageBatchID: string` (path parameter) ID of the Message Batch. - `params: BatchResultsParams` - `workspace_id?: string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `interface MessageBatchIndividualResponse` This is a single line in the response `.jsonl` file and does not represent the response as a whole. - `custom_id: string` Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order. Must be unique for each request within the Message Batch. - `result: MessageBatchResult` Processing result for this request. Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration. - `interface MessageBatchSucceededResult` - `type: "succeeded"` default: succeeded - `message: Message` - `type: "message"` Object type. For Messages, this is always `"message"`. default: message - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: Container | null` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. format: date-time - `skills: Array | null` Skills loaded in the container - `type: "anthropic" | "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version: string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `content: Array` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If 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. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `interface TextBlock` - `type: "text"` default: text - `citations: Array | null` Citations supporting the text block. The 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`. - `interface CitationCharLocation` - `type: "char_location"` default: char_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_char_index: number` - `file_id: string | null` - `start_char_index: number` minimum: 0 - `interface CitationPageLocation` - `type: "page_location"` default: page_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string | null` - `end_page_number: number` - `file_id: string | null` - `start_page_number: number` minimum: 1 - `interface CitationContentBlockLocation` - `type: "content_block_location"` default: content_block_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `document_index: number` minimum: 0 - `document_title: string | null` - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `file_id: string | null` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `interface CitationsWebSearchResultLocation` - `type: "web_search_result_location"` default: web_search_result_location - `cited_text: string` - `encrypted_index: string` - `title: string | null` maxLength: 512 - `url: string` - `interface CitationsSearchResultLocation` - `type: "search_result_location"` default: search_result_location - `cited_text: string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `search_result_index: number` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string | null` - `text: string` - `interface ThinkingBlock` - `type: "thinking"` default: thinking - `signature: string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript) for details. - `thinking: string` The text of Claude's thinking process for this block. - `interface RedactedThinkingBlock` - `type: "redacted_thinking"` default: redacted_thinking - `data: string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=typescript#redacted-thinking-blocks) for details. - `interface ToolUseBlock` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `type: "direct"` - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ServerToolCaller20260120` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: Record` - `name: string` minLength: 1 - `toolset_name?: string | null` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `interface ServerToolUseBlock` - `type: "server_tool_use"` default: server_tool_use - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `input: Record` - `name: "web_search" | "web_fetch" | "code_execution" | 4 more` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `interface WebSearchToolResultBlock` - `type: "web_search_tool_result"` default: web_search_tool_result - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `content: WebSearchToolResultBlockContent` - `interface WebSearchToolResultError` - `type: "web_search_tool_result_error"` default: web_search_tool_result_error - `error_code: WebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `Array` - `type: "web_search_result"` default: web_search_result - `encrypted_content: string` - `page_age: string | null` - `title: string` - `url: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface WebFetchToolResultBlock` - `type: "web_fetch_tool_result"` default: web_fetch_tool_result - `caller: DirectCaller | ServerToolCaller | ServerToolCaller20260120` default: {"type":"direct"} - `interface DirectCaller` Tool invocation directly from the model. - `interface ServerToolCaller` Tool invocation generated by a server-side tool. - `interface ServerToolCaller20260120` - `content: WebFetchToolResultErrorBlock | WebFetchBlock` - `interface WebFetchToolResultErrorBlock` - `type: "web_fetch_tool_result_error"` default: web_fetch_tool_result_error - `error_code: WebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `interface WebFetchBlock` - `type: "web_fetch_result"` default: web_fetch_result - `content: DocumentBlock` - `type: "document"` default: document - `citations: CitationsConfig | null` Citation configuration for the document - `enabled: boolean` default: false - `source: Base64PDFSource | PlainTextSource` - `interface Base64PDFSource` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `interface PlainTextSource` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `title: string | null` The title of the document - `retrieved_at: string | null` ISO 8601 timestamp when the content was retrieved - `url: string` Fetched content URL - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface CodeExecutionToolResultBlock` - `type: "code_execution_tool_result"` default: code_execution_tool_result - `content: CodeExecutionToolResultBlockContent` - `interface CodeExecutionToolResultError` - `type: "code_execution_tool_result_error"` default: code_execution_tool_result_error - `error_code: CodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `interface CodeExecutionResultBlock` - `type: "code_execution_result"` default: code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `interface EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` default: encrypted_code_execution_result - `content: Array` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface BashCodeExecutionToolResultBlock` - `type: "bash_code_execution_tool_result"` default: bash_code_execution_tool_result - `content: BashCodeExecutionToolResultError | BashCodeExecutionResultBlock` - `interface BashCodeExecutionToolResultError` - `type: "bash_code_execution_tool_result_error"` default: bash_code_execution_tool_result_error - `error_code: BashCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `interface BashCodeExecutionResultBlock` - `type: "bash_code_execution_result"` default: bash_code_execution_result - `content: Array` - `type: "bash_code_execution_output"` default: bash_code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface TextEditorCodeExecutionToolResultBlock` - `type: "text_editor_code_execution_tool_result"` default: text_editor_code_execution_tool_result - `content: TextEditorCodeExecutionToolResultError | TextEditorCodeExecutionViewResultBlock | TextEditorCodeExecutionCreateResultBlock | TextEditorCodeExecutionStrReplaceResultBlock` - `interface TextEditorCodeExecutionToolResultError` - `type: "text_editor_code_execution_tool_result_error"` default: text_editor_code_execution_tool_result_error - `error_code: TextEditorCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message: string | null` - `interface TextEditorCodeExecutionViewResultBlock` - `type: "text_editor_code_execution_view_result"` default: text_editor_code_execution_view_result - `content: string` - `file_type: "text" | "image" | "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number | null` - `start_line: number | null` - `total_lines: number | null` - `interface TextEditorCodeExecutionCreateResultBlock` - `type: "text_editor_code_execution_create_result"` default: text_editor_code_execution_create_result - `is_file_update: boolean` - `interface TextEditorCodeExecutionStrReplaceResultBlock` - `type: "text_editor_code_execution_str_replace_result"` default: text_editor_code_execution_str_replace_result - `lines: Array | null` - `new_lines: number | null` - `new_start: number | null` - `old_lines: number | null` - `old_start: number | null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ToolSearchToolResultBlock` - `type: "tool_search_tool_result"` default: tool_search_tool_result - `content: ToolSearchToolResultError | ToolSearchToolSearchResultBlock` - `interface ToolSearchToolResultError` - `type: "tool_search_tool_result_error"` default: tool_search_tool_result_error - `error_code: ToolSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message: string | null` - `interface ToolSearchToolSearchResultBlock` - `type: "tool_search_tool_search_result"` default: tool_search_tool_search_result - `tool_references: Array` - `type: "tool_reference"` default: tool_reference - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `interface ContainerUploadBlock` Response model for a file uploaded to the container. - `type: "container_upload"` default: container_upload - `file_id: string` - `diagnostics: Diagnostics | null` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `cache_miss_reason: CacheMissReason | null` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `interface CacheMissModelChanged` - `type: "model_changed"` default: model_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissSystemChanged` - `type: "system_changed"` default: system_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissToolsChanged` - `type: "tools_changed"` default: tools_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissMessagesChanged` - `type: "messages_changed"` default: messages_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `interface CacheMissPreviousMessageNotFound` - `type: "previous_message_not_found"` default: previous_message_not_found - `interface CacheMissUnavailable` - `type: "unavailable"` default: unavailable - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-mythos-5"` Most capable model for cybersecurity and biology research - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `(string & {})` - `role: "assistant"` Conversational role of the generated message. This will always be `"assistant"`. default: assistant - `stop_details: RefusalStopDetails | null` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `type: "refusal"` default: refusal - `category: "cyber" | "bio" | "frontier_llm" | 2 more | null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `"bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `"frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `"reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=typescript). - `"general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `explanation: string | null` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `stop_reason: StopReason | null` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"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. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations * `"model_context_window_exceeded"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string | null` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `usage: Usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under 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. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `cache_creation: CacheCreation | null` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `cache_creation_input_tokens: number | null` The number of input tokens used to create the cache entry. minimum: 0 - `cache_read_input_tokens: number | null` The number of input tokens read from the cache. minimum: 0 - `inference_geo: string | null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. minimum: 0 - `output_tokens: number` The number of output tokens which were used. minimum: 0 - `output_tokens_details: OutputTokensDetails | null` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `thinking_tokens: number` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. default: 0, minimum: 0 - `server_tool_use: ServerToolUsage | null` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. default: 0, minimum: 0 - `web_search_requests: number` The number of web search tool requests. default: 0, minimum: 0 - `service_tier: "standard" | "priority" | "batch" | null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `interface MessageBatchErroredResult` - `type: "errored"` default: errored - `error: ErrorResponse` - `type: "error"` default: error - `error: ErrorObject` - `interface InvalidRequestError` - `type: "invalid_request_error"` default: invalid_request_error - `message: string` default: Invalid request - `interface AuthenticationError` - `type: "authentication_error"` default: authentication_error - `message: string` default: Authentication error - `interface BillingError` - `type: "billing_error"` default: billing_error - `message: string` default: Billing error - `interface PermissionError` - `type: "permission_error"` default: permission_error - `message: string` default: Permission denied - `interface NotFoundError` - `type: "not_found_error"` default: not_found_error - `message: string` default: Not found - `interface RateLimitError` - `type: "rate_limit_error"` default: rate_limit_error - `message: string` default: Rate limited - `interface GatewayTimeoutError` - `type: "timeout_error"` default: timeout_error - `message: string` default: Request timeout - `interface APIErrorObject` - `type: "api_error"` default: api_error - `message: string` default: Internal server error - `interface OverloadedError` - `type: "overloaded_error"` default: overloaded_error - `message: string` default: Overloaded - `request_id: string | null` - `interface MessageBatchCanceledResult` - `type: "canceled"` default: canceled - `interface MessageBatchExpiredResult` - `type: "expired"` default: expired #### Example ```typescript import Anthropic from "@anthropic-ai/sdk"; const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); const messageBatchIndividualResponse = await client.messages.batches.results( "message_batch_id" ); console.log(messageBatchIndividualResponse.custom_id); ```