Repository Public
1---2title: Messages3url: https://platform.claude.com/docs/en/api/messages4---56# Messages78## Create a Message910**POST** `/v1/messages`1112Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation.1314The Messages API can be used for either single queries or stateless multi-turn conversations.1516Learn more about the Messages API in our [user guide](https://platform.claude.com/docs/en/get-started)1718### Headers1920- `"anthropic-user-profile-id": optional string`2122 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.2324- `"anthropic-workspace-id": optional string`2526### Body parameters2728- `max_tokens: number`2930 The maximum number of tokens to generate before stopping.3132 Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.3334 Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#pre-warming-the-cache) without generating a response.3536 Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview) for details.3738 minimum: 03940- `messages: array of MessageParam`4142 Input messages.4344 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.4546 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.4748 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.4950 Example with a single `user` message:5152 ```json53 [{"role": "user", "content": "Hello, Claude"}]54 ```5556 Example with multiple conversational turns:5758 ```json59 [60 {"role": "user", "content": "Hello there."},61 {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"},62 {"role": "user", "content": "Can you explain LLMs in plain English?"},63 ]64 ```6566 Example with a partially-filled response from Claude:6768 ```json69 [70 {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},71 {"role": "assistant", "content": "The best answer is ("},72 ]73 ```7475 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:7677 ```json78 {"role": "user", "content": "Hello, Claude"}79 ```8081 ```json82 {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]}83 ```8485 See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages).8687 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#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API.8889 There is a limit of 100,000 messages in a single request.9091 - `content: string or array of ContentBlockParam`9293 - `string`9495 - `array of ContentBlockParam`9697 - `TextBlockParam object`9899 - `type: "text"`100101 - `text: string`102103 minLength: 1104105 - `cache_control: optional CacheControlEphemeral or null`106107 Create a cache control breakpoint at this content block.108109 - `type: "ephemeral"`110111 - `ttl: optional "5m" or "1h"`112113 The time-to-live for the cache control breakpoint.114115 This may be one the following values:116117 - `5m`: 5 minutes118 - `1h`: 1 hour119120 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.121122 - `"5m"`123124 - `"1h"`125126 - `citations: optional array of TextCitationParam or null`127128 - `CitationCharLocationParam object`129130 - `type: "char_location"`131132 - `cited_text: string`133134 - `document_index: number`135136 minimum: 0137138 - `document_title: string or null`139140 maxLength: 500, minLength: 1141142 - `end_char_index: number`143144 - `start_char_index: number`145146 minimum: 0147148 - `CitationPageLocationParam object`149150 - `type: "page_location"`151152 - `cited_text: string`153154 - `document_index: number`155156 minimum: 0157158 - `document_title: string or null`159160 maxLength: 500, minLength: 1161162 - `end_page_number: number`163164 - `start_page_number: number`165166 minimum: 1167168 - `CitationContentBlockLocationParam object`169170 - `type: "content_block_location"`171172 - `cited_text: string`173174 The full text of the cited block range, concatenated.175176 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.177178 - `document_index: number`179180 minimum: 0181182 - `document_title: string or null`183184 maxLength: 500, minLength: 1185186 - `end_block_index: number`187188 Exclusive 0-based end index of the cited block range in the source's `content` array.189190 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.191192 - `start_block_index: number`193194 0-based index of the first cited block in the source's `content` array.195196 minimum: 0197198 - `CitationWebSearchResultLocationParam object`199200 - `type: "web_search_result_location"`201202 - `cited_text: string`203204 - `encrypted_index: string`205206 - `title: string or null`207208 maxLength: 512, minLength: 1209210 - `url: string`211212 minLength: 1213214 - `CitationSearchResultLocationParam object`215216 - `type: "search_result_location"`217218 - `cited_text: string`219220 The full text of the cited block range, concatenated.221222 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.223224 - `end_block_index: number`225226 Exclusive 0-based end index of the cited block range in the source's `content` array.227228 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.229230 - `search_result_index: number`231232 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.233234 Counted separately from `document_index`; server-side web search results are not included in this count.235236 minimum: 0237238 - `source: string`239240 - `start_block_index: number`241242 0-based index of the first cited block in the source's `content` array.243244 minimum: 0245246 - `title: string or null`247248 - `ImageBlockParam object`249250 - `type: "image"`251252 - `source: Base64ImageSource or URLImageSource or FileImageSource`253254 - `Base64ImageSource object`255256 - `type: "base64"`257258 - `data: string`259260 format: byte261262 - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"`263264 - `"image/jpeg"`265266 - `"image/png"`267268 - `"image/gif"`269270 - `"image/webp"`271272 - `URLImageSource object`273274 - `type: "url"`275276 - `url: string`277278 - `FileImageSource object`279280 - `type: "file"`281282 - `file_id: string`283284 - `cache_control: optional CacheControlEphemeral or null`285286 Create a cache control breakpoint at this content block.287288 - `transformations: optional ImageTransformationsParam or null`289290 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.291292 - `oversized_image: optional "downsize" or "error"`293294 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.295296 - `"downsize"`297298 - `"error"`299300 - `DocumentBlockParam object`301302 - `type: "document"`303304 - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more`305306 - `Base64PDFSource object`307308 - `type: "base64"`309310 - `data: string`311312 format: byte313314 - `media_type: "application/pdf"`315316 - `PlainTextSource object`317318 - `type: "text"`319320 - `data: string`321322 - `media_type: "text/plain"`323324 - `ContentBlockSource object`325326 - `type: "content"`327328 - `content: string or array of ContentBlockSourceContent`329330 - `string`331332 - `ContentBlockSourceContent = array of ContentBlockSourceContent`333334 - `TextBlockParam object`335336 - `ImageBlockParam object`337338 - `URLPDFSource object`339340 - `type: "url"`341342 - `url: string`343344 - `FileDocumentSource object`345346 - `type: "file"`347348 - `file_id: string`349350 - `cache_control: optional CacheControlEphemeral or null`351352 Create a cache control breakpoint at this content block.353354 - `citations: optional CitationsConfigParam or null`355356 - `enabled: optional boolean`357358 - `context: optional string or null`359360 minLength: 1361362 - `title: optional string or null`363364 maxLength: 500, minLength: 1365366 - `SearchResultBlockParam object`367368 - `type: "search_result"`369370 - `content: array of TextBlockParam`371372 - `type: "text"`373374 - `text: string`375376 minLength: 1377378 - `cache_control: optional CacheControlEphemeral or null`379380 Create a cache control breakpoint at this content block.381382 - `citations: optional array of TextCitationParam or null`383384 - `source: string`385386 - `title: string`387388 - `cache_control: optional CacheControlEphemeral or null`389390 Create a cache control breakpoint at this content block.391392 - `citations: optional CitationsConfigParam`393394 - `ThinkingBlockParam object`395396 - `type: "thinking"`397398 - `signature: string`399400 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.401402 Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`.403404 - `thinking: string`405406 The `thinking` text of this block as returned by the API.407408 - `RedactedThinkingBlockParam object`409410 - `type: "redacted_thinking"`411412 - `data: string`413414 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.415416 - `ToolUseBlockParam object`417418 - `type: "tool_use"`419420 - `id: string`421422 pattern: ^[a-zA-Z0-9_-]+$423424 - `input: map[unknown]`425426 - `name: string`427428 maxLength: 200, minLength: 1429430 - `cache_control: optional CacheControlEphemeral or null`431432 Create a cache control breakpoint at this content block.433434 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`435436 - `DirectCaller object`437438 Tool invocation directly from the model.439440 - `type: "direct"`441442 - `ServerToolCaller object`443444 Tool invocation generated by a server-side tool.445446 - `type: "code_execution_20250825"`447448 - `tool_id: string`449450 pattern: ^srvtoolu_[a-zA-Z0-9_]+$451452 - `ServerToolCaller20260120 object`453454 - `type: "code_execution_20260120"`455456 - `tool_id: string`457458 pattern: ^srvtoolu_[a-zA-Z0-9_]+$459460 - `toolset_name: optional string or null`461462 For a toolset member tool_use, the toolset family this member belongs to.463464 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$465466 - `ToolResultBlockParam object`467468 - `type: "tool_result"`469470 - `tool_use_id: string`471472 pattern: ^[a-zA-Z0-9_-]+$473474 - `cache_control: optional CacheControlEphemeral or null`475476 Create a cache control breakpoint at this content block.477478 - `content: optional string or array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 3 more`479480 - `string`481482 - `array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 3 more`483484 - `TextBlockParam object`485486 - `ImageBlockParam object`487488 - `SearchResultBlockParam object`489490 - `DocumentBlockParam object`491492 - `ToolReferenceBlockParam object`493494 Tool reference block that can be included in tool_result content.495496 - `type: "tool_reference"`497498 - `tool_name: string`499500 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$501502 - `cache_control: optional CacheControlEphemeral or null`503504 Create a cache control breakpoint at this content block.505506 - `BrowserStateBlockParam object`507508 The caller's browser state after a browser toolset member call —509 the full inventory of open tabs, which tab is active, and any side510 effects (tabs opened, download state changes) the call produced.511512 At most one per `tool_result`, only on a non-error result answering a513 browser toolset member `tool_use`. The server renders the514 model-visible text from it; the model never sees the raw fields.515516 - `type: "browser_state"`517518 - `tabs: array of BrowserStateTabEntry`519520 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`.521522 maxItems: 100523524 - `tab_id: string`525526 The caller-assigned identifier for this tab, unique within the inventory.527528 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$529530 - `title: string`531532 The title of the page the tab is showing. May be empty.533534 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$535536 - `url: string`537538 The URL of the page the tab is showing. May be empty.539540 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$541542 - `active: optional boolean`543544 Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.545546 - `cache_control: optional CacheControlEphemeral or null`547548 Create a cache control breakpoint at this content block.549550 - `state_changes: optional array of BrowserStateChange or null`551552 Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list.553554 maxItems: 200, minItems: 1555556 - `BrowserStateChangeTabOpened object`557558 A tab this call's execution opened that remains open at its end —559 the creation delta of the `tabs` inventory, not an event log.560561 Carries only the `tab_id`; the tab's `title` and `url` live on its562 `tabs` entry, which must include the same `tab_id`. A tab opened563 during a failed call gets no deferred `tab_opened`; it simply appears564 in the next result's `tabs` inventory.565566 - `type: "tab_opened"`567568 - `tab_id: string`569570 The `tab_id` of the opened tab, present in `tabs`.571572 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$573574 - `BrowserStateChangeDownloadStarted object`575576 A file download that started during this call.577578 - `type: "download_started"`579580 - `download_id: string`581582 The caller-assigned identifier for this download, stable across the state changes reporting it.583584 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$585586 - `url: string`587588 The final post-redirect URL the download was served from.589590 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$591592 - `BrowserStateChangeDownloadCompleted object`593594 A file download that finished during this call, reported with the595 same `download_id` as its `download_started` — or without a prior596 `download_started`, when the download finished during the call that597 started it (at most one state change per `download_id` per result).598599 - `type: "download_completed"`600601 - `download_id: string`602603 The caller-assigned identifier for this download, stable across the state changes reporting it.604605 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$606607 - `url: string`608609 The final post-redirect URL the download was served from.610611 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$612613 - `path: optional string or null`614615 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.616617 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 4096618619 - `size_bytes: optional number or null`620621 The completed download's size.622623 minimum: 0624625 - `BrowserStateChangeDownloadFailed object`626627 A file download that failed — or was cancelled — during this call.628629 - `type: "download_failed"`630631 - `download_id: string`632633 The caller-assigned identifier for this download, stable across the state changes reporting it.634635 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$636637 - `url: string`638639 The final post-redirect URL the download was served from.640641 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$642643 - `error: optional string or null`644645 The failure or cancellation detail, when known.646647 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 4096648649 - `is_error: optional boolean`650651 - `toolset_name: optional string or null`652653 For a toolset member tool_result, the toolset family of the paired tool_use.654655 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$656657 - `ServerToolUseBlockParam object`658659 - `type: "server_tool_use"`660661 - `id: string`662663 pattern: ^srvtoolu_[a-zA-Z0-9_]+$664665 - `input: map[unknown]`666667 - `name: "web_search" or "web_fetch" or "code_execution" or 4 more`668669 - `"web_search"`670671 - `"web_fetch"`672673 - `"code_execution"`674675 - `"bash_code_execution"`676677 - `"text_editor_code_execution"`678679 - `"tool_search_tool_regex"`680681 - `"tool_search_tool_bm25"`682683 - `cache_control: optional CacheControlEphemeral or null`684685 Create a cache control breakpoint at this content block.686687 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`688689 - `DirectCaller object`690691 Tool invocation directly from the model.692693 - `ServerToolCaller object`694695 Tool invocation generated by a server-side tool.696697 - `ServerToolCaller20260120 object`698699 - `WebSearchToolResultBlockParam object`700701 - `type: "web_search_tool_result"`702703 - `content: WebSearchToolResultBlockParamContent`704705 - `WebSearchToolResultBlockItem = array of WebSearchResultBlockParam`706707 - `type: "web_search_result"`708709 - `encrypted_content: string`710711 - `title: string`712713 - `url: string`714715 - `page_age: optional string or null`716717 - `WebSearchToolRequestError object`718719 - `type: "web_search_tool_result_error"`720721 - `error_code: WebSearchToolResultErrorCode`722723 - `"invalid_tool_input"`724725 - `"unavailable"`726727 - `"max_uses_exceeded"`728729 - `"too_many_requests"`730731 - `"query_too_long"`732733 - `"request_too_large"`734735 - `tool_use_id: string`736737 pattern: ^srvtoolu_[a-zA-Z0-9_]+$738739 - `cache_control: optional CacheControlEphemeral or null`740741 Create a cache control breakpoint at this content block.742743 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`744745 - `DirectCaller object`746747 Tool invocation directly from the model.748749 - `ServerToolCaller object`750751 Tool invocation generated by a server-side tool.752753 - `ServerToolCaller20260120 object`754755 - `WebFetchToolResultBlockParam object`756757 - `type: "web_fetch_tool_result"`758759 - `content: WebFetchToolResultErrorBlockParam or WebFetchBlockParam`760761 - `WebFetchToolResultErrorBlockParam object`762763 - `type: "web_fetch_tool_result_error"`764765 - `error_code: WebFetchToolResultErrorCode`766767 - `"invalid_tool_input"`768769 - `"url_too_long"`770771 - `"url_not_allowed"`772773 - `"url_not_in_prior_context"`774775 - `"url_not_accessible"`776777 - `"unsupported_content_type"`778779 - `"too_many_requests"`780781 - `"max_uses_exceeded"`782783 - `"unavailable"`784785 - `"content_too_large"`786787 - `WebFetchBlockParam object`788789 - `type: "web_fetch_result"`790791 - `content: DocumentBlockParam`792793 - `url: string`794795 Fetched content URL796797 - `retrieved_at: optional string or null`798799 ISO 8601 timestamp when the content was retrieved800801 - `tool_use_id: string`802803 pattern: ^srvtoolu_[a-zA-Z0-9_]+$804805 - `cache_control: optional CacheControlEphemeral or null`806807 Create a cache control breakpoint at this content block.808809 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`810811 - `DirectCaller object`812813 Tool invocation directly from the model.814815 - `ServerToolCaller object`816817 Tool invocation generated by a server-side tool.818819 - `ServerToolCaller20260120 object`820821 - `CodeExecutionToolResultBlockParam object`822823 - `type: "code_execution_tool_result"`824825 - `content: CodeExecutionToolResultBlockParamContent`826827 - `CodeExecutionToolResultErrorParam object`828829 - `type: "code_execution_tool_result_error"`830831 - `error_code: CodeExecutionToolResultErrorCode`832833 - `"invalid_tool_input"`834835 - `"unavailable"`836837 - `"too_many_requests"`838839 - `"execution_time_exceeded"`840841 - `CodeExecutionResultBlockParam object`842843 - `type: "code_execution_result"`844845 - `content: array of CodeExecutionOutputBlockParam`846847 - `type: "code_execution_output"`848849 - `file_id: string`850851 - `return_code: number`852853 - `stderr: string`854855 - `stdout: string`856857 - `EncryptedCodeExecutionResultBlockParam object`858859 Code execution result with encrypted stdout for PFC + web_search results.860861 - `type: "encrypted_code_execution_result"`862863 - `content: array of CodeExecutionOutputBlockParam`864865 - `type: "code_execution_output"`866867 - `file_id: string`868869 - `encrypted_stdout: string`870871 - `return_code: number`872873 - `stderr: string`874875 - `tool_use_id: string`876877 pattern: ^srvtoolu_[a-zA-Z0-9_]+$878879 - `cache_control: optional CacheControlEphemeral or null`880881 Create a cache control breakpoint at this content block.882883 - `BashCodeExecutionToolResultBlockParam object`884885 - `type: "bash_code_execution_tool_result"`886887 - `content: BashCodeExecutionToolResultErrorParam or BashCodeExecutionResultBlockParam`888889 - `BashCodeExecutionToolResultErrorParam object`890891 - `type: "bash_code_execution_tool_result_error"`892893 - `error_code: BashCodeExecutionToolResultErrorCode`894895 - `"invalid_tool_input"`896897 - `"unavailable"`898899 - `"too_many_requests"`900901 - `"execution_time_exceeded"`902903 - `"output_file_too_large"`904905 - `BashCodeExecutionResultBlockParam object`906907 - `type: "bash_code_execution_result"`908909 - `content: array of BashCodeExecutionOutputBlockParam`910911 - `type: "bash_code_execution_output"`912913 - `file_id: string`914915 - `return_code: number`916917 - `stderr: string`918919 - `stdout: string`920921 - `tool_use_id: string`922923 pattern: ^srvtoolu_[a-zA-Z0-9_]+$924925 - `cache_control: optional CacheControlEphemeral or null`926927 Create a cache control breakpoint at this content block.928929 - `TextEditorCodeExecutionToolResultBlockParam object`930931 - `type: "text_editor_code_execution_tool_result"`932933 - `content: TextEditorCodeExecutionToolResultErrorParam or TextEditorCodeExecutionViewResultBlockParam or TextEditorCodeExecutionCreateResultBlockParam or TextEditorCodeExecutionStrReplaceResultBlockParam`934935 - `TextEditorCodeExecutionToolResultErrorParam object`936937 - `type: "text_editor_code_execution_tool_result_error"`938939 - `error_code: TextEditorCodeExecutionToolResultErrorCode`940941 - `"invalid_tool_input"`942943 - `"unavailable"`944945 - `"too_many_requests"`946947 - `"execution_time_exceeded"`948949 - `"file_not_found"`950951 - `error_message: optional string or null`952953 - `TextEditorCodeExecutionViewResultBlockParam object`954955 - `type: "text_editor_code_execution_view_result"`956957 - `content: string`958959 - `file_type: "text" or "image" or "pdf"`960961 - `"text"`962963 - `"image"`964965 - `"pdf"`966967 - `num_lines: optional number or null`968969 - `start_line: optional number or null`970971 - `total_lines: optional number or null`972973 - `TextEditorCodeExecutionCreateResultBlockParam object`974975 - `type: "text_editor_code_execution_create_result"`976977 - `is_file_update: boolean`978979 - `TextEditorCodeExecutionStrReplaceResultBlockParam object`980981 - `type: "text_editor_code_execution_str_replace_result"`982983 - `lines: optional array of string or null`984985 - `new_lines: optional number or null`986987 - `new_start: optional number or null`988989 - `old_lines: optional number or null`990991 - `old_start: optional number or null`992993 - `tool_use_id: string`994995 pattern: ^srvtoolu_[a-zA-Z0-9_]+$996997 - `cache_control: optional CacheControlEphemeral or null`998999 Create a cache control breakpoint at this content block.10001001 - `ToolSearchToolResultBlockParam object`10021003 - `type: "tool_search_tool_result"`10041005 - `content: ToolSearchToolResultErrorParam or ToolSearchToolSearchResultBlockParam`10061007 - `ToolSearchToolResultErrorParam object`10081009 - `type: "tool_search_tool_result_error"`10101011 - `error_code: ToolSearchToolResultErrorCode`10121013 - `"invalid_tool_input"`10141015 - `"unavailable"`10161017 - `"too_many_requests"`10181019 - `"execution_time_exceeded"`10201021 - `error_message: optional string or null`10221023 - `ToolSearchToolSearchResultBlockParam object`10241025 - `type: "tool_search_tool_search_result"`10261027 - `tool_references: array of ToolReferenceBlockParam`10281029 - `type: "tool_reference"`10301031 - `tool_name: string`10321033 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$10341035 - `cache_control: optional CacheControlEphemeral or null`10361037 Create a cache control breakpoint at this content block.10381039 - `tool_use_id: string`10401041 pattern: ^srvtoolu_[a-zA-Z0-9_]+$10421043 - `cache_control: optional CacheControlEphemeral or null`10441045 Create a cache control breakpoint at this content block.10461047 - `ContainerUploadBlockParam object`10481049 A content block that represents a file to be uploaded to the container1050 Files uploaded via this block will be available in the container's input directory.10511052 - `type: "container_upload"`10531054 - `file_id: string`10551056 - `cache_control: optional CacheControlEphemeral or null`10571058 Create a cache control breakpoint at this content block.10591060 - `role: "user" or "assistant" or "system"`10611062 - `"user"`10631064 - `"assistant"`10651066 - `"system"`10671068- `model: Model`10691070 The model that will complete your prompt.10711072 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.10731074 - `"claude-fable-5-1" or "claude-mythos-5-1" or "claude-sonnet-5" or 14 more`10751076 The model that will complete your prompt.10771078 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.10791080 - `"claude-fable-5-1"`10811082 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows10831084 - `"claude-mythos-5-1"`10851086 Our most capable model for cybersecurity and biology research, available through trusted access programs10871088 - `"claude-sonnet-5"`10891090 High-performance model for coding and agents10911092 - `"claude-fable-5"`10931094 Next generation of intelligence for the hardest knowledge work and coding problems10951096 - `"claude-mythos-5"`10971098 Most capable model for cybersecurity and biology research10991100 - `"claude-opus-5"`11011102 Powerful intelligence for long-running agents and coding11031104 - `"claude-opus-4-8"`11051106 Powerful intelligence for long-running agents and coding11071108 - `"claude-opus-4-7"`11091110 Powerful intelligence for long-running agents and coding11111112 - `"claude-mythos-preview"`11131114 New class of intelligence, strongest in coding and cybersecurity11151116 - `"claude-opus-4-6"`11171118 Powerful intelligence for long-running agents and coding11191120 - `"claude-sonnet-4-6"`11211122 Best combination of speed and intelligence11231124 - `"claude-haiku-4-5"`11251126 Fastest model with near-frontier intelligence11271128 - `"claude-haiku-4-5-20251001"`11291130 Fastest model with near-frontier intelligence11311132 - `"claude-opus-4-5"`11331134 Powerful intelligence for long-running agents and coding11351136 - `"claude-opus-4-5-20251101"`11371138 Powerful intelligence for long-running agents and coding11391140 - `"claude-sonnet-4-5"`11411142 High-performance model for agents and coding11431144 - `"claude-sonnet-4-5-20250929"`11451146 High-performance model for agents and coding11471148 - `string`11491150- `cache_control: optional CacheControlEphemeral or null`11511152 Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.11531154- `container: optional MessageCreateParamsContainer or null`11551156 Container identifier for reuse across requests.11571158 - `ContainerParams object`11591160 Container parameters with skills to be loaded.11611162 - `id: optional string or null`11631164 Container id11651166 - `skills: optional array of SkillParams or null`11671168 List of skills to load in the container11691170 maxItems: 2011711172 - `type: "anthropic" or "custom"`11731174 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)11751176 - `"anthropic"`11771178 - `"custom"`11791180 - `skill_id: string`11811182 Skill ID11831184 maxLength: 64, minLength: 111851186 - `version: optional string`11871188 Skill version or 'latest' for most recent version11891190 maxLength: 64, minLength: 111911192 - `string`11931194- `inference_geo: optional string or null`11951196 Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used.11971198- `metadata: optional Metadata`11991200 An object describing metadata about the request.12011202 - `user_id: optional string or null`12031204 An external identifier for the user who is associated with the request.12051206 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.12071208 maxLength: 51212091210- `output_config: optional OutputConfig`12111212 Configuration options for the model's output, such as the output format.12131214 - `effort: optional "low" or "medium" or "high" or 2 more or null`12151216 All possible effort levels.12171218 - `"low"`12191220 - `"medium"`12211222 - `"high"`12231224 - `"xhigh"`12251226 - `"max"`12271228 - `format: optional JSONOutputFormat or null`12291230 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)12311232 - `type: "json_schema"`12331234 - `schema: map[unknown]`12351236 The JSON schema of the format12371238- `service_tier: optional "auto" or "standard_only"`12391240 Determines whether to use priority capacity (if available) or standard capacity for this request.12411242 Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers) for details.12431244 - `"auto"`12451246 - `"standard_only"`12471248- `stop_sequences: optional array of string`12491250 Custom text sequences that will cause the model to stop generating.12511252 Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`.12531254 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.12551256- `stream: optional boolean`12571258 Whether to incrementally stream the response using server-sent events.12591260 See [streaming](https://platform.claude.com/docs/en/build-with-claude/streaming) for details.12611262- `system: optional string or array of TextBlockParam`12631264 System prompt.12651266 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#give-claude-a-role).12671268 - `string`12691270 - `array of TextBlockParam`12711272 - `type: "text"`12731274 - `text: string`12751276 minLength: 112771278 - `cache_control: optional CacheControlEphemeral or null`12791280 Create a cache control breakpoint at this content block.12811282 - `citations: optional array of TextCitationParam or null`12831284- `thinking: optional ThinkingConfigParam`12851286 Configuration for enabling Claude's extended thinking.12871288 When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit.12891290 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.12911292 - `ThinkingConfigEnabled object`12931294 - `type: "enabled"`12951296 - `budget_tokens: number`12971298 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.12991300 Must be ≥1024 and less than `max_tokens`.13011302 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.13031304 minimum: 102413051306 - `display: optional "summarized" or "omitted" or null`13071308 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`.13091310 - `"summarized"`13111312 - `"omitted"`13131314 - `ThinkingConfigDisabled object`13151316 - `type: "disabled"`13171318 - `ThinkingConfigAdaptive object`13191320 - `type: "adaptive"`13211322 - `display: optional "summarized" or "omitted" or null`13231324 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`.13251326 - `"summarized"`13271328 - `"omitted"`13291330- `tool_choice: optional ToolChoice`13311332 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.13331334 - `ToolChoiceAuto object`13351336 The model will automatically decide whether to use tools.13371338 - `type: "auto"`13391340 - `disable_parallel_tool_use: optional boolean`13411342 Whether to disable parallel tool use.13431344 Defaults to `false`. If set to `true`, the model will output at most one tool use.13451346 - `ToolChoiceAny object`13471348 The model will use any available tools.13491350 - `type: "any"`13511352 - `disable_parallel_tool_use: optional boolean`13531354 Whether to disable parallel tool use.13551356 Defaults to `false`. If set to `true`, the model will output exactly one tool use.13571358 - `ToolChoiceTool object`13591360 The model will use the specified tool with `tool_choice.name`.13611362 - `type: "tool"`13631364 - `name: string`13651366 The name of the tool to use.13671368 - `disable_parallel_tool_use: optional boolean`13691370 Whether to disable parallel tool use.13711372 Defaults to `false`. If set to `true`, the model will output exactly one tool use.13731374 - `ToolChoiceNone object`13751376 The model will not be allowed to use tools.13771378 - `type: "none"`13791380- `tools: optional array of ToolUnion`13811382 Definitions of tools that the model may use.13831384 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.13851386 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), 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)).13871388 Each tool definition includes:13891390 * `name`: Name of the tool.1391 * `description`: Optional, but strongly-recommended description of the tool.1392 * `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.13931394 For example, if you defined `tools` as:13951396 ```json1397 [1398 {1399 "name": "get_stock_price",1400 "description": "Get the current stock price for a given ticker symbol.",1401 "input_schema": {1402 "type": "object",1403 "properties": {1404 "ticker": {1405 "type": "string",1406 "description": "The stock ticker symbol, e.g. AAPL for Apple Inc."1407 }1408 },1409 "required": ["ticker"]1410 }1411 }1412 ]1413 ```14141415 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:14161417 ```json1418 [1419 {1420 "type": "tool_use",1421 "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",1422 "name": "get_stock_price",1423 "input": { "ticker": "^GSPC" }1424 }1425 ]1426 ```14271428 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:14291430 ```json1431 [1432 {1433 "type": "tool_result",1434 "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",1435 "content": "259.75 USD"1436 }1437 ]1438 ```14391440 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.14411442 See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details.14431444 - `Tool object`14451446 - `type: optional "custom" or null`14471448 - `input_schema: object`14491450 [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.14511452 This defines the shape of the `input` that your tool accepts and that the model will produce.14531454 - `type: "object"`14551456 - `properties: optional map[unknown] or null`14571458 - `required: optional array of string or null`14591460 - `name: string`14611462 Name of the tool.14631464 This is how the tool will be called by the model and in `tool_use` blocks.14651466 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$14671468 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`14691470 - `"direct"`14711472 - `"code_execution_20250825"`14731474 - `"code_execution_20260120"`14751476 - `"code_execution_20260521"`14771478 - `cache_control: optional CacheControlEphemeral or null`14791480 Create a cache control breakpoint at this content block.14811482 - `defer_loading: optional boolean`14831484 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.14851486 - `description: optional string`14871488 Description of what this tool does.14891490 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.14911492 - `eager_input_streaming: optional boolean or null`14931494 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.14951496 - `input_examples: optional array of map[unknown]`14971498 - `strict: optional boolean`14991500 When true, guarantees schema validation on tool names and inputs15011502 - `ToolBash20250124 object`15031504 - `type: "bash_20250124"`15051506 - `name: "bash"`15071508 Name of the tool.15091510 This is how the tool will be called by the model and in `tool_use` blocks.15111512 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`15131514 - `"direct"`15151516 - `"code_execution_20250825"`15171518 - `"code_execution_20260120"`15191520 - `"code_execution_20260521"`15211522 - `cache_control: optional CacheControlEphemeral or null`15231524 Create a cache control breakpoint at this content block.15251526 - `defer_loading: optional boolean`15271528 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.15291530 - `input_examples: optional array of map[unknown]`15311532 - `strict: optional boolean`15331534 When true, guarantees schema validation on tool names and inputs15351536 - `CodeExecutionTool20250522 object`15371538 - `type: "code_execution_20250522"`15391540 - `name: "code_execution"`15411542 Name of the tool.15431544 This is how the tool will be called by the model and in `tool_use` blocks.15451546 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`15471548 - `"direct"`15491550 - `"code_execution_20250825"`15511552 - `"code_execution_20260120"`15531554 - `"code_execution_20260521"`15551556 - `cache_control: optional CacheControlEphemeral or null`15571558 Create a cache control breakpoint at this content block.15591560 - `defer_loading: optional boolean`15611562 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.15631564 - `strict: optional boolean`15651566 When true, guarantees schema validation on tool names and inputs15671568 - `CodeExecutionTool20250825 object`15691570 - `type: "code_execution_20250825"`15711572 - `name: "code_execution"`15731574 Name of the tool.15751576 This is how the tool will be called by the model and in `tool_use` blocks.15771578 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`15791580 - `"direct"`15811582 - `"code_execution_20250825"`15831584 - `"code_execution_20260120"`15851586 - `"code_execution_20260521"`15871588 - `cache_control: optional CacheControlEphemeral or null`15891590 Create a cache control breakpoint at this content block.15911592 - `defer_loading: optional boolean`15931594 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.15951596 - `strict: optional boolean`15971598 When true, guarantees schema validation on tool names and inputs15991600 - `CodeExecutionTool20260120 object`16011602 Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).16031604 - `type: "code_execution_20260120"`16051606 - `name: "code_execution"`16071608 Name of the tool.16091610 This is how the tool will be called by the model and in `tool_use` blocks.16111612 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`16131614 - `"direct"`16151616 - `"code_execution_20250825"`16171618 - `"code_execution_20260120"`16191620 - `"code_execution_20260521"`16211622 - `cache_control: optional CacheControlEphemeral or null`16231624 Create a cache control breakpoint at this content block.16251626 - `defer_loading: optional boolean`16271628 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.16291630 - `strict: optional boolean`16311632 When true, guarantees schema validation on tool names and inputs16331634 - `CodeExecutionTool20260521 object`16351636 Code execution tool with REPL state persistence.16371638 - `type: "code_execution_20260521"`16391640 - `name: "code_execution"`16411642 Name of the tool.16431644 This is how the tool will be called by the model and in `tool_use` blocks.16451646 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`16471648 - `"direct"`16491650 - `"code_execution_20250825"`16511652 - `"code_execution_20260120"`16531654 - `"code_execution_20260521"`16551656 - `cache_control: optional CacheControlEphemeral or null`16571658 Create a cache control breakpoint at this content block.16591660 - `defer_loading: optional boolean`16611662 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.16631664 - `strict: optional boolean`16651666 When true, guarantees schema validation on tool names and inputs16671668 - `BrowserToolset20260801 object`16691670 The browser toolset: a single `tools[]` entry (carrying no1671 `name`) that declares the browser tool family. The model is served1672 the family's tool with any members disabled via `configs` removed1673 from its schema.16741675 - `type: "browser_toolset_20260801"`16761677 - `cache_control: optional CacheControlEphemeral or null`16781679 Create a cache control breakpoint at this content block.16801681 - `configs: optional BrowserToolsetConfigs or null`16821683 Per-member configuration for `browser_toolset_20260801`: one1684 optional field per member tool, keyed by the member name — the same1685 name the member's `tool_use` blocks carry. Every member is an1686 accepted key, and a member's defaults apply wherever its key is1687 absent. Unknown keys are rejected: the field set is this toolset1688 version's complete member set.16891690 - `type: optional BrowserTypeConfig or null`16911692 `type`'s config overrides.16931694 - `defer_loading: optional boolean or null`16951696 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.16971698 - `enabled: optional boolean or null`16991700 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.17011702 - `close_tab: optional BrowserCloseTabConfig or null`17031704 `close_tab`'s config overrides.17051706 - `defer_loading: optional boolean or null`17071708 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.17091710 - `enabled: optional boolean or null`17111712 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.17131714 - `double_click: optional BrowserDoubleClickConfig or null`17151716 `double_click`'s config overrides.17171718 - `defer_loading: optional boolean or null`17191720 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.17211722 - `enabled: optional boolean or null`17231724 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.17251726 - `file_upload: optional BrowserFileUploadConfig or null`17271728 `file_upload`'s config overrides.17291730 - `defer_loading: optional boolean or null`17311732 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.17331734 - `enabled: optional boolean or null`17351736 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.17371738 - `find: optional BrowserFindConfig or null`17391740 `find`'s config overrides.17411742 - `defer_loading: optional boolean or null`17431744 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.17451746 - `enabled: optional boolean or null`17471748 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.17491750 - `form_input: optional BrowserFormInputConfig or null`17511752 `form_input`'s config overrides.17531754 - `defer_loading: optional boolean or null`17551756 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.17571758 - `enabled: optional boolean or null`17591760 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.17611762 - `get_page_text: optional BrowserGetPageTextConfig or null`17631764 `get_page_text`'s config overrides.17651766 - `defer_loading: optional boolean or null`17671768 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.17691770 - `enabled: optional boolean or null`17711772 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.17731774 - `hold_key: optional BrowserHoldKeyConfig or null`17751776 `hold_key`'s config overrides.17771778 - `defer_loading: optional boolean or null`17791780 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.17811782 - `enabled: optional boolean or null`17831784 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.17851786 - `hover: optional BrowserHoverConfig or null`17871788 `hover`'s config overrides.17891790 - `defer_loading: optional boolean or null`17911792 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.17931794 - `enabled: optional boolean or null`17951796 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.17971798 - `javascript_exec: optional BrowserJavascriptExecConfig or null`17991800 `javascript_exec`'s config overrides.18011802 - `defer_loading: optional boolean or null`18031804 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.18051806 - `enabled: optional boolean or null`18071808 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.18091810 - `key: optional BrowserKeyConfig or null`18111812 `key`'s config overrides.18131814 - `defer_loading: optional boolean or null`18151816 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.18171818 - `enabled: optional boolean or null`18191820 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.18211822 - `left_click: optional BrowserLeftClickConfig or null`18231824 `left_click`'s config overrides.18251826 - `defer_loading: optional boolean or null`18271828 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.18291830 - `enabled: optional boolean or null`18311832 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.18331834 - `left_click_drag: optional BrowserLeftClickDragConfig or null`18351836 `left_click_drag`'s config overrides.18371838 - `defer_loading: optional boolean or null`18391840 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.18411842 - `enabled: optional boolean or null`18431844 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.18451846 - `left_mouse_down: optional BrowserLeftMouseDownConfig or null`18471848 `left_mouse_down`'s config overrides.18491850 - `defer_loading: optional boolean or null`18511852 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.18531854 - `enabled: optional boolean or null`18551856 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.18571858 - `left_mouse_up: optional BrowserLeftMouseUpConfig or null`18591860 `left_mouse_up`'s config overrides.18611862 - `defer_loading: optional boolean or null`18631864 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.18651866 - `enabled: optional boolean or null`18671868 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.18691870 - `list_tabs: optional BrowserListTabsConfig or null`18711872 `list_tabs`'s config overrides.18731874 - `defer_loading: optional boolean or null`18751876 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.18771878 - `enabled: optional boolean or null`18791880 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.18811882 - `middle_click: optional BrowserMiddleClickConfig or null`18831884 `middle_click`'s config overrides.18851886 - `defer_loading: optional boolean or null`18871888 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.18891890 - `enabled: optional boolean or null`18911892 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.18931894 - `mouse_move: optional BrowserMouseMoveConfig or null`18951896 `mouse_move`'s config overrides.18971898 - `defer_loading: optional boolean or null`18991900 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.19011902 - `enabled: optional boolean or null`19031904 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.19051906 - `navigate: optional BrowserNavigateConfig or null`19071908 `navigate`'s config overrides.19091910 - `defer_loading: optional boolean or null`19111912 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.19131914 - `enabled: optional boolean or null`19151916 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.19171918 - `new_tab: optional BrowserNewTabConfig or null`19191920 `new_tab`'s config overrides.19211922 - `defer_loading: optional boolean or null`19231924 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.19251926 - `enabled: optional boolean or null`19271928 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.19291930 - `read_console: optional BrowserReadConsoleConfig or null`19311932 `read_console`'s config overrides.19331934 - `defer_loading: optional boolean or null`19351936 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.19371938 - `enabled: optional boolean or null`19391940 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.19411942 - `read_network: optional BrowserReadNetworkConfig or null`19431944 `read_network`'s config overrides.19451946 - `defer_loading: optional boolean or null`19471948 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.19491950 - `enabled: optional boolean or null`19511952 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.19531954 - `read_page: optional BrowserReadPageConfig or null`19551956 `read_page`'s config overrides.19571958 - `defer_loading: optional boolean or null`19591960 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.19611962 - `enabled: optional boolean or null`19631964 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.19651966 - `right_click: optional BrowserRightClickConfig or null`19671968 `right_click`'s config overrides.19691970 - `defer_loading: optional boolean or null`19711972 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.19731974 - `enabled: optional boolean or null`19751976 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.19771978 - `screenshot: optional BrowserScreenshotConfig or null`19791980 `screenshot`'s config overrides.19811982 - `defer_loading: optional boolean or null`19831984 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.19851986 - `enabled: optional boolean or null`19871988 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.19891990 - `scroll: optional BrowserScrollConfig or null`19911992 `scroll`'s config overrides.19931994 - `defer_loading: optional boolean or null`19951996 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.19971998 - `enabled: optional boolean or null`19992000 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.20012002 - `scroll_to: optional BrowserScrollToConfig or null`20032004 `scroll_to`'s config overrides.20052006 - `defer_loading: optional boolean or null`20072008 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.20092010 - `enabled: optional boolean or null`20112012 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.20132014 - `switch_tab: optional BrowserSwitchTabConfig or null`20152016 `switch_tab`'s config overrides.20172018 - `defer_loading: optional boolean or null`20192020 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.20212022 - `enabled: optional boolean or null`20232024 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.20252026 - `triple_click: optional BrowserTripleClickConfig or null`20272028 `triple_click`'s config overrides.20292030 - `defer_loading: optional boolean or null`20312032 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.20332034 - `enabled: optional boolean or null`20352036 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.20372038 - `wait: optional BrowserWaitConfig or null`20392040 `wait`'s config overrides.20412042 - `defer_loading: optional boolean or null`20432044 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.20452046 - `enabled: optional boolean or null`20472048 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.20492050 - `zoom: optional BrowserZoomConfig or null`20512052 `zoom`'s config overrides.20532054 - `defer_loading: optional boolean or null`20552056 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.20572058 - `enabled: optional boolean or null`20592060 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.20612062 - `MemoryTool20250818 object`20632064 - `type: "memory_20250818"`20652066 - `name: "memory"`20672068 Name of the tool.20692070 This is how the tool will be called by the model and in `tool_use` blocks.20712072 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`20732074 - `"direct"`20752076 - `"code_execution_20250825"`20772078 - `"code_execution_20260120"`20792080 - `"code_execution_20260521"`20812082 - `cache_control: optional CacheControlEphemeral or null`20832084 Create a cache control breakpoint at this content block.20852086 - `defer_loading: optional boolean`20872088 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.20892090 - `input_examples: optional array of map[unknown]`20912092 - `strict: optional boolean`20932094 When true, guarantees schema validation on tool names and inputs20952096 - `ComputerToolset20260801 object`20972098 The computer toolset: a single `tools[]` entry (carrying no2099 `name`) that declares the computer tool family. The model is2100 served the family's tool with any members disabled via `configs`2101 removed from its schema. Every member is enabled by default, zoom2102 included. The single-tool options `display_number` and2103 `enable_zoom` are not fields of a toolset entry — it carries only2104 `type`, `configs`, and `cache_control`; zoom is controlled2105 via `configs.zoom.enabled`.21062107 - `type: "computer_toolset_20260801"`21082109 - `cache_control: optional CacheControlEphemeral or null`21102111 Create a cache control breakpoint at this content block.21122113 - `configs: optional ComputerToolsetConfigs or null`21142115 Per-member configuration for `computer_toolset_20260801`: one2116 optional field per member tool, keyed by the member name — the same2117 name the member's `tool_use` blocks carry. Every member is an2118 accepted key, and a member's defaults apply wherever its key is2119 absent. Unknown keys are rejected: the field set is this toolset2120 version's complete member set.21212122 - `type: optional ComputerTypeConfig or null`21232124 `type`'s config overrides.21252126 - `defer_loading: optional boolean or null`21272128 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.21292130 - `enabled: optional boolean or null`21312132 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.21332134 - `cursor_position: optional ComputerCursorPositionConfig or null`21352136 `cursor_position`'s config overrides.21372138 - `defer_loading: optional boolean or null`21392140 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.21412142 - `enabled: optional boolean or null`21432144 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.21452146 - `double_click: optional ComputerDoubleClickConfig or null`21472148 `double_click`'s config overrides.21492150 - `defer_loading: optional boolean or null`21512152 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.21532154 - `enabled: optional boolean or null`21552156 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.21572158 - `hold_key: optional ComputerHoldKeyConfig or null`21592160 `hold_key`'s config overrides.21612162 - `defer_loading: optional boolean or null`21632164 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.21652166 - `enabled: optional boolean or null`21672168 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.21692170 - `key: optional ComputerKeyConfig or null`21712172 `key`'s config overrides.21732174 - `defer_loading: optional boolean or null`21752176 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.21772178 - `enabled: optional boolean or null`21792180 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.21812182 - `left_click: optional ComputerLeftClickConfig or null`21832184 `left_click`'s config overrides.21852186 - `defer_loading: optional boolean or null`21872188 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.21892190 - `enabled: optional boolean or null`21912192 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.21932194 - `left_click_drag: optional ComputerLeftClickDragConfig or null`21952196 `left_click_drag`'s config overrides.21972198 - `defer_loading: optional boolean or null`21992200 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.22012202 - `enabled: optional boolean or null`22032204 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.22052206 - `left_mouse_down: optional ComputerLeftMouseDownConfig or null`22072208 `left_mouse_down`'s config overrides.22092210 - `defer_loading: optional boolean or null`22112212 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.22132214 - `enabled: optional boolean or null`22152216 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.22172218 - `left_mouse_up: optional ComputerLeftMouseUpConfig or null`22192220 `left_mouse_up`'s config overrides.22212222 - `defer_loading: optional boolean or null`22232224 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.22252226 - `enabled: optional boolean or null`22272228 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.22292230 - `middle_click: optional ComputerMiddleClickConfig or null`22312232 `middle_click`'s config overrides.22332234 - `defer_loading: optional boolean or null`22352236 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.22372238 - `enabled: optional boolean or null`22392240 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.22412242 - `mouse_move: optional ComputerMouseMoveConfig or null`22432244 `mouse_move`'s config overrides.22452246 - `defer_loading: optional boolean or null`22472248 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.22492250 - `enabled: optional boolean or null`22512252 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.22532254 - `right_click: optional ComputerRightClickConfig or null`22552256 `right_click`'s config overrides.22572258 - `defer_loading: optional boolean or null`22592260 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.22612262 - `enabled: optional boolean or null`22632264 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.22652266 - `screenshot: optional ComputerScreenshotConfig or null`22672268 `screenshot`'s config overrides.22692270 - `defer_loading: optional boolean or null`22712272 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.22732274 - `enabled: optional boolean or null`22752276 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.22772278 - `scroll: optional ComputerScrollConfig or null`22792280 `scroll`'s config overrides.22812282 - `defer_loading: optional boolean or null`22832284 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.22852286 - `enabled: optional boolean or null`22872288 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.22892290 - `triple_click: optional ComputerTripleClickConfig or null`22912292 `triple_click`'s config overrides.22932294 - `defer_loading: optional boolean or null`22952296 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.22972298 - `enabled: optional boolean or null`22992300 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.23012302 - `wait: optional ComputerWaitConfig or null`23032304 `wait`'s config overrides.23052306 - `defer_loading: optional boolean or null`23072308 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.23092310 - `enabled: optional boolean or null`23112312 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.23132314 - `zoom: optional ComputerZoomConfig or null`23152316 `zoom`'s config overrides.23172318 - `defer_loading: optional boolean or null`23192320 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.23212322 - `enabled: optional boolean or null`23232324 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.23252326 - `ToolTextEditor20250124 object`23272328 - `type: "text_editor_20250124"`23292330 - `name: "str_replace_editor"`23312332 Name of the tool.23332334 This is how the tool will be called by the model and in `tool_use` blocks.23352336 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`23372338 - `"direct"`23392340 - `"code_execution_20250825"`23412342 - `"code_execution_20260120"`23432344 - `"code_execution_20260521"`23452346 - `cache_control: optional CacheControlEphemeral or null`23472348 Create a cache control breakpoint at this content block.23492350 - `defer_loading: optional boolean`23512352 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.23532354 - `input_examples: optional array of map[unknown]`23552356 - `strict: optional boolean`23572358 When true, guarantees schema validation on tool names and inputs23592360 - `ToolTextEditor20250429 object`23612362 - `type: "text_editor_20250429"`23632364 - `name: "str_replace_based_edit_tool"`23652366 Name of the tool.23672368 This is how the tool will be called by the model and in `tool_use` blocks.23692370 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`23712372 - `"direct"`23732374 - `"code_execution_20250825"`23752376 - `"code_execution_20260120"`23772378 - `"code_execution_20260521"`23792380 - `cache_control: optional CacheControlEphemeral or null`23812382 Create a cache control breakpoint at this content block.23832384 - `defer_loading: optional boolean`23852386 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.23872388 - `input_examples: optional array of map[unknown]`23892390 - `strict: optional boolean`23912392 When true, guarantees schema validation on tool names and inputs23932394 - `ToolTextEditor20250728 object`23952396 - `type: "text_editor_20250728"`23972398 - `name: "str_replace_based_edit_tool"`23992400 Name of the tool.24012402 This is how the tool will be called by the model and in `tool_use` blocks.24032404 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`24052406 - `"direct"`24072408 - `"code_execution_20250825"`24092410 - `"code_execution_20260120"`24112412 - `"code_execution_20260521"`24132414 - `cache_control: optional CacheControlEphemeral or null`24152416 Create a cache control breakpoint at this content block.24172418 - `defer_loading: optional boolean`24192420 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.24212422 - `input_examples: optional array of map[unknown]`24232424 - `max_characters: optional number or null`24252426 Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.24272428 minimum: 124292430 - `strict: optional boolean`24312432 When true, guarantees schema validation on tool names and inputs24332434 - `WebSearchTool20250305 object`24352436 - `type: "web_search_20250305"`24372438 - `name: "web_search"`24392440 Name of the tool.24412442 This is how the tool will be called by the model and in `tool_use` blocks.24432444 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`24452446 - `"direct"`24472448 - `"code_execution_20250825"`24492450 - `"code_execution_20260120"`24512452 - `"code_execution_20260521"`24532454 - `allowed_domains: optional array of string or null`24552456 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.24572458 - `blocked_domains: optional array of string or null`24592460 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.24612462 - `cache_control: optional CacheControlEphemeral or null`24632464 Create a cache control breakpoint at this content block.24652466 - `defer_loading: optional boolean`24672468 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.24692470 - `max_uses: optional number or null`24712472 Maximum number of times the tool can be used in the API request.24732474 exclusiveMinimum: 024752476 - `strict: optional boolean`24772478 When true, guarantees schema validation on tool names and inputs24792480 - `user_location: optional UserLocation or null`24812482 Parameters for the user's location. Used to provide more relevant search results.24832484 - `type: "approximate"`24852486 - `city: optional string or null`24872488 The city of the user.24892490 maxLength: 255, minLength: 124912492 - `country: optional string or null`24932494 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.24952496 maxLength: 2, minLength: 224972498 - `region: optional string or null`24992500 The region of the user.25012502 maxLength: 255, minLength: 125032504 - `timezone: optional string or null`25052506 The [IANA timezone](https://nodatime.org/TimeZones) of the user.25072508 maxLength: 255, minLength: 125092510 - `WebFetchTool20250910 object`25112512 - `type: "web_fetch_20250910"`25132514 - `name: "web_fetch"`25152516 Name of the tool.25172518 This is how the tool will be called by the model and in `tool_use` blocks.25192520 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`25212522 - `"direct"`25232524 - `"code_execution_20250825"`25252526 - `"code_execution_20260120"`25272528 - `"code_execution_20260521"`25292530 - `allowed_domains: optional array of string or null`25312532 List of domains to allow fetching from25332534 - `blocked_domains: optional array of string or null`25352536 List of domains to block fetching from25372538 - `cache_control: optional CacheControlEphemeral or null`25392540 Create a cache control breakpoint at this content block.25412542 - `citations: optional CitationsConfigParam or null`25432544 Citations configuration for fetched documents. Citations are disabled by default.25452546 - `defer_loading: optional boolean`25472548 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.25492550 - `max_content_tokens: optional number or null`25512552 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.25532554 exclusiveMinimum: 025552556 - `max_uses: optional number or null`25572558 Maximum number of times the tool can be used in the API request.25592560 exclusiveMinimum: 025612562 - `strict: optional boolean`25632564 When true, guarantees schema validation on tool names and inputs25652566 - `url_sources: optional WebFetchURLSources or null`25672568 Which sources contribute to the set of URLs web fetch may fetch.25692570 Each key is a tagged variant: `user_input` is `all` or `none`; the2571 two tool filters are `all`, `none`, `only` (only the named tools'2572 results) or `except` (every result but the named tools'). A named tool2573 must be declared in this request's `tools[]`.25742575 - `client_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`25762577 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].25782579 - `WebFetchURLSourceAll object`25802581 The `url_sources` variant under which a source contributes in2582 full: every result of the tool filter's source, or all user input.25832584 - `type: "all"`25852586 - `WebFetchURLSourceNone object`25872588 The `url_sources` variant under which a source contributes nothing:2589 no result of the tool filter's source, or no user input.25902591 - `type: "none"`25922593 - `WebFetchURLSourceOnly object`25942595 The tool filter variant under which only the named tools' results2596 contribute.25972598 - `type: "only"`25992600 - `tools: array of WebFetchURLSourceToolReference`26012602 - `type: "tool_reference"`26032604 - `name: string`26052606 - `WebFetchURLSourceExcept object`26072608 The tool filter variant under which every result but the named2609 tools' contributes.26102611 - `type: "except"`26122613 - `tools: array of WebFetchURLSourceToolReference`26142615 - `type: "tool_reference"`26162617 - `name: string`26182619 - `server_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`26202621 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.26222623 - `WebFetchURLSourceAll object`26242625 The `url_sources` variant under which a source contributes in2626 full: every result of the tool filter's source, or all user input.26272628 - `WebFetchURLSourceNone object`26292630 The `url_sources` variant under which a source contributes nothing:2631 no result of the tool filter's source, or no user input.26322633 - `WebFetchURLSourceOnly object`26342635 The tool filter variant under which only the named tools' results2636 contribute.26372638 - `WebFetchURLSourceExcept object`26392640 The tool filter variant under which every result but the named2641 tools' contributes.26422643 - `user_input: optional WebFetchURLSourceAll or WebFetchURLSourceNone`26442645 Whether URLs in user messages are fetchable: "all" or "none".26462647 - `WebFetchURLSourceAll object`26482649 The `url_sources` variant under which a source contributes in2650 full: every result of the tool filter's source, or all user input.26512652 - `WebFetchURLSourceNone object`26532654 The `url_sources` variant under which a source contributes nothing:2655 no result of the tool filter's source, or no user input.26562657 - `WebSearchTool20260209 object`26582659 - `type: "web_search_20260209"`26602661 - `name: "web_search"`26622663 Name of the tool.26642665 This is how the tool will be called by the model and in `tool_use` blocks.26662667 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`26682669 - `"direct"`26702671 - `"code_execution_20250825"`26722673 - `"code_execution_20260120"`26742675 - `"code_execution_20260521"`26762677 - `allowed_domains: optional array of string or null`26782679 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.26802681 - `blocked_domains: optional array of string or null`26822683 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.26842685 - `cache_control: optional CacheControlEphemeral or null`26862687 Create a cache control breakpoint at this content block.26882689 - `defer_loading: optional boolean`26902691 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.26922693 - `max_uses: optional number or null`26942695 Maximum number of times the tool can be used in the API request.26962697 exclusiveMinimum: 026982699 - `strict: optional boolean`27002701 When true, guarantees schema validation on tool names and inputs27022703 - `user_location: optional UserLocation or null`27042705 Parameters for the user's location. Used to provide more relevant search results.27062707 - `WebFetchTool20260209 object`27082709 - `type: "web_fetch_20260209"`27102711 - `name: "web_fetch"`27122713 Name of the tool.27142715 This is how the tool will be called by the model and in `tool_use` blocks.27162717 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`27182719 - `"direct"`27202721 - `"code_execution_20250825"`27222723 - `"code_execution_20260120"`27242725 - `"code_execution_20260521"`27262727 - `allowed_domains: optional array of string or null`27282729 List of domains to allow fetching from27302731 - `blocked_domains: optional array of string or null`27322733 List of domains to block fetching from27342735 - `cache_control: optional CacheControlEphemeral or null`27362737 Create a cache control breakpoint at this content block.27382739 - `citations: optional CitationsConfigParam or null`27402741 Citations configuration for fetched documents. Citations are disabled by default.27422743 - `defer_loading: optional boolean`27442745 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.27462747 - `max_content_tokens: optional number or null`27482749 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.27502751 exclusiveMinimum: 027522753 - `max_uses: optional number or null`27542755 Maximum number of times the tool can be used in the API request.27562757 exclusiveMinimum: 027582759 - `strict: optional boolean`27602761 When true, guarantees schema validation on tool names and inputs27622763 - `url_sources: optional WebFetchURLSources or null`27642765 Which sources contribute to the set of URLs web fetch may fetch.27662767 Each key is a tagged variant: `user_input` is `all` or `none`; the2768 two tool filters are `all`, `none`, `only` (only the named tools'2769 results) or `except` (every result but the named tools'). A named tool2770 must be declared in this request's `tools[]`.27712772 - `WebFetchTool20260309 object`27732774 Web fetch tool with use_cache parameter for bypassing cached content.27752776 - `type: "web_fetch_20260309"`27772778 - `name: "web_fetch"`27792780 Name of the tool.27812782 This is how the tool will be called by the model and in `tool_use` blocks.27832784 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`27852786 - `"direct"`27872788 - `"code_execution_20250825"`27892790 - `"code_execution_20260120"`27912792 - `"code_execution_20260521"`27932794 - `allowed_domains: optional array of string or null`27952796 List of domains to allow fetching from27972798 - `blocked_domains: optional array of string or null`27992800 List of domains to block fetching from28012802 - `cache_control: optional CacheControlEphemeral or null`28032804 Create a cache control breakpoint at this content block.28052806 - `citations: optional CitationsConfigParam or null`28072808 Citations configuration for fetched documents. Citations are disabled by default.28092810 - `defer_loading: optional boolean`28112812 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.28132814 - `max_content_tokens: optional number or null`28152816 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.28172818 exclusiveMinimum: 028192820 - `max_uses: optional number or null`28212822 Maximum number of times the tool can be used in the API request.28232824 exclusiveMinimum: 028252826 - `strict: optional boolean`28272828 When true, guarantees schema validation on tool names and inputs28292830 - `url_sources: optional WebFetchURLSources or null`28312832 Which sources contribute to the set of URLs web fetch may fetch.28332834 Each key is a tagged variant: `user_input` is `all` or `none`; the2835 two tool filters are `all`, `none`, `only` (only the named tools'2836 results) or `except` (every result but the named tools'). A named tool2837 must be declared in this request's `tools[]`.28382839 - `use_cache: optional boolean`28402841 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.28422843 - `WebSearchTool20260318 object`28442845 - `type: "web_search_20260318"`28462847 - `name: "web_search"`28482849 Name of the tool.28502851 This is how the tool will be called by the model and in `tool_use` blocks.28522853 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`28542855 - `"direct"`28562857 - `"code_execution_20250825"`28582859 - `"code_execution_20260120"`28602861 - `"code_execution_20260521"`28622863 - `allowed_domains: optional array of string or null`28642865 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.28662867 - `blocked_domains: optional array of string or null`28682869 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.28702871 - `cache_control: optional CacheControlEphemeral or null`28722873 Create a cache control breakpoint at this content block.28742875 - `defer_loading: optional boolean`28762877 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.28782879 - `max_uses: optional number or null`28802881 Maximum number of times the tool can be used in the API request.28822883 exclusiveMinimum: 028842885 - `response_inclusion: optional "full" or "excluded"`28862887 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.28882889 - `"full"`28902891 - `"excluded"`28922893 - `strict: optional boolean`28942895 When true, guarantees schema validation on tool names and inputs28962897 - `user_location: optional UserLocation or null`28982899 Parameters for the user's location. Used to provide more relevant search results.29002901 - `WebFetchTool20260318 object`29022903 - `type: "web_fetch_20260318"`29042905 - `name: "web_fetch"`29062907 Name of the tool.29082909 This is how the tool will be called by the model and in `tool_use` blocks.29102911 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`29122913 - `"direct"`29142915 - `"code_execution_20250825"`29162917 - `"code_execution_20260120"`29182919 - `"code_execution_20260521"`29202921 - `allowed_domains: optional array of string or null`29222923 List of domains to allow fetching from29242925 - `blocked_domains: optional array of string or null`29262927 List of domains to block fetching from29282929 - `cache_control: optional CacheControlEphemeral or null`29302931 Create a cache control breakpoint at this content block.29322933 - `citations: optional CitationsConfigParam or null`29342935 Citations configuration for fetched documents. Citations are disabled by default.29362937 - `defer_loading: optional boolean`29382939 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.29402941 - `max_content_tokens: optional number or null`29422943 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.29442945 exclusiveMinimum: 029462947 - `max_uses: optional number or null`29482949 Maximum number of times the tool can be used in the API request.29502951 exclusiveMinimum: 029522953 - `response_inclusion: optional "full" or "excluded"`29542955 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.29562957 - `"full"`29582959 - `"excluded"`29602961 - `strict: optional boolean`29622963 When true, guarantees schema validation on tool names and inputs29642965 - `url_sources: optional WebFetchURLSources or null`29662967 Which sources contribute to the set of URLs web fetch may fetch.29682969 Each key is a tagged variant: `user_input` is `all` or `none`; the2970 two tool filters are `all`, `none`, `only` (only the named tools'2971 results) or `except` (every result but the named tools'). A named tool2972 must be declared in this request's `tools[]`.29732974 - `use_cache: optional boolean`29752976 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.29772978 - `ToolSearchToolBm25_20251119 object`29792980 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`29812982 - `"tool_search_tool_bm25_20251119"`29832984 - `"tool_search_tool_bm25"`29852986 - `name: "tool_search_tool_bm25"`29872988 Name of the tool.29892990 This is how the tool will be called by the model and in `tool_use` blocks.29912992 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`29932994 - `"direct"`29952996 - `"code_execution_20250825"`29972998 - `"code_execution_20260120"`29993000 - `"code_execution_20260521"`30013002 - `cache_control: optional CacheControlEphemeral or null`30033004 Create a cache control breakpoint at this content block.30053006 - `defer_loading: optional boolean`30073008 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.30093010 - `strict: optional boolean`30113012 When true, guarantees schema validation on tool names and inputs30133014 - `ToolSearchToolRegex20251119 object`30153016 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`30173018 - `"tool_search_tool_regex_20251119"`30193020 - `"tool_search_tool_regex"`30213022 - `name: "tool_search_tool_regex"`30233024 Name of the tool.30253026 This is how the tool will be called by the model and in `tool_use` blocks.30273028 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`30293030 - `"direct"`30313032 - `"code_execution_20250825"`30333034 - `"code_execution_20260120"`30353036 - `"code_execution_20260521"`30373038 - `cache_control: optional CacheControlEphemeral or null`30393040 Create a cache control breakpoint at this content block.30413042 - `defer_loading: optional boolean`30433044 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.30453046 - `strict: optional boolean`30473048 When true, guarantees schema validation on tool names and inputs30493050- `temperature: optional number`30513052 **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.30533054 Amount of randomness injected into the response.30553056 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.30573058 Note that even with `temperature` of `0.0`, the results will not be fully deterministic.30593060 maximum: 1, minimum: 030613062- `top_k: optional number`30633064 **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error.30653066 Only sample from the top K options for each subsequent token.30673068 Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277).30693070 Recommended for advanced use cases only.30713072 minimum: 030733074- `top_p: optional number`30753076 **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.30773078 Use nucleus sampling.30793080 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`.30813082 Recommended for advanced use cases only.30833084 maximum: 1, minimum: 030853086### Returns30873088- `Message object`30893090 - `type: "message"`30913092 Object type.30933094 For Messages, this is always `"message"`.30953096 default: message30973098 - `id: string`30993100 Unique object identifier.31013102 The format and length of IDs may change over time.31033104 - `container: Container or null`31053106 Information about the container used in the request (for the code execution tool)31073108 - `id: string`31093110 Identifier for the container used in this request31113112 - `expires_at: string`31133114 The time at which the container will expire.31153116 format: date-time31173118 - `skills: array of ContainerSkill or null`31193120 Skills loaded in the container31213122 - `type: "anthropic" or "custom"`31233124 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)31253126 - `"anthropic"`31273128 - `"custom"`31293130 - `skill_id: string`31313132 Skill ID31333134 maxLength: 64, minLength: 131353136 - `version: string`31373138 The resolved version: a skill version ID for custom skills.31393140 maxLength: 64, minLength: 131413142 - `content: array of ContentBlock`31433144 Content generated by the model.31453146 This is an array of content blocks, each of which has a `type` that determines its shape.31473148 Example:31493150 ```json3151 [{"type": "text", "text": "Hi, I'm Claude."}]3152 ```31533154 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.31553156 For example, if the input `messages` were:31573158 ```json3159 [3160 {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},3161 {"role": "assistant", "content": "The best answer is ("}3162 ]3163 ```31643165 Then the response `content` might be:31663167 ```json3168 [{"type": "text", "text": "B)"}]3169 ```31703171 - `TextBlock object`31723173 - `type: "text"`31743175 default: text31763177 - `citations: array of TextCitation or null`31783179 Citations supporting the text block.31803181 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`.31823183 - `CitationCharLocation object`31843185 - `type: "char_location"`31863187 default: char_location31883189 - `cited_text: string`31903191 - `document_index: number`31923193 minimum: 031943195 - `document_title: string or null`31963197 - `end_char_index: number`31983199 - `file_id: string or null`32003201 - `start_char_index: number`32023203 minimum: 032043205 - `CitationPageLocation object`32063207 - `type: "page_location"`32083209 default: page_location32103211 - `cited_text: string`32123213 - `document_index: number`32143215 minimum: 032163217 - `document_title: string or null`32183219 - `end_page_number: number`32203221 - `file_id: string or null`32223223 - `start_page_number: number`32243225 minimum: 132263227 - `CitationContentBlockLocation object`32283229 - `type: "content_block_location"`32303231 default: content_block_location32323233 - `cited_text: string`32343235 The full text of the cited block range, concatenated.32363237 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.32383239 - `document_index: number`32403241 minimum: 032423243 - `document_title: string or null`32443245 - `end_block_index: number`32463247 Exclusive 0-based end index of the cited block range in the source's `content` array.32483249 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.32503251 - `file_id: string or null`32523253 - `start_block_index: number`32543255 0-based index of the first cited block in the source's `content` array.32563257 minimum: 032583259 - `CitationsWebSearchResultLocation object`32603261 - `type: "web_search_result_location"`32623263 default: web_search_result_location32643265 - `cited_text: string`32663267 - `encrypted_index: string`32683269 - `title: string or null`32703271 maxLength: 51232723273 - `url: string`32743275 - `CitationsSearchResultLocation object`32763277 - `type: "search_result_location"`32783279 default: search_result_location32803281 - `cited_text: string`32823283 The full text of the cited block range, concatenated.32843285 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.32863287 - `end_block_index: number`32883289 Exclusive 0-based end index of the cited block range in the source's `content` array.32903291 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.32923293 - `search_result_index: number`32943295 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.32963297 Counted separately from `document_index`; server-side web search results are not included in this count.32983299 minimum: 033003301 - `source: string`33023303 - `start_block_index: number`33043305 0-based index of the first cited block in the source's `content` array.33063307 minimum: 033083309 - `title: string or null`33103311 - `text: string`33123313 minLength: 033143315 - `ThinkingBlock object`33163317 - `type: "thinking"`33183319 default: thinking33203321 - `signature: string`33223323 A value used to verify that this thinking block was generated by Claude when it is passed back to the API.33243325 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.33263327 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.33283329 - `thinking: string`33303331 The text of Claude's thinking process for this block.33323333 - `RedactedThinkingBlock object`33343335 - `type: "redacted_thinking"`33363337 default: redacted_thinking33383339 - `data: string`33403341 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.33423343 Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.33443345 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.33463347 - `ToolUseBlock object`33483349 - `type: "tool_use"`33503351 default: tool_use33523353 - `id: string`33543355 pattern: ^[a-zA-Z0-9_-]+$33563357 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`33583359 default: {"type":"direct"}33603361 - `DirectCaller object`33623363 Tool invocation directly from the model.33643365 - `type: "direct"`33663367 - `ServerToolCaller object`33683369 Tool invocation generated by a server-side tool.33703371 - `type: "code_execution_20250825"`33723373 - `tool_id: string`33743375 pattern: ^srvtoolu_[a-zA-Z0-9_]+$33763377 - `ServerToolCaller20260120 object`33783379 - `type: "code_execution_20260120"`33803381 - `tool_id: string`33823383 pattern: ^srvtoolu_[a-zA-Z0-9_]+$33843385 - `input: map[unknown]`33863387 - `name: string`33883389 minLength: 133903391 - `toolset_name: optional string or null`33923393 For a toolset member tool_use, the toolset family.33943395 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$33963397 - `ServerToolUseBlock object`33983399 - `type: "server_tool_use"`34003401 default: server_tool_use34023403 - `id: string`34043405 pattern: ^srvtoolu_[a-zA-Z0-9_]+$34063407 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`34083409 default: {"type":"direct"}34103411 - `DirectCaller object`34123413 Tool invocation directly from the model.34143415 - `ServerToolCaller object`34163417 Tool invocation generated by a server-side tool.34183419 - `ServerToolCaller20260120 object`34203421 - `input: map[unknown]`34223423 - `name: "web_search" or "web_fetch" or "code_execution" or 4 more`34243425 - `"web_search"`34263427 - `"web_fetch"`34283429 - `"code_execution"`34303431 - `"bash_code_execution"`34323433 - `"text_editor_code_execution"`34343435 - `"tool_search_tool_regex"`34363437 - `"tool_search_tool_bm25"`34383439 - `WebSearchToolResultBlock object`34403441 - `type: "web_search_tool_result"`34423443 default: web_search_tool_result34443445 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`34463447 default: {"type":"direct"}34483449 - `DirectCaller object`34503451 Tool invocation directly from the model.34523453 - `ServerToolCaller object`34543455 Tool invocation generated by a server-side tool.34563457 - `ServerToolCaller20260120 object`34583459 - `content: WebSearchToolResultBlockContent`34603461 - `WebSearchToolResultError object`34623463 - `type: "web_search_tool_result_error"`34643465 default: web_search_tool_result_error34663467 - `error_code: WebSearchToolResultErrorCode`34683469 - `"invalid_tool_input"`34703471 - `"unavailable"`34723473 - `"max_uses_exceeded"`34743475 - `"too_many_requests"`34763477 - `"query_too_long"`34783479 - `"request_too_large"`34803481 - `array of WebSearchResultBlock`34823483 - `type: "web_search_result"`34843485 default: web_search_result34863487 - `encrypted_content: string`34883489 - `page_age: string or null`34903491 - `title: string`34923493 - `url: string`34943495 - `tool_use_id: string`34963497 pattern: ^srvtoolu_[a-zA-Z0-9_]+$34983499 - `WebFetchToolResultBlock object`35003501 - `type: "web_fetch_tool_result"`35023503 default: web_fetch_tool_result35043505 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`35063507 default: {"type":"direct"}35083509 - `DirectCaller object`35103511 Tool invocation directly from the model.35123513 - `ServerToolCaller object`35143515 Tool invocation generated by a server-side tool.35163517 - `ServerToolCaller20260120 object`35183519 - `content: WebFetchToolResultErrorBlock or WebFetchBlock`35203521 - `WebFetchToolResultErrorBlock object`35223523 - `type: "web_fetch_tool_result_error"`35243525 default: web_fetch_tool_result_error35263527 - `error_code: WebFetchToolResultErrorCode`35283529 - `"invalid_tool_input"`35303531 - `"url_too_long"`35323533 - `"url_not_allowed"`35343535 - `"url_not_in_prior_context"`35363537 - `"url_not_accessible"`35383539 - `"unsupported_content_type"`35403541 - `"too_many_requests"`35423543 - `"max_uses_exceeded"`35443545 - `"unavailable"`35463547 - `"content_too_large"`35483549 - `WebFetchBlock object`35503551 - `type: "web_fetch_result"`35523553 default: web_fetch_result35543555 - `content: DocumentBlock`35563557 - `type: "document"`35583559 default: document35603561 - `citations: CitationsConfig or null`35623563 Citation configuration for the document35643565 - `enabled: boolean`35663567 default: false35683569 - `source: Base64PDFSource or PlainTextSource`35703571 - `Base64PDFSource object`35723573 - `type: "base64"`35743575 - `data: string`35763577 format: byte35783579 - `media_type: "application/pdf"`35803581 - `PlainTextSource object`35823583 - `type: "text"`35843585 - `data: string`35863587 - `media_type: "text/plain"`35883589 - `title: string or null`35903591 The title of the document35923593 - `retrieved_at: string or null`35943595 ISO 8601 timestamp when the content was retrieved35963597 - `url: string`35983599 Fetched content URL36003601 - `tool_use_id: string`36023603 pattern: ^srvtoolu_[a-zA-Z0-9_]+$36043605 - `CodeExecutionToolResultBlock object`36063607 - `type: "code_execution_tool_result"`36083609 default: code_execution_tool_result36103611 - `content: CodeExecutionToolResultBlockContent`36123613 - `CodeExecutionToolResultError object`36143615 - `type: "code_execution_tool_result_error"`36163617 default: code_execution_tool_result_error36183619 - `error_code: CodeExecutionToolResultErrorCode`36203621 - `"invalid_tool_input"`36223623 - `"unavailable"`36243625 - `"too_many_requests"`36263627 - `"execution_time_exceeded"`36283629 - `CodeExecutionResultBlock object`36303631 - `type: "code_execution_result"`36323633 default: code_execution_result36343635 - `content: array of CodeExecutionOutputBlock`36363637 - `type: "code_execution_output"`36383639 default: code_execution_output36403641 - `file_id: string`36423643 - `return_code: number`36443645 - `stderr: string`36463647 - `stdout: string`36483649 - `EncryptedCodeExecutionResultBlock object`36503651 Code execution result with encrypted stdout for PFC + web_search results.36523653 - `type: "encrypted_code_execution_result"`36543655 default: encrypted_code_execution_result36563657 - `content: array of CodeExecutionOutputBlock`36583659 - `type: "code_execution_output"`36603661 default: code_execution_output36623663 - `file_id: string`36643665 - `encrypted_stdout: string`36663667 - `return_code: number`36683669 - `stderr: string`36703671 - `tool_use_id: string`36723673 pattern: ^srvtoolu_[a-zA-Z0-9_]+$36743675 - `BashCodeExecutionToolResultBlock object`36763677 - `type: "bash_code_execution_tool_result"`36783679 default: bash_code_execution_tool_result36803681 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`36823683 - `BashCodeExecutionToolResultError object`36843685 - `type: "bash_code_execution_tool_result_error"`36863687 default: bash_code_execution_tool_result_error36883689 - `error_code: BashCodeExecutionToolResultErrorCode`36903691 - `"invalid_tool_input"`36923693 - `"unavailable"`36943695 - `"too_many_requests"`36963697 - `"execution_time_exceeded"`36983699 - `"output_file_too_large"`37003701 - `BashCodeExecutionResultBlock object`37023703 - `type: "bash_code_execution_result"`37043705 default: bash_code_execution_result37063707 - `content: array of BashCodeExecutionOutputBlock`37083709 - `type: "bash_code_execution_output"`37103711 default: bash_code_execution_output37123713 - `file_id: string`37143715 - `return_code: number`37163717 - `stderr: string`37183719 - `stdout: string`37203721 - `tool_use_id: string`37223723 pattern: ^srvtoolu_[a-zA-Z0-9_]+$37243725 - `TextEditorCodeExecutionToolResultBlock object`37263727 - `type: "text_editor_code_execution_tool_result"`37283729 default: text_editor_code_execution_tool_result37303731 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`37323733 - `TextEditorCodeExecutionToolResultError object`37343735 - `type: "text_editor_code_execution_tool_result_error"`37363737 default: text_editor_code_execution_tool_result_error37383739 - `error_code: TextEditorCodeExecutionToolResultErrorCode`37403741 - `"invalid_tool_input"`37423743 - `"unavailable"`37443745 - `"too_many_requests"`37463747 - `"execution_time_exceeded"`37483749 - `"file_not_found"`37503751 - `error_message: string or null`37523753 - `TextEditorCodeExecutionViewResultBlock object`37543755 - `type: "text_editor_code_execution_view_result"`37563757 default: text_editor_code_execution_view_result37583759 - `content: string`37603761 - `file_type: "text" or "image" or "pdf"`37623763 - `"text"`37643765 - `"image"`37663767 - `"pdf"`37683769 - `num_lines: number or null`37703771 - `start_line: number or null`37723773 - `total_lines: number or null`37743775 - `TextEditorCodeExecutionCreateResultBlock object`37763777 - `type: "text_editor_code_execution_create_result"`37783779 default: text_editor_code_execution_create_result37803781 - `is_file_update: boolean`37823783 - `TextEditorCodeExecutionStrReplaceResultBlock object`37843785 - `type: "text_editor_code_execution_str_replace_result"`37863787 default: text_editor_code_execution_str_replace_result37883789 - `lines: array of string or null`37903791 - `new_lines: number or null`37923793 - `new_start: number or null`37943795 - `old_lines: number or null`37963797 - `old_start: number or null`37983799 - `tool_use_id: string`38003801 pattern: ^srvtoolu_[a-zA-Z0-9_]+$38023803 - `ToolSearchToolResultBlock object`38043805 - `type: "tool_search_tool_result"`38063807 default: tool_search_tool_result38083809 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`38103811 - `ToolSearchToolResultError object`38123813 - `type: "tool_search_tool_result_error"`38143815 default: tool_search_tool_result_error38163817 - `error_code: ToolSearchToolResultErrorCode`38183819 - `"invalid_tool_input"`38203821 - `"unavailable"`38223823 - `"too_many_requests"`38243825 - `"execution_time_exceeded"`38263827 - `error_message: string or null`38283829 - `ToolSearchToolSearchResultBlock object`38303831 - `type: "tool_search_tool_search_result"`38323833 default: tool_search_tool_search_result38343835 - `tool_references: array of ToolReferenceBlock`38363837 - `type: "tool_reference"`38383839 default: tool_reference38403841 - `tool_name: string`38423843 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$38443845 - `tool_use_id: string`38463847 pattern: ^srvtoolu_[a-zA-Z0-9_]+$38483849 - `ContainerUploadBlock object`38503851 Response model for a file uploaded to the container.38523853 - `type: "container_upload"`38543855 default: container_upload38563857 - `file_id: string`38583859 - `model: Model`38603861 The model that will complete your prompt.38623863 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.38643865 - `"claude-fable-5-1" or "claude-mythos-5-1" or "claude-sonnet-5" or 14 more`38663867 The model that will complete your prompt.38683869 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.38703871 - `"claude-fable-5-1"`38723873 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows38743875 - `"claude-mythos-5-1"`38763877 Our most capable model for cybersecurity and biology research, available through trusted access programs38783879 - `"claude-sonnet-5"`38803881 High-performance model for coding and agents38823883 - `"claude-fable-5"`38843885 Next generation of intelligence for the hardest knowledge work and coding problems38863887 - `"claude-mythos-5"`38883889 Most capable model for cybersecurity and biology research38903891 - `"claude-opus-5"`38923893 Powerful intelligence for long-running agents and coding38943895 - `"claude-opus-4-8"`38963897 Powerful intelligence for long-running agents and coding38983899 - `"claude-opus-4-7"`39003901 Powerful intelligence for long-running agents and coding39023903 - `"claude-mythos-preview"`39043905 New class of intelligence, strongest in coding and cybersecurity39063907 - `"claude-opus-4-6"`39083909 Powerful intelligence for long-running agents and coding39103911 - `"claude-sonnet-4-6"`39123913 Best combination of speed and intelligence39143915 - `"claude-haiku-4-5"`39163917 Fastest model with near-frontier intelligence39183919 - `"claude-haiku-4-5-20251001"`39203921 Fastest model with near-frontier intelligence39223923 - `"claude-opus-4-5"`39243925 Powerful intelligence for long-running agents and coding39263927 - `"claude-opus-4-5-20251101"`39283929 Powerful intelligence for long-running agents and coding39303931 - `"claude-sonnet-4-5"`39323933 High-performance model for agents and coding39343935 - `"claude-sonnet-4-5-20250929"`39363937 High-performance model for agents and coding39383939 - `string`39403941 - `role: "assistant"`39423943 Conversational role of the generated message.39443945 This will always be `"assistant"`.39463947 default: assistant39483949 - `stop_details: RefusalStopDetails or null`39503951 Structured information about a refusal.39523953 - `type: "refusal"`39543955 default: refusal39563957 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`39583959 The policy category that triggered a refusal.39603961 - `"cyber"`39623963 The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category.39643965 - `"bio"`39663967 The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category.39683969 - `"frontier_llm"`39703971 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.39723973 - `"reasoning_extraction"`39743975 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).39763977 - `"general_harms"`39783979 The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category.39803981 - `explanation: string or null`39823983 Human-readable explanation of the refusal.39843985 This text is not guaranteed to be stable. `null` when no explanation is available for the category.39863987 - `stop_reason: StopReason or null`39883989 The reason that we stopped.39903991 This may be one the following values:39923993 * `"end_turn"`: the model reached a natural stopping point3994 * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum3995 * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated3996 * `"tool_use"`: the model invoked one or more tools3997 * `"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.3998 * `"refusal"`: when streaming classifiers intervene to handle potential policy violations3999 * `"model_context_window_exceeded"`: we exceeded the model's context window40004001 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.40024003 - `"end_turn"`40044005 - `"max_tokens"`40064007 - `"stop_sequence"`40084009 - `"tool_use"`40104011 - `"pause_turn"`40124013 - `"refusal"`40144015 - `"model_context_window_exceeded"`40164017 - `stop_sequence: string or null`40184019 Which custom stop sequence was generated, if any.40204021 This value will be a non-null string if one of your custom stop sequences was generated.40224023 - `usage: Usage`40244025 Billing and rate-limit usage.40264027 Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.40284029 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.40304031 For example, `output_tokens` will be non-zero, even for an empty string response from Claude.40324033 Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`.40344035 - `cache_creation: CacheCreation or null`40364037 Breakdown of cached tokens by TTL40384039 - `ephemeral_1h_input_tokens: number`40404041 The number of input tokens used to create the 1 hour cache entry.40424043 default: 0, minimum: 040444045 - `ephemeral_5m_input_tokens: number`40464047 The number of input tokens used to create the 5 minute cache entry.40484049 default: 0, minimum: 040504051 - `cache_creation_input_tokens: number or null`40524053 The number of input tokens used to create the cache entry.40544055 minimum: 040564057 - `cache_read_input_tokens: number or null`40584059 The number of input tokens read from the cache.40604061 minimum: 040624063 - `inference_geo: string or null`40644065 The geographic region where inference was performed for this request.40664067 - `input_tokens: number`40684069 The number of input tokens which were used.40704071 minimum: 040724073 - `output_tokens: number`40744075 The number of output tokens which were used.40764077 minimum: 040784079 - `output_tokens_details: OutputTokensDetails or null`40804081 Breakdown of output tokens by category.40824083 `output_tokens` remains the inclusive, authoritative total used for billing.4084 This object provides a read-only decomposition for observability — for example,4085 how many of the billed output tokens were spent on internal reasoning that may4086 have been summarized before being returned to you.40874088 - `thinking_tokens: number`40894090 Number of output tokens the model generated as internal reasoning, including4091 the thinking-block delimiter tokens.40924093 Reflects the raw reasoning the model produced, not the (possibly shorter)4094 summarized thinking text returned in the response body. Computed by4095 re-tokenizing the raw reasoning text, so it may differ from the model's exact4096 generation count by a small number of tokens. Always ≤ `output_tokens`;4097 `output_tokens - thinking_tokens` approximates the non-reasoning output.40984099 default: 0, minimum: 041004101 - `server_tool_use: ServerToolUsage or null`41024103 The number of server tool requests.41044105 - `web_fetch_requests: number`41064107 The number of web fetch tool requests.41084109 default: 0, minimum: 041104111 - `web_search_requests: number`41124113 The number of web search tool requests.41144115 default: 0, minimum: 041164117 - `service_tier: "standard" or "priority" or "batch" or null`41184119 If the request used the priority, standard, or batch tier.41204121 - `"standard"`41224123 - `"priority"`41244125 - `"batch"`41264127- `RawMessageStreamEvent = RawMessageStartEvent or RawMessageDeltaEvent or RawMessageStopEvent or 3 more`41284129 - `RawMessageStartEvent object`41304131 - `type: "message_start"`41324133 default: message_start41344135 - `message: Message`41364137 - `RawMessageDeltaEvent object`41384139 - `type: "message_delta"`41404141 default: message_delta41424143 - `delta: object`41444145 - `container: Container or null`41464147 Information about the container used in the request (for the code execution tool)41484149 - `stop_details: RefusalStopDetails or null`41504151 Structured information about a refusal.41524153 - `stop_reason: StopReason or null`41544155 - `stop_sequence: string or null`41564157 - `usage: MessageDeltaUsage`41584159 Billing and rate-limit usage.41604161 Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.41624163 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.41644165 For example, `output_tokens` will be non-zero, even for an empty string response from Claude.41664167 Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`.41684169 - `cache_creation_input_tokens: number or null`41704171 The cumulative number of input tokens used to create the cache entry.41724173 minimum: 041744175 - `cache_read_input_tokens: number or null`41764177 The cumulative number of input tokens read from the cache.41784179 minimum: 041804181 - `input_tokens: number or null`41824183 The cumulative number of input tokens which were used.41844185 minimum: 041864187 - `output_tokens: number`41884189 The cumulative number of output tokens which were used.41904191 - `output_tokens_details: OutputTokensDetails or null`41924193 Breakdown of output tokens by category.41944195 `output_tokens` remains the inclusive, authoritative total used for billing.4196 This object provides a read-only decomposition for observability — for example,4197 how many of the billed output tokens were spent on internal reasoning that may4198 have been summarized before being returned to you.41994200 - `server_tool_use: ServerToolUsage or null`42014202 The number of server tool requests.42034204 - `RawMessageStopEvent object`42054206 - `type: "message_stop"`42074208 default: message_stop42094210 - `RawContentBlockStartEvent object`42114212 - `type: "content_block_start"`42134214 default: content_block_start42154216 - `content_block: TextBlock or ThinkingBlock or RedactedThinkingBlock or 9 more`42174218 - `TextBlock object`42194220 - `ThinkingBlock object`42214222 - `RedactedThinkingBlock object`42234224 - `ToolUseBlock object`42254226 - `ServerToolUseBlock object`42274228 - `WebSearchToolResultBlock object`42294230 - `WebFetchToolResultBlock object`42314232 - `CodeExecutionToolResultBlock object`42334234 - `BashCodeExecutionToolResultBlock object`42354236 - `TextEditorCodeExecutionToolResultBlock object`42374238 - `ToolSearchToolResultBlock object`42394240 - `ContainerUploadBlock object`42414242 Response model for a file uploaded to the container.42434244 - `index: number`42454246 - `RawContentBlockDeltaEvent object`42474248 - `type: "content_block_delta"`42494250 default: content_block_delta42514252 - `delta: RawContentBlockDelta`42534254 - `TextDelta object`42554256 - `type: "text_delta"`42574258 default: text_delta42594260 - `text: string`42614262 - `InputJSONDelta object`42634264 - `type: "input_json_delta"`42654266 default: input_json_delta42674268 - `partial_json: string`42694270 - `CitationsDelta object`42714272 - `type: "citations_delta"`42734274 default: citations_delta42754276 - `citation: CitationCharLocation or CitationPageLocation or CitationContentBlockLocation or 2 more`42774278 - `CitationCharLocation object`42794280 - `CitationPageLocation object`42814282 - `CitationContentBlockLocation object`42834284 - `CitationsWebSearchResultLocation object`42854286 - `CitationsSearchResultLocation object`42874288 - `ThinkingDelta object`42894290 - `type: "thinking_delta"`42914292 default: thinking_delta42934294 - `thinking: string`42954296 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.42974298 - `SignatureDelta object`42994300 - `type: "signature_delta"`43014302 default: signature_delta43034304 - `signature: string`43054306 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.43074308 - `index: number`43094310 - `RawContentBlockStopEvent object`43114312 - `type: "content_block_stop"`43134314 default: content_block_stop43154316 - `index: number`43174318### Example43194320```bash4321curl https://api.anthropic.com/v1/messages \4322 -H 'Content-Type: application/json' \4323 -H 'anthropic-version: 2023-06-01' \4324 -H "X-Api-Key: $ANTHROPIC_API_KEY" \4325 --max-time 600 \4326 -d '{4327 "max_tokens": 1024,4328 "messages": [4329 {4330 "content": "Hello, world",4331 "role": "user"4332 }4333 ],4334 "model": "claude-opus-5",4335 "stream": false,4336 "system": [4337 {4338 "text": "Today'\''s date is 2024-06-01.",4339 "type": "text"4340 }4341 ],4342 "temperature": 1,4343 "thinking": {4344 "type": "adaptive"4345 },4346 "tools": [4347 {4348 "input_schema": {4349 "type": "object",4350 "properties": {4351 "location": "bar",4352 "unit": "bar"4353 },4354 "required": [4355 "location"4356 ]4357 },4358 "name": "name"4359 }4360 ],4361 "top_k": 5,4362 "top_p": 0.74363 }'4364```43654366#### Response (200)43674368```json4369{4370 "id": "msg_013Zva2CMHLNnXjNJJKqJ2EF",4371 "container": {4372 "id": "container_011CpZohnwH4vuy7gazohgSP",4373 "expires_at": "2019-12-27T18:11:19.117Z",4374 "skills": [4375 {4376 "skill_id": "pdf",4377 "type": "anthropic",4378 "version": "latest"4379 }4380 ]4381 },4382 "content": [4383 {4384 "citations": [4385 {4386 "cited_text": "The grass is green. The sky is blue.",4387 "document_index": 0,4388 "document_title": "My Document",4389 "end_char_index": 0,4390 "file_id": "file_011CNha8iCJcU1wXNR6q4V8w",4391 "start_char_index": 0,4392 "type": "char_location"4393 }4394 ],4395 "text": "Hi! My name is Claude.",4396 "type": "text"4397 }4398 ],4399 "model": "claude-opus-5",4400 "role": "assistant",4401 "stop_details": {4402 "category": "cyber",4403 "explanation": "This request was declined because it conflicts with Anthropic's Usage Policy.",4404 "type": "refusal"4405 },4406 "stop_reason": "end_turn",4407 "stop_sequence": null,4408 "type": "message",4409 "usage": {4410 "cache_creation": {4411 "ephemeral_1h_input_tokens": 0,4412 "ephemeral_5m_input_tokens": 04413 },4414 "cache_creation_input_tokens": 2051,4415 "cache_read_input_tokens": 2051,4416 "inference_geo": "global",4417 "input_tokens": 2095,4418 "output_tokens": 503,4419 "output_tokens_details": {4420 "thinking_tokens": 04421 },4422 "server_tool_use": {4423 "web_fetch_requests": 2,4424 "web_search_requests": 04425 },4426 "service_tier": "standard"4427 }4428}4429```44304431## Count tokens in a Message44324433**POST** `/v1/messages/count_tokens`44344435Count the number of tokens in a Message.44364437The Token Count API can be used to count the number of tokens in a Message, including tools, images, and documents, without creating it.44384439Learn more about token counting in our [user guide](https://platform.claude.com/docs/en/build-with-claude/token-counting)44404441### Headers44424443- `"anthropic-user-profile-id": optional string`44444445 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.44464447- `"anthropic-workspace-id": optional string`44484449### Body parameters44504451- `messages: array of MessageParam`44524453 Input messages.44544455 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.44564457 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.44584459 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.44604461 Example with a single `user` message:44624463 ```json4464 [{"role": "user", "content": "Hello, Claude"}]4465 ```44664467 Example with multiple conversational turns:44684469 ```json4470 [4471 {"role": "user", "content": "Hello there."},4472 {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"},4473 {"role": "user", "content": "Can you explain LLMs in plain English?"},4474 ]4475 ```44764477 Example with a partially-filled response from Claude:44784479 ```json4480 [4481 {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},4482 {"role": "assistant", "content": "The best answer is ("},4483 ]4484 ```44854486 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:44874488 ```json4489 {"role": "user", "content": "Hello, Claude"}4490 ```44914492 ```json4493 {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]}4494 ```44954496 See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages).44974498 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#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API.44994500 There is a limit of 100,000 messages in a single request.45014502 - `content: string or array of ContentBlockParam`45034504 - `string`45054506 - `array of ContentBlockParam`45074508 - `TextBlockParam object`45094510 - `type: "text"`45114512 - `text: string`45134514 minLength: 145154516 - `cache_control: optional CacheControlEphemeral or null`45174518 Create a cache control breakpoint at this content block.45194520 - `type: "ephemeral"`45214522 - `ttl: optional "5m" or "1h"`45234524 The time-to-live for the cache control breakpoint.45254526 This may be one the following values:45274528 - `5m`: 5 minutes4529 - `1h`: 1 hour45304531 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.45324533 - `"5m"`45344535 - `"1h"`45364537 - `citations: optional array of TextCitationParam or null`45384539 - `CitationCharLocationParam object`45404541 - `type: "char_location"`45424543 - `cited_text: string`45444545 - `document_index: number`45464547 minimum: 045484549 - `document_title: string or null`45504551 maxLength: 500, minLength: 145524553 - `end_char_index: number`45544555 - `start_char_index: number`45564557 minimum: 045584559 - `CitationPageLocationParam object`45604561 - `type: "page_location"`45624563 - `cited_text: string`45644565 - `document_index: number`45664567 minimum: 045684569 - `document_title: string or null`45704571 maxLength: 500, minLength: 145724573 - `end_page_number: number`45744575 - `start_page_number: number`45764577 minimum: 145784579 - `CitationContentBlockLocationParam object`45804581 - `type: "content_block_location"`45824583 - `cited_text: string`45844585 The full text of the cited block range, concatenated.45864587 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.45884589 - `document_index: number`45904591 minimum: 045924593 - `document_title: string or null`45944595 maxLength: 500, minLength: 145964597 - `end_block_index: number`45984599 Exclusive 0-based end index of the cited block range in the source's `content` array.46004601 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.46024603 - `start_block_index: number`46044605 0-based index of the first cited block in the source's `content` array.46064607 minimum: 046084609 - `CitationWebSearchResultLocationParam object`46104611 - `type: "web_search_result_location"`46124613 - `cited_text: string`46144615 - `encrypted_index: string`46164617 - `title: string or null`46184619 maxLength: 512, minLength: 146204621 - `url: string`46224623 minLength: 146244625 - `CitationSearchResultLocationParam object`46264627 - `type: "search_result_location"`46284629 - `cited_text: string`46304631 The full text of the cited block range, concatenated.46324633 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.46344635 - `end_block_index: number`46364637 Exclusive 0-based end index of the cited block range in the source's `content` array.46384639 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.46404641 - `search_result_index: number`46424643 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.46444645 Counted separately from `document_index`; server-side web search results are not included in this count.46464647 minimum: 046484649 - `source: string`46504651 - `start_block_index: number`46524653 0-based index of the first cited block in the source's `content` array.46544655 minimum: 046564657 - `title: string or null`46584659 - `ImageBlockParam object`46604661 - `type: "image"`46624663 - `source: Base64ImageSource or URLImageSource or FileImageSource`46644665 - `Base64ImageSource object`46664667 - `type: "base64"`46684669 - `data: string`46704671 format: byte46724673 - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"`46744675 - `"image/jpeg"`46764677 - `"image/png"`46784679 - `"image/gif"`46804681 - `"image/webp"`46824683 - `URLImageSource object`46844685 - `type: "url"`46864687 - `url: string`46884689 - `FileImageSource object`46904691 - `type: "file"`46924693 - `file_id: string`46944695 - `cache_control: optional CacheControlEphemeral or null`46964697 Create a cache control breakpoint at this content block.46984699 - `transformations: optional ImageTransformationsParam or null`47004701 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.47024703 - `oversized_image: optional "downsize" or "error"`47044705 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.47064707 - `"downsize"`47084709 - `"error"`47104711 - `DocumentBlockParam object`47124713 - `type: "document"`47144715 - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more`47164717 - `Base64PDFSource object`47184719 - `type: "base64"`47204721 - `data: string`47224723 format: byte47244725 - `media_type: "application/pdf"`47264727 - `PlainTextSource object`47284729 - `type: "text"`47304731 - `data: string`47324733 - `media_type: "text/plain"`47344735 - `ContentBlockSource object`47364737 - `type: "content"`47384739 - `content: string or array of ContentBlockSourceContent`47404741 - `string`47424743 - `ContentBlockSourceContent = array of ContentBlockSourceContent`47444745 - `TextBlockParam object`47464747 - `ImageBlockParam object`47484749 - `URLPDFSource object`47504751 - `type: "url"`47524753 - `url: string`47544755 - `FileDocumentSource object`47564757 - `type: "file"`47584759 - `file_id: string`47604761 - `cache_control: optional CacheControlEphemeral or null`47624763 Create a cache control breakpoint at this content block.47644765 - `citations: optional CitationsConfigParam or null`47664767 - `enabled: optional boolean`47684769 - `context: optional string or null`47704771 minLength: 147724773 - `title: optional string or null`47744775 maxLength: 500, minLength: 147764777 - `SearchResultBlockParam object`47784779 - `type: "search_result"`47804781 - `content: array of TextBlockParam`47824783 - `type: "text"`47844785 - `text: string`47864787 minLength: 147884789 - `cache_control: optional CacheControlEphemeral or null`47904791 Create a cache control breakpoint at this content block.47924793 - `citations: optional array of TextCitationParam or null`47944795 - `source: string`47964797 - `title: string`47984799 - `cache_control: optional CacheControlEphemeral or null`48004801 Create a cache control breakpoint at this content block.48024803 - `citations: optional CitationsConfigParam`48044805 - `ThinkingBlockParam object`48064807 - `type: "thinking"`48084809 - `signature: string`48104811 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.48124813 Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`.48144815 - `thinking: string`48164817 The `thinking` text of this block as returned by the API.48184819 - `RedactedThinkingBlockParam object`48204821 - `type: "redacted_thinking"`48224823 - `data: string`48244825 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.48264827 - `ToolUseBlockParam object`48284829 - `type: "tool_use"`48304831 - `id: string`48324833 pattern: ^[a-zA-Z0-9_-]+$48344835 - `input: map[unknown]`48364837 - `name: string`48384839 maxLength: 200, minLength: 148404841 - `cache_control: optional CacheControlEphemeral or null`48424843 Create a cache control breakpoint at this content block.48444845 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`48464847 - `DirectCaller object`48484849 Tool invocation directly from the model.48504851 - `type: "direct"`48524853 - `ServerToolCaller object`48544855 Tool invocation generated by a server-side tool.48564857 - `type: "code_execution_20250825"`48584859 - `tool_id: string`48604861 pattern: ^srvtoolu_[a-zA-Z0-9_]+$48624863 - `ServerToolCaller20260120 object`48644865 - `type: "code_execution_20260120"`48664867 - `tool_id: string`48684869 pattern: ^srvtoolu_[a-zA-Z0-9_]+$48704871 - `toolset_name: optional string or null`48724873 For a toolset member tool_use, the toolset family this member belongs to.48744875 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$48764877 - `ToolResultBlockParam object`48784879 - `type: "tool_result"`48804881 - `tool_use_id: string`48824883 pattern: ^[a-zA-Z0-9_-]+$48844885 - `cache_control: optional CacheControlEphemeral or null`48864887 Create a cache control breakpoint at this content block.48884889 - `content: optional string or array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 3 more`48904891 - `string`48924893 - `array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 3 more`48944895 - `TextBlockParam object`48964897 - `ImageBlockParam object`48984899 - `SearchResultBlockParam object`49004901 - `DocumentBlockParam object`49024903 - `ToolReferenceBlockParam object`49044905 Tool reference block that can be included in tool_result content.49064907 - `type: "tool_reference"`49084909 - `tool_name: string`49104911 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$49124913 - `cache_control: optional CacheControlEphemeral or null`49144915 Create a cache control breakpoint at this content block.49164917 - `BrowserStateBlockParam object`49184919 The caller's browser state after a browser toolset member call —4920 the full inventory of open tabs, which tab is active, and any side4921 effects (tabs opened, download state changes) the call produced.49224923 At most one per `tool_result`, only on a non-error result answering a4924 browser toolset member `tool_use`. The server renders the4925 model-visible text from it; the model never sees the raw fields.49264927 - `type: "browser_state"`49284929 - `tabs: array of BrowserStateTabEntry`49304931 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`.49324933 maxItems: 10049344935 - `tab_id: string`49364937 The caller-assigned identifier for this tab, unique within the inventory.49384939 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$49404941 - `title: string`49424943 The title of the page the tab is showing. May be empty.49444945 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$49464947 - `url: string`49484949 The URL of the page the tab is showing. May be empty.49504951 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$49524953 - `active: optional boolean`49544955 Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.49564957 - `cache_control: optional CacheControlEphemeral or null`49584959 Create a cache control breakpoint at this content block.49604961 - `state_changes: optional array of BrowserStateChange or null`49624963 Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list.49644965 maxItems: 200, minItems: 149664967 - `BrowserStateChangeTabOpened object`49684969 A tab this call's execution opened that remains open at its end —4970 the creation delta of the `tabs` inventory, not an event log.49714972 Carries only the `tab_id`; the tab's `title` and `url` live on its4973 `tabs` entry, which must include the same `tab_id`. A tab opened4974 during a failed call gets no deferred `tab_opened`; it simply appears4975 in the next result's `tabs` inventory.49764977 - `type: "tab_opened"`49784979 - `tab_id: string`49804981 The `tab_id` of the opened tab, present in `tabs`.49824983 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$49844985 - `BrowserStateChangeDownloadStarted object`49864987 A file download that started during this call.49884989 - `type: "download_started"`49904991 - `download_id: string`49924993 The caller-assigned identifier for this download, stable across the state changes reporting it.49944995 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$49964997 - `url: string`49984999 The final post-redirect URL the download was served from.50005001 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$50025003 - `BrowserStateChangeDownloadCompleted object`50045005 A file download that finished during this call, reported with the5006 same `download_id` as its `download_started` — or without a prior5007 `download_started`, when the download finished during the call that5008 started it (at most one state change per `download_id` per result).50095010 - `type: "download_completed"`50115012 - `download_id: string`50135014 The caller-assigned identifier for this download, stable across the state changes reporting it.50155016 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$50175018 - `url: string`50195020 The final post-redirect URL the download was served from.50215022 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$50235024 - `path: optional string or null`50255026 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.50275028 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 409650295030 - `size_bytes: optional number or null`50315032 The completed download's size.50335034 minimum: 050355036 - `BrowserStateChangeDownloadFailed object`50375038 A file download that failed — or was cancelled — during this call.50395040 - `type: "download_failed"`50415042 - `download_id: string`50435044 The caller-assigned identifier for this download, stable across the state changes reporting it.50455046 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$50475048 - `url: string`50495050 The final post-redirect URL the download was served from.50515052 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$50535054 - `error: optional string or null`50555056 The failure or cancellation detail, when known.50575058 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 409650595060 - `is_error: optional boolean`50615062 - `toolset_name: optional string or null`50635064 For a toolset member tool_result, the toolset family of the paired tool_use.50655066 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$50675068 - `ServerToolUseBlockParam object`50695070 - `type: "server_tool_use"`50715072 - `id: string`50735074 pattern: ^srvtoolu_[a-zA-Z0-9_]+$50755076 - `input: map[unknown]`50775078 - `name: "web_search" or "web_fetch" or "code_execution" or 4 more`50795080 - `"web_search"`50815082 - `"web_fetch"`50835084 - `"code_execution"`50855086 - `"bash_code_execution"`50875088 - `"text_editor_code_execution"`50895090 - `"tool_search_tool_regex"`50915092 - `"tool_search_tool_bm25"`50935094 - `cache_control: optional CacheControlEphemeral or null`50955096 Create a cache control breakpoint at this content block.50975098 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`50995100 - `DirectCaller object`51015102 Tool invocation directly from the model.51035104 - `ServerToolCaller object`51055106 Tool invocation generated by a server-side tool.51075108 - `ServerToolCaller20260120 object`51095110 - `WebSearchToolResultBlockParam object`51115112 - `type: "web_search_tool_result"`51135114 - `content: WebSearchToolResultBlockParamContent`51155116 - `WebSearchToolResultBlockItem = array of WebSearchResultBlockParam`51175118 - `type: "web_search_result"`51195120 - `encrypted_content: string`51215122 - `title: string`51235124 - `url: string`51255126 - `page_age: optional string or null`51275128 - `WebSearchToolRequestError object`51295130 - `type: "web_search_tool_result_error"`51315132 - `error_code: WebSearchToolResultErrorCode`51335134 - `"invalid_tool_input"`51355136 - `"unavailable"`51375138 - `"max_uses_exceeded"`51395140 - `"too_many_requests"`51415142 - `"query_too_long"`51435144 - `"request_too_large"`51455146 - `tool_use_id: string`51475148 pattern: ^srvtoolu_[a-zA-Z0-9_]+$51495150 - `cache_control: optional CacheControlEphemeral or null`51515152 Create a cache control breakpoint at this content block.51535154 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`51555156 - `DirectCaller object`51575158 Tool invocation directly from the model.51595160 - `ServerToolCaller object`51615162 Tool invocation generated by a server-side tool.51635164 - `ServerToolCaller20260120 object`51655166 - `WebFetchToolResultBlockParam object`51675168 - `type: "web_fetch_tool_result"`51695170 - `content: WebFetchToolResultErrorBlockParam or WebFetchBlockParam`51715172 - `WebFetchToolResultErrorBlockParam object`51735174 - `type: "web_fetch_tool_result_error"`51755176 - `error_code: WebFetchToolResultErrorCode`51775178 - `"invalid_tool_input"`51795180 - `"url_too_long"`51815182 - `"url_not_allowed"`51835184 - `"url_not_in_prior_context"`51855186 - `"url_not_accessible"`51875188 - `"unsupported_content_type"`51895190 - `"too_many_requests"`51915192 - `"max_uses_exceeded"`51935194 - `"unavailable"`51955196 - `"content_too_large"`51975198 - `WebFetchBlockParam object`51995200 - `type: "web_fetch_result"`52015202 - `content: DocumentBlockParam`52035204 - `url: string`52055206 Fetched content URL52075208 - `retrieved_at: optional string or null`52095210 ISO 8601 timestamp when the content was retrieved52115212 - `tool_use_id: string`52135214 pattern: ^srvtoolu_[a-zA-Z0-9_]+$52155216 - `cache_control: optional CacheControlEphemeral or null`52175218 Create a cache control breakpoint at this content block.52195220 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`52215222 - `DirectCaller object`52235224 Tool invocation directly from the model.52255226 - `ServerToolCaller object`52275228 Tool invocation generated by a server-side tool.52295230 - `ServerToolCaller20260120 object`52315232 - `CodeExecutionToolResultBlockParam object`52335234 - `type: "code_execution_tool_result"`52355236 - `content: CodeExecutionToolResultBlockParamContent`52375238 - `CodeExecutionToolResultErrorParam object`52395240 - `type: "code_execution_tool_result_error"`52415242 - `error_code: CodeExecutionToolResultErrorCode`52435244 - `"invalid_tool_input"`52455246 - `"unavailable"`52475248 - `"too_many_requests"`52495250 - `"execution_time_exceeded"`52515252 - `CodeExecutionResultBlockParam object`52535254 - `type: "code_execution_result"`52555256 - `content: array of CodeExecutionOutputBlockParam`52575258 - `type: "code_execution_output"`52595260 - `file_id: string`52615262 - `return_code: number`52635264 - `stderr: string`52655266 - `stdout: string`52675268 - `EncryptedCodeExecutionResultBlockParam object`52695270 Code execution result with encrypted stdout for PFC + web_search results.52715272 - `type: "encrypted_code_execution_result"`52735274 - `content: array of CodeExecutionOutputBlockParam`52755276 - `type: "code_execution_output"`52775278 - `file_id: string`52795280 - `encrypted_stdout: string`52815282 - `return_code: number`52835284 - `stderr: string`52855286 - `tool_use_id: string`52875288 pattern: ^srvtoolu_[a-zA-Z0-9_]+$52895290 - `cache_control: optional CacheControlEphemeral or null`52915292 Create a cache control breakpoint at this content block.52935294 - `BashCodeExecutionToolResultBlockParam object`52955296 - `type: "bash_code_execution_tool_result"`52975298 - `content: BashCodeExecutionToolResultErrorParam or BashCodeExecutionResultBlockParam`52995300 - `BashCodeExecutionToolResultErrorParam object`53015302 - `type: "bash_code_execution_tool_result_error"`53035304 - `error_code: BashCodeExecutionToolResultErrorCode`53055306 - `"invalid_tool_input"`53075308 - `"unavailable"`53095310 - `"too_many_requests"`53115312 - `"execution_time_exceeded"`53135314 - `"output_file_too_large"`53155316 - `BashCodeExecutionResultBlockParam object`53175318 - `type: "bash_code_execution_result"`53195320 - `content: array of BashCodeExecutionOutputBlockParam`53215322 - `type: "bash_code_execution_output"`53235324 - `file_id: string`53255326 - `return_code: number`53275328 - `stderr: string`53295330 - `stdout: string`53315332 - `tool_use_id: string`53335334 pattern: ^srvtoolu_[a-zA-Z0-9_]+$53355336 - `cache_control: optional CacheControlEphemeral or null`53375338 Create a cache control breakpoint at this content block.53395340 - `TextEditorCodeExecutionToolResultBlockParam object`53415342 - `type: "text_editor_code_execution_tool_result"`53435344 - `content: TextEditorCodeExecutionToolResultErrorParam or TextEditorCodeExecutionViewResultBlockParam or TextEditorCodeExecutionCreateResultBlockParam or TextEditorCodeExecutionStrReplaceResultBlockParam`53455346 - `TextEditorCodeExecutionToolResultErrorParam object`53475348 - `type: "text_editor_code_execution_tool_result_error"`53495350 - `error_code: TextEditorCodeExecutionToolResultErrorCode`53515352 - `"invalid_tool_input"`53535354 - `"unavailable"`53555356 - `"too_many_requests"`53575358 - `"execution_time_exceeded"`53595360 - `"file_not_found"`53615362 - `error_message: optional string or null`53635364 - `TextEditorCodeExecutionViewResultBlockParam object`53655366 - `type: "text_editor_code_execution_view_result"`53675368 - `content: string`53695370 - `file_type: "text" or "image" or "pdf"`53715372 - `"text"`53735374 - `"image"`53755376 - `"pdf"`53775378 - `num_lines: optional number or null`53795380 - `start_line: optional number or null`53815382 - `total_lines: optional number or null`53835384 - `TextEditorCodeExecutionCreateResultBlockParam object`53855386 - `type: "text_editor_code_execution_create_result"`53875388 - `is_file_update: boolean`53895390 - `TextEditorCodeExecutionStrReplaceResultBlockParam object`53915392 - `type: "text_editor_code_execution_str_replace_result"`53935394 - `lines: optional array of string or null`53955396 - `new_lines: optional number or null`53975398 - `new_start: optional number or null`53995400 - `old_lines: optional number or null`54015402 - `old_start: optional number or null`54035404 - `tool_use_id: string`54055406 pattern: ^srvtoolu_[a-zA-Z0-9_]+$54075408 - `cache_control: optional CacheControlEphemeral or null`54095410 Create a cache control breakpoint at this content block.54115412 - `ToolSearchToolResultBlockParam object`54135414 - `type: "tool_search_tool_result"`54155416 - `content: ToolSearchToolResultErrorParam or ToolSearchToolSearchResultBlockParam`54175418 - `ToolSearchToolResultErrorParam object`54195420 - `type: "tool_search_tool_result_error"`54215422 - `error_code: ToolSearchToolResultErrorCode`54235424 - `"invalid_tool_input"`54255426 - `"unavailable"`54275428 - `"too_many_requests"`54295430 - `"execution_time_exceeded"`54315432 - `error_message: optional string or null`54335434 - `ToolSearchToolSearchResultBlockParam object`54355436 - `type: "tool_search_tool_search_result"`54375438 - `tool_references: array of ToolReferenceBlockParam`54395440 - `type: "tool_reference"`54415442 - `tool_name: string`54435444 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$54455446 - `cache_control: optional CacheControlEphemeral or null`54475448 Create a cache control breakpoint at this content block.54495450 - `tool_use_id: string`54515452 pattern: ^srvtoolu_[a-zA-Z0-9_]+$54535454 - `cache_control: optional CacheControlEphemeral or null`54555456 Create a cache control breakpoint at this content block.54575458 - `ContainerUploadBlockParam object`54595460 A content block that represents a file to be uploaded to the container5461 Files uploaded via this block will be available in the container's input directory.54625463 - `type: "container_upload"`54645465 - `file_id: string`54665467 - `cache_control: optional CacheControlEphemeral or null`54685469 Create a cache control breakpoint at this content block.54705471 - `role: "user" or "assistant" or "system"`54725473 - `"user"`54745475 - `"assistant"`54765477 - `"system"`54785479- `model: Model`54805481 The model that will complete your prompt.54825483 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.54845485 - `"claude-fable-5-1" or "claude-mythos-5-1" or "claude-sonnet-5" or 14 more`54865487 The model that will complete your prompt.54885489 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.54905491 - `"claude-fable-5-1"`54925493 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows54945495 - `"claude-mythos-5-1"`54965497 Our most capable model for cybersecurity and biology research, available through trusted access programs54985499 - `"claude-sonnet-5"`55005501 High-performance model for coding and agents55025503 - `"claude-fable-5"`55045505 Next generation of intelligence for the hardest knowledge work and coding problems55065507 - `"claude-mythos-5"`55085509 Most capable model for cybersecurity and biology research55105511 - `"claude-opus-5"`55125513 Powerful intelligence for long-running agents and coding55145515 - `"claude-opus-4-8"`55165517 Powerful intelligence for long-running agents and coding55185519 - `"claude-opus-4-7"`55205521 Powerful intelligence for long-running agents and coding55225523 - `"claude-mythos-preview"`55245525 New class of intelligence, strongest in coding and cybersecurity55265527 - `"claude-opus-4-6"`55285529 Powerful intelligence for long-running agents and coding55305531 - `"claude-sonnet-4-6"`55325533 Best combination of speed and intelligence55345535 - `"claude-haiku-4-5"`55365537 Fastest model with near-frontier intelligence55385539 - `"claude-haiku-4-5-20251001"`55405541 Fastest model with near-frontier intelligence55425543 - `"claude-opus-4-5"`55445545 Powerful intelligence for long-running agents and coding55465547 - `"claude-opus-4-5-20251101"`55485549 Powerful intelligence for long-running agents and coding55505551 - `"claude-sonnet-4-5"`55525553 High-performance model for agents and coding55545555 - `"claude-sonnet-4-5-20250929"`55565557 High-performance model for agents and coding55585559 - `string`55605561- `cache_control: optional CacheControlEphemeral or null`55625563 Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.55645565- `output_config: optional OutputConfig`55665567 Configuration options for the model's output, such as the output format.55685569 - `effort: optional "low" or "medium" or "high" or 2 more or null`55705571 All possible effort levels.55725573 - `"low"`55745575 - `"medium"`55765577 - `"high"`55785579 - `"xhigh"`55805581 - `"max"`55825583 - `format: optional JSONOutputFormat or null`55845585 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)55865587 - `type: "json_schema"`55885589 - `schema: map[unknown]`55905591 The JSON schema of the format55925593- `system: optional string or array of TextBlockParam`55945595 System prompt.55965597 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#give-claude-a-role).55985599 - `string`56005601 - `array of TextBlockParam`56025603 - `type: "text"`56045605 - `text: string`56065607 minLength: 156085609 - `cache_control: optional CacheControlEphemeral or null`56105611 Create a cache control breakpoint at this content block.56125613 - `citations: optional array of TextCitationParam or null`56145615- `thinking: optional ThinkingConfigParam`56165617 Configuration for enabling Claude's extended thinking.56185619 When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit.56205621 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.56225623 - `ThinkingConfigEnabled object`56245625 - `type: "enabled"`56265627 - `budget_tokens: number`56285629 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.56305631 Must be ≥1024 and less than `max_tokens`.56325633 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.56345635 minimum: 102456365637 - `display: optional "summarized" or "omitted" or null`56385639 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`.56405641 - `"summarized"`56425643 - `"omitted"`56445645 - `ThinkingConfigDisabled object`56465647 - `type: "disabled"`56485649 - `ThinkingConfigAdaptive object`56505651 - `type: "adaptive"`56525653 - `display: optional "summarized" or "omitted" or null`56545655 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`.56565657 - `"summarized"`56585659 - `"omitted"`56605661- `tool_choice: optional ToolChoice`56625663 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.56645665 - `ToolChoiceAuto object`56665667 The model will automatically decide whether to use tools.56685669 - `type: "auto"`56705671 - `disable_parallel_tool_use: optional boolean`56725673 Whether to disable parallel tool use.56745675 Defaults to `false`. If set to `true`, the model will output at most one tool use.56765677 - `ToolChoiceAny object`56785679 The model will use any available tools.56805681 - `type: "any"`56825683 - `disable_parallel_tool_use: optional boolean`56845685 Whether to disable parallel tool use.56865687 Defaults to `false`. If set to `true`, the model will output exactly one tool use.56885689 - `ToolChoiceTool object`56905691 The model will use the specified tool with `tool_choice.name`.56925693 - `type: "tool"`56945695 - `name: string`56965697 The name of the tool to use.56985699 - `disable_parallel_tool_use: optional boolean`57005701 Whether to disable parallel tool use.57025703 Defaults to `false`. If set to `true`, the model will output exactly one tool use.57045705 - `ToolChoiceNone object`57065707 The model will not be allowed to use tools.57085709 - `type: "none"`57105711- `tools: optional array of MessageCountTokensTool`57125713 Definitions of tools that the model may use.57145715 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.57165717 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), 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)).57185719 Each tool definition includes:57205721 * `name`: Name of the tool.5722 * `description`: Optional, but strongly-recommended description of the tool.5723 * `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.57245725 For example, if you defined `tools` as:57265727 ```json5728 [5729 {5730 "name": "get_stock_price",5731 "description": "Get the current stock price for a given ticker symbol.",5732 "input_schema": {5733 "type": "object",5734 "properties": {5735 "ticker": {5736 "type": "string",5737 "description": "The stock ticker symbol, e.g. AAPL for Apple Inc."5738 }5739 },5740 "required": ["ticker"]5741 }5742 }5743 ]5744 ```57455746 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:57475748 ```json5749 [5750 {5751 "type": "tool_use",5752 "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",5753 "name": "get_stock_price",5754 "input": { "ticker": "^GSPC" }5755 }5756 ]5757 ```57585759 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:57605761 ```json5762 [5763 {5764 "type": "tool_result",5765 "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",5766 "content": "259.75 USD"5767 }5768 ]5769 ```57705771 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.57725773 See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details.57745775 - `Tool object`57765777 - `type: optional "custom" or null`57785779 - `input_schema: object`57805781 [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.57825783 This defines the shape of the `input` that your tool accepts and that the model will produce.57845785 - `type: "object"`57865787 - `properties: optional map[unknown] or null`57885789 - `required: optional array of string or null`57905791 - `name: string`57925793 Name of the tool.57945795 This is how the tool will be called by the model and in `tool_use` blocks.57965797 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$57985799 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`58005801 - `"direct"`58025803 - `"code_execution_20250825"`58045805 - `"code_execution_20260120"`58065807 - `"code_execution_20260521"`58085809 - `cache_control: optional CacheControlEphemeral or null`58105811 Create a cache control breakpoint at this content block.58125813 - `defer_loading: optional boolean`58145815 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.58165817 - `description: optional string`58185819 Description of what this tool does.58205821 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.58225823 - `eager_input_streaming: optional boolean or null`58245825 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.58265827 - `input_examples: optional array of map[unknown]`58285829 - `strict: optional boolean`58305831 When true, guarantees schema validation on tool names and inputs58325833 - `ToolBash20250124 object`58345835 - `type: "bash_20250124"`58365837 - `name: "bash"`58385839 Name of the tool.58405841 This is how the tool will be called by the model and in `tool_use` blocks.58425843 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`58445845 - `"direct"`58465847 - `"code_execution_20250825"`58485849 - `"code_execution_20260120"`58505851 - `"code_execution_20260521"`58525853 - `cache_control: optional CacheControlEphemeral or null`58545855 Create a cache control breakpoint at this content block.58565857 - `defer_loading: optional boolean`58585859 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.58605861 - `input_examples: optional array of map[unknown]`58625863 - `strict: optional boolean`58645865 When true, guarantees schema validation on tool names and inputs58665867 - `CodeExecutionTool20250522 object`58685869 - `type: "code_execution_20250522"`58705871 - `name: "code_execution"`58725873 Name of the tool.58745875 This is how the tool will be called by the model and in `tool_use` blocks.58765877 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`58785879 - `"direct"`58805881 - `"code_execution_20250825"`58825883 - `"code_execution_20260120"`58845885 - `"code_execution_20260521"`58865887 - `cache_control: optional CacheControlEphemeral or null`58885889 Create a cache control breakpoint at this content block.58905891 - `defer_loading: optional boolean`58925893 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.58945895 - `strict: optional boolean`58965897 When true, guarantees schema validation on tool names and inputs58985899 - `CodeExecutionTool20250825 object`59005901 - `type: "code_execution_20250825"`59025903 - `name: "code_execution"`59045905 Name of the tool.59065907 This is how the tool will be called by the model and in `tool_use` blocks.59085909 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`59105911 - `"direct"`59125913 - `"code_execution_20250825"`59145915 - `"code_execution_20260120"`59165917 - `"code_execution_20260521"`59185919 - `cache_control: optional CacheControlEphemeral or null`59205921 Create a cache control breakpoint at this content block.59225923 - `defer_loading: optional boolean`59245925 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.59265927 - `strict: optional boolean`59285929 When true, guarantees schema validation on tool names and inputs59305931 - `CodeExecutionTool20260120 object`59325933 Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).59345935 - `type: "code_execution_20260120"`59365937 - `name: "code_execution"`59385939 Name of the tool.59405941 This is how the tool will be called by the model and in `tool_use` blocks.59425943 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`59445945 - `"direct"`59465947 - `"code_execution_20250825"`59485949 - `"code_execution_20260120"`59505951 - `"code_execution_20260521"`59525953 - `cache_control: optional CacheControlEphemeral or null`59545955 Create a cache control breakpoint at this content block.59565957 - `defer_loading: optional boolean`59585959 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.59605961 - `strict: optional boolean`59625963 When true, guarantees schema validation on tool names and inputs59645965 - `CodeExecutionTool20260521 object`59665967 Code execution tool with REPL state persistence.59685969 - `type: "code_execution_20260521"`59705971 - `name: "code_execution"`59725973 Name of the tool.59745975 This is how the tool will be called by the model and in `tool_use` blocks.59765977 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`59785979 - `"direct"`59805981 - `"code_execution_20250825"`59825983 - `"code_execution_20260120"`59845985 - `"code_execution_20260521"`59865987 - `cache_control: optional CacheControlEphemeral or null`59885989 Create a cache control breakpoint at this content block.59905991 - `defer_loading: optional boolean`59925993 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.59945995 - `strict: optional boolean`59965997 When true, guarantees schema validation on tool names and inputs59985999 - `BrowserToolset20260801 object`60006001 The browser toolset: a single `tools[]` entry (carrying no6002 `name`) that declares the browser tool family. The model is served6003 the family's tool with any members disabled via `configs` removed6004 from its schema.60056006 - `type: "browser_toolset_20260801"`60076008 - `cache_control: optional CacheControlEphemeral or null`60096010 Create a cache control breakpoint at this content block.60116012 - `configs: optional BrowserToolsetConfigs or null`60136014 Per-member configuration for `browser_toolset_20260801`: one6015 optional field per member tool, keyed by the member name — the same6016 name the member's `tool_use` blocks carry. Every member is an6017 accepted key, and a member's defaults apply wherever its key is6018 absent. Unknown keys are rejected: the field set is this toolset6019 version's complete member set.60206021 - `type: optional BrowserTypeConfig or null`60226023 `type`'s config overrides.60246025 - `defer_loading: optional boolean or null`60266027 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.60286029 - `enabled: optional boolean or null`60306031 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.60326033 - `close_tab: optional BrowserCloseTabConfig or null`60346035 `close_tab`'s config overrides.60366037 - `defer_loading: optional boolean or null`60386039 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.60406041 - `enabled: optional boolean or null`60426043 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.60446045 - `double_click: optional BrowserDoubleClickConfig or null`60466047 `double_click`'s config overrides.60486049 - `defer_loading: optional boolean or null`60506051 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.60526053 - `enabled: optional boolean or null`60546055 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.60566057 - `file_upload: optional BrowserFileUploadConfig or null`60586059 `file_upload`'s config overrides.60606061 - `defer_loading: optional boolean or null`60626063 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.60646065 - `enabled: optional boolean or null`60666067 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.60686069 - `find: optional BrowserFindConfig or null`60706071 `find`'s config overrides.60726073 - `defer_loading: optional boolean or null`60746075 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.60766077 - `enabled: optional boolean or null`60786079 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.60806081 - `form_input: optional BrowserFormInputConfig or null`60826083 `form_input`'s config overrides.60846085 - `defer_loading: optional boolean or null`60866087 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.60886089 - `enabled: optional boolean or null`60906091 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.60926093 - `get_page_text: optional BrowserGetPageTextConfig or null`60946095 `get_page_text`'s config overrides.60966097 - `defer_loading: optional boolean or null`60986099 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.61006101 - `enabled: optional boolean or null`61026103 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.61046105 - `hold_key: optional BrowserHoldKeyConfig or null`61066107 `hold_key`'s config overrides.61086109 - `defer_loading: optional boolean or null`61106111 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.61126113 - `enabled: optional boolean or null`61146115 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.61166117 - `hover: optional BrowserHoverConfig or null`61186119 `hover`'s config overrides.61206121 - `defer_loading: optional boolean or null`61226123 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.61246125 - `enabled: optional boolean or null`61266127 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.61286129 - `javascript_exec: optional BrowserJavascriptExecConfig or null`61306131 `javascript_exec`'s config overrides.61326133 - `defer_loading: optional boolean or null`61346135 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.61366137 - `enabled: optional boolean or null`61386139 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.61406141 - `key: optional BrowserKeyConfig or null`61426143 `key`'s config overrides.61446145 - `defer_loading: optional boolean or null`61466147 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.61486149 - `enabled: optional boolean or null`61506151 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.61526153 - `left_click: optional BrowserLeftClickConfig or null`61546155 `left_click`'s config overrides.61566157 - `defer_loading: optional boolean or null`61586159 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.61606161 - `enabled: optional boolean or null`61626163 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.61646165 - `left_click_drag: optional BrowserLeftClickDragConfig or null`61666167 `left_click_drag`'s config overrides.61686169 - `defer_loading: optional boolean or null`61706171 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.61726173 - `enabled: optional boolean or null`61746175 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.61766177 - `left_mouse_down: optional BrowserLeftMouseDownConfig or null`61786179 `left_mouse_down`'s config overrides.61806181 - `defer_loading: optional boolean or null`61826183 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.61846185 - `enabled: optional boolean or null`61866187 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.61886189 - `left_mouse_up: optional BrowserLeftMouseUpConfig or null`61906191 `left_mouse_up`'s config overrides.61926193 - `defer_loading: optional boolean or null`61946195 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.61966197 - `enabled: optional boolean or null`61986199 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.62006201 - `list_tabs: optional BrowserListTabsConfig or null`62026203 `list_tabs`'s config overrides.62046205 - `defer_loading: optional boolean or null`62066207 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.62086209 - `enabled: optional boolean or null`62106211 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.62126213 - `middle_click: optional BrowserMiddleClickConfig or null`62146215 `middle_click`'s config overrides.62166217 - `defer_loading: optional boolean or null`62186219 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.62206221 - `enabled: optional boolean or null`62226223 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.62246225 - `mouse_move: optional BrowserMouseMoveConfig or null`62266227 `mouse_move`'s config overrides.62286229 - `defer_loading: optional boolean or null`62306231 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.62326233 - `enabled: optional boolean or null`62346235 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.62366237 - `navigate: optional BrowserNavigateConfig or null`62386239 `navigate`'s config overrides.62406241 - `defer_loading: optional boolean or null`62426243 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.62446245 - `enabled: optional boolean or null`62466247 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.62486249 - `new_tab: optional BrowserNewTabConfig or null`62506251 `new_tab`'s config overrides.62526253 - `defer_loading: optional boolean or null`62546255 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.62566257 - `enabled: optional boolean or null`62586259 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.62606261 - `read_console: optional BrowserReadConsoleConfig or null`62626263 `read_console`'s config overrides.62646265 - `defer_loading: optional boolean or null`62666267 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.62686269 - `enabled: optional boolean or null`62706271 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.62726273 - `read_network: optional BrowserReadNetworkConfig or null`62746275 `read_network`'s config overrides.62766277 - `defer_loading: optional boolean or null`62786279 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.62806281 - `enabled: optional boolean or null`62826283 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.62846285 - `read_page: optional BrowserReadPageConfig or null`62866287 `read_page`'s config overrides.62886289 - `defer_loading: optional boolean or null`62906291 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.62926293 - `enabled: optional boolean or null`62946295 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.62966297 - `right_click: optional BrowserRightClickConfig or null`62986299 `right_click`'s config overrides.63006301 - `defer_loading: optional boolean or null`63026303 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.63046305 - `enabled: optional boolean or null`63066307 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.63086309 - `screenshot: optional BrowserScreenshotConfig or null`63106311 `screenshot`'s config overrides.63126313 - `defer_loading: optional boolean or null`63146315 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.63166317 - `enabled: optional boolean or null`63186319 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.63206321 - `scroll: optional BrowserScrollConfig or null`63226323 `scroll`'s config overrides.63246325 - `defer_loading: optional boolean or null`63266327 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.63286329 - `enabled: optional boolean or null`63306331 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.63326333 - `scroll_to: optional BrowserScrollToConfig or null`63346335 `scroll_to`'s config overrides.63366337 - `defer_loading: optional boolean or null`63386339 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.63406341 - `enabled: optional boolean or null`63426343 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.63446345 - `switch_tab: optional BrowserSwitchTabConfig or null`63466347 `switch_tab`'s config overrides.63486349 - `defer_loading: optional boolean or null`63506351 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.63526353 - `enabled: optional boolean or null`63546355 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.63566357 - `triple_click: optional BrowserTripleClickConfig or null`63586359 `triple_click`'s config overrides.63606361 - `defer_loading: optional boolean or null`63626363 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.63646365 - `enabled: optional boolean or null`63666367 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.63686369 - `wait: optional BrowserWaitConfig or null`63706371 `wait`'s config overrides.63726373 - `defer_loading: optional boolean or null`63746375 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.63766377 - `enabled: optional boolean or null`63786379 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.63806381 - `zoom: optional BrowserZoomConfig or null`63826383 `zoom`'s config overrides.63846385 - `defer_loading: optional boolean or null`63866387 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.63886389 - `enabled: optional boolean or null`63906391 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.63926393 - `MemoryTool20250818 object`63946395 - `type: "memory_20250818"`63966397 - `name: "memory"`63986399 Name of the tool.64006401 This is how the tool will be called by the model and in `tool_use` blocks.64026403 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`64046405 - `"direct"`64066407 - `"code_execution_20250825"`64086409 - `"code_execution_20260120"`64106411 - `"code_execution_20260521"`64126413 - `cache_control: optional CacheControlEphemeral or null`64146415 Create a cache control breakpoint at this content block.64166417 - `defer_loading: optional boolean`64186419 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.64206421 - `input_examples: optional array of map[unknown]`64226423 - `strict: optional boolean`64246425 When true, guarantees schema validation on tool names and inputs64266427 - `ComputerToolset20260801 object`64286429 The computer toolset: a single `tools[]` entry (carrying no6430 `name`) that declares the computer tool family. The model is6431 served the family's tool with any members disabled via `configs`6432 removed from its schema. Every member is enabled by default, zoom6433 included. The single-tool options `display_number` and6434 `enable_zoom` are not fields of a toolset entry — it carries only6435 `type`, `configs`, and `cache_control`; zoom is controlled6436 via `configs.zoom.enabled`.64376438 - `type: "computer_toolset_20260801"`64396440 - `cache_control: optional CacheControlEphemeral or null`64416442 Create a cache control breakpoint at this content block.64436444 - `configs: optional ComputerToolsetConfigs or null`64456446 Per-member configuration for `computer_toolset_20260801`: one6447 optional field per member tool, keyed by the member name — the same6448 name the member's `tool_use` blocks carry. Every member is an6449 accepted key, and a member's defaults apply wherever its key is6450 absent. Unknown keys are rejected: the field set is this toolset6451 version's complete member set.64526453 - `type: optional ComputerTypeConfig or null`64546455 `type`'s config overrides.64566457 - `defer_loading: optional boolean or null`64586459 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.64606461 - `enabled: optional boolean or null`64626463 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.64646465 - `cursor_position: optional ComputerCursorPositionConfig or null`64666467 `cursor_position`'s config overrides.64686469 - `defer_loading: optional boolean or null`64706471 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.64726473 - `enabled: optional boolean or null`64746475 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.64766477 - `double_click: optional ComputerDoubleClickConfig or null`64786479 `double_click`'s config overrides.64806481 - `defer_loading: optional boolean or null`64826483 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.64846485 - `enabled: optional boolean or null`64866487 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.64886489 - `hold_key: optional ComputerHoldKeyConfig or null`64906491 `hold_key`'s config overrides.64926493 - `defer_loading: optional boolean or null`64946495 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.64966497 - `enabled: optional boolean or null`64986499 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.65006501 - `key: optional ComputerKeyConfig or null`65026503 `key`'s config overrides.65046505 - `defer_loading: optional boolean or null`65066507 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.65086509 - `enabled: optional boolean or null`65106511 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.65126513 - `left_click: optional ComputerLeftClickConfig or null`65146515 `left_click`'s config overrides.65166517 - `defer_loading: optional boolean or null`65186519 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.65206521 - `enabled: optional boolean or null`65226523 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.65246525 - `left_click_drag: optional ComputerLeftClickDragConfig or null`65266527 `left_click_drag`'s config overrides.65286529 - `defer_loading: optional boolean or null`65306531 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.65326533 - `enabled: optional boolean or null`65346535 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.65366537 - `left_mouse_down: optional ComputerLeftMouseDownConfig or null`65386539 `left_mouse_down`'s config overrides.65406541 - `defer_loading: optional boolean or null`65426543 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.65446545 - `enabled: optional boolean or null`65466547 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.65486549 - `left_mouse_up: optional ComputerLeftMouseUpConfig or null`65506551 `left_mouse_up`'s config overrides.65526553 - `defer_loading: optional boolean or null`65546555 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.65566557 - `enabled: optional boolean or null`65586559 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.65606561 - `middle_click: optional ComputerMiddleClickConfig or null`65626563 `middle_click`'s config overrides.65646565 - `defer_loading: optional boolean or null`65666567 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.65686569 - `enabled: optional boolean or null`65706571 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.65726573 - `mouse_move: optional ComputerMouseMoveConfig or null`65746575 `mouse_move`'s config overrides.65766577 - `defer_loading: optional boolean or null`65786579 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.65806581 - `enabled: optional boolean or null`65826583 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.65846585 - `right_click: optional ComputerRightClickConfig or null`65866587 `right_click`'s config overrides.65886589 - `defer_loading: optional boolean or null`65906591 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.65926593 - `enabled: optional boolean or null`65946595 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.65966597 - `screenshot: optional ComputerScreenshotConfig or null`65986599 `screenshot`'s config overrides.66006601 - `defer_loading: optional boolean or null`66026603 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.66046605 - `enabled: optional boolean or null`66066607 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.66086609 - `scroll: optional ComputerScrollConfig or null`66106611 `scroll`'s config overrides.66126613 - `defer_loading: optional boolean or null`66146615 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.66166617 - `enabled: optional boolean or null`66186619 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.66206621 - `triple_click: optional ComputerTripleClickConfig or null`66226623 `triple_click`'s config overrides.66246625 - `defer_loading: optional boolean or null`66266627 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.66286629 - `enabled: optional boolean or null`66306631 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.66326633 - `wait: optional ComputerWaitConfig or null`66346635 `wait`'s config overrides.66366637 - `defer_loading: optional boolean or null`66386639 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.66406641 - `enabled: optional boolean or null`66426643 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.66446645 - `zoom: optional ComputerZoomConfig or null`66466647 `zoom`'s config overrides.66486649 - `defer_loading: optional boolean or null`66506651 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.66526653 - `enabled: optional boolean or null`66546655 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.66566657 - `ToolTextEditor20250124 object`66586659 - `type: "text_editor_20250124"`66606661 - `name: "str_replace_editor"`66626663 Name of the tool.66646665 This is how the tool will be called by the model and in `tool_use` blocks.66666667 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`66686669 - `"direct"`66706671 - `"code_execution_20250825"`66726673 - `"code_execution_20260120"`66746675 - `"code_execution_20260521"`66766677 - `cache_control: optional CacheControlEphemeral or null`66786679 Create a cache control breakpoint at this content block.66806681 - `defer_loading: optional boolean`66826683 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.66846685 - `input_examples: optional array of map[unknown]`66866687 - `strict: optional boolean`66886689 When true, guarantees schema validation on tool names and inputs66906691 - `ToolTextEditor20250429 object`66926693 - `type: "text_editor_20250429"`66946695 - `name: "str_replace_based_edit_tool"`66966697 Name of the tool.66986699 This is how the tool will be called by the model and in `tool_use` blocks.67006701 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`67026703 - `"direct"`67046705 - `"code_execution_20250825"`67066707 - `"code_execution_20260120"`67086709 - `"code_execution_20260521"`67106711 - `cache_control: optional CacheControlEphemeral or null`67126713 Create a cache control breakpoint at this content block.67146715 - `defer_loading: optional boolean`67166717 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.67186719 - `input_examples: optional array of map[unknown]`67206721 - `strict: optional boolean`67226723 When true, guarantees schema validation on tool names and inputs67246725 - `ToolTextEditor20250728 object`67266727 - `type: "text_editor_20250728"`67286729 - `name: "str_replace_based_edit_tool"`67306731 Name of the tool.67326733 This is how the tool will be called by the model and in `tool_use` blocks.67346735 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`67366737 - `"direct"`67386739 - `"code_execution_20250825"`67406741 - `"code_execution_20260120"`67426743 - `"code_execution_20260521"`67446745 - `cache_control: optional CacheControlEphemeral or null`67466747 Create a cache control breakpoint at this content block.67486749 - `defer_loading: optional boolean`67506751 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.67526753 - `input_examples: optional array of map[unknown]`67546755 - `max_characters: optional number or null`67566757 Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.67586759 minimum: 167606761 - `strict: optional boolean`67626763 When true, guarantees schema validation on tool names and inputs67646765 - `WebSearchTool20250305 object`67666767 - `type: "web_search_20250305"`67686769 - `name: "web_search"`67706771 Name of the tool.67726773 This is how the tool will be called by the model and in `tool_use` blocks.67746775 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`67766777 - `"direct"`67786779 - `"code_execution_20250825"`67806781 - `"code_execution_20260120"`67826783 - `"code_execution_20260521"`67846785 - `allowed_domains: optional array of string or null`67866787 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.67886789 - `blocked_domains: optional array of string or null`67906791 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.67926793 - `cache_control: optional CacheControlEphemeral or null`67946795 Create a cache control breakpoint at this content block.67966797 - `defer_loading: optional boolean`67986799 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.68006801 - `max_uses: optional number or null`68026803 Maximum number of times the tool can be used in the API request.68046805 exclusiveMinimum: 068066807 - `strict: optional boolean`68086809 When true, guarantees schema validation on tool names and inputs68106811 - `user_location: optional UserLocation or null`68126813 Parameters for the user's location. Used to provide more relevant search results.68146815 - `type: "approximate"`68166817 - `city: optional string or null`68186819 The city of the user.68206821 maxLength: 255, minLength: 168226823 - `country: optional string or null`68246825 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.68266827 maxLength: 2, minLength: 268286829 - `region: optional string or null`68306831 The region of the user.68326833 maxLength: 255, minLength: 168346835 - `timezone: optional string or null`68366837 The [IANA timezone](https://nodatime.org/TimeZones) of the user.68386839 maxLength: 255, minLength: 168406841 - `WebFetchTool20250910 object`68426843 - `type: "web_fetch_20250910"`68446845 - `name: "web_fetch"`68466847 Name of the tool.68486849 This is how the tool will be called by the model and in `tool_use` blocks.68506851 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`68526853 - `"direct"`68546855 - `"code_execution_20250825"`68566857 - `"code_execution_20260120"`68586859 - `"code_execution_20260521"`68606861 - `allowed_domains: optional array of string or null`68626863 List of domains to allow fetching from68646865 - `blocked_domains: optional array of string or null`68666867 List of domains to block fetching from68686869 - `cache_control: optional CacheControlEphemeral or null`68706871 Create a cache control breakpoint at this content block.68726873 - `citations: optional CitationsConfigParam or null`68746875 Citations configuration for fetched documents. Citations are disabled by default.68766877 - `defer_loading: optional boolean`68786879 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.68806881 - `max_content_tokens: optional number or null`68826883 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.68846885 exclusiveMinimum: 068866887 - `max_uses: optional number or null`68886889 Maximum number of times the tool can be used in the API request.68906891 exclusiveMinimum: 068926893 - `strict: optional boolean`68946895 When true, guarantees schema validation on tool names and inputs68966897 - `url_sources: optional WebFetchURLSources or null`68986899 Which sources contribute to the set of URLs web fetch may fetch.69006901 Each key is a tagged variant: `user_input` is `all` or `none`; the6902 two tool filters are `all`, `none`, `only` (only the named tools'6903 results) or `except` (every result but the named tools'). A named tool6904 must be declared in this request's `tools[]`.69056906 - `client_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`69076908 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].69096910 - `WebFetchURLSourceAll object`69116912 The `url_sources` variant under which a source contributes in6913 full: every result of the tool filter's source, or all user input.69146915 - `type: "all"`69166917 - `WebFetchURLSourceNone object`69186919 The `url_sources` variant under which a source contributes nothing:6920 no result of the tool filter's source, or no user input.69216922 - `type: "none"`69236924 - `WebFetchURLSourceOnly object`69256926 The tool filter variant under which only the named tools' results6927 contribute.69286929 - `type: "only"`69306931 - `tools: array of WebFetchURLSourceToolReference`69326933 - `type: "tool_reference"`69346935 - `name: string`69366937 - `WebFetchURLSourceExcept object`69386939 The tool filter variant under which every result but the named6940 tools' contributes.69416942 - `type: "except"`69436944 - `tools: array of WebFetchURLSourceToolReference`69456946 - `type: "tool_reference"`69476948 - `name: string`69496950 - `server_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`69516952 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.69536954 - `WebFetchURLSourceAll object`69556956 The `url_sources` variant under which a source contributes in6957 full: every result of the tool filter's source, or all user input.69586959 - `WebFetchURLSourceNone object`69606961 The `url_sources` variant under which a source contributes nothing:6962 no result of the tool filter's source, or no user input.69636964 - `WebFetchURLSourceOnly object`69656966 The tool filter variant under which only the named tools' results6967 contribute.69686969 - `WebFetchURLSourceExcept object`69706971 The tool filter variant under which every result but the named6972 tools' contributes.69736974 - `user_input: optional WebFetchURLSourceAll or WebFetchURLSourceNone`69756976 Whether URLs in user messages are fetchable: "all" or "none".69776978 - `WebFetchURLSourceAll object`69796980 The `url_sources` variant under which a source contributes in6981 full: every result of the tool filter's source, or all user input.69826983 - `WebFetchURLSourceNone object`69846985 The `url_sources` variant under which a source contributes nothing:6986 no result of the tool filter's source, or no user input.69876988 - `WebSearchTool20260209 object`69896990 - `type: "web_search_20260209"`69916992 - `name: "web_search"`69936994 Name of the tool.69956996 This is how the tool will be called by the model and in `tool_use` blocks.69976998 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`69997000 - `"direct"`70017002 - `"code_execution_20250825"`70037004 - `"code_execution_20260120"`70057006 - `"code_execution_20260521"`70077008 - `allowed_domains: optional array of string or null`70097010 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.70117012 - `blocked_domains: optional array of string or null`70137014 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.70157016 - `cache_control: optional CacheControlEphemeral or null`70177018 Create a cache control breakpoint at this content block.70197020 - `defer_loading: optional boolean`70217022 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.70237024 - `max_uses: optional number or null`70257026 Maximum number of times the tool can be used in the API request.70277028 exclusiveMinimum: 070297030 - `strict: optional boolean`70317032 When true, guarantees schema validation on tool names and inputs70337034 - `user_location: optional UserLocation or null`70357036 Parameters for the user's location. Used to provide more relevant search results.70377038 - `WebFetchTool20260209 object`70397040 - `type: "web_fetch_20260209"`70417042 - `name: "web_fetch"`70437044 Name of the tool.70457046 This is how the tool will be called by the model and in `tool_use` blocks.70477048 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`70497050 - `"direct"`70517052 - `"code_execution_20250825"`70537054 - `"code_execution_20260120"`70557056 - `"code_execution_20260521"`70577058 - `allowed_domains: optional array of string or null`70597060 List of domains to allow fetching from70617062 - `blocked_domains: optional array of string or null`70637064 List of domains to block fetching from70657066 - `cache_control: optional CacheControlEphemeral or null`70677068 Create a cache control breakpoint at this content block.70697070 - `citations: optional CitationsConfigParam or null`70717072 Citations configuration for fetched documents. Citations are disabled by default.70737074 - `defer_loading: optional boolean`70757076 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.70777078 - `max_content_tokens: optional number or null`70797080 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.70817082 exclusiveMinimum: 070837084 - `max_uses: optional number or null`70857086 Maximum number of times the tool can be used in the API request.70877088 exclusiveMinimum: 070897090 - `strict: optional boolean`70917092 When true, guarantees schema validation on tool names and inputs70937094 - `url_sources: optional WebFetchURLSources or null`70957096 Which sources contribute to the set of URLs web fetch may fetch.70977098 Each key is a tagged variant: `user_input` is `all` or `none`; the7099 two tool filters are `all`, `none`, `only` (only the named tools'7100 results) or `except` (every result but the named tools'). A named tool7101 must be declared in this request's `tools[]`.71027103 - `WebFetchTool20260309 object`71047105 Web fetch tool with use_cache parameter for bypassing cached content.71067107 - `type: "web_fetch_20260309"`71087109 - `name: "web_fetch"`71107111 Name of the tool.71127113 This is how the tool will be called by the model and in `tool_use` blocks.71147115 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`71167117 - `"direct"`71187119 - `"code_execution_20250825"`71207121 - `"code_execution_20260120"`71227123 - `"code_execution_20260521"`71247125 - `allowed_domains: optional array of string or null`71267127 List of domains to allow fetching from71287129 - `blocked_domains: optional array of string or null`71307131 List of domains to block fetching from71327133 - `cache_control: optional CacheControlEphemeral or null`71347135 Create a cache control breakpoint at this content block.71367137 - `citations: optional CitationsConfigParam or null`71387139 Citations configuration for fetched documents. Citations are disabled by default.71407141 - `defer_loading: optional boolean`71427143 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.71447145 - `max_content_tokens: optional number or null`71467147 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.71487149 exclusiveMinimum: 071507151 - `max_uses: optional number or null`71527153 Maximum number of times the tool can be used in the API request.71547155 exclusiveMinimum: 071567157 - `strict: optional boolean`71587159 When true, guarantees schema validation on tool names and inputs71607161 - `url_sources: optional WebFetchURLSources or null`71627163 Which sources contribute to the set of URLs web fetch may fetch.71647165 Each key is a tagged variant: `user_input` is `all` or `none`; the7166 two tool filters are `all`, `none`, `only` (only the named tools'7167 results) or `except` (every result but the named tools'). A named tool7168 must be declared in this request's `tools[]`.71697170 - `use_cache: optional boolean`71717172 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.71737174 - `WebSearchTool20260318 object`71757176 - `type: "web_search_20260318"`71777178 - `name: "web_search"`71797180 Name of the tool.71817182 This is how the tool will be called by the model and in `tool_use` blocks.71837184 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`71857186 - `"direct"`71877188 - `"code_execution_20250825"`71897190 - `"code_execution_20260120"`71917192 - `"code_execution_20260521"`71937194 - `allowed_domains: optional array of string or null`71957196 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.71977198 - `blocked_domains: optional array of string or null`71997200 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.72017202 - `cache_control: optional CacheControlEphemeral or null`72037204 Create a cache control breakpoint at this content block.72057206 - `defer_loading: optional boolean`72077208 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.72097210 - `max_uses: optional number or null`72117212 Maximum number of times the tool can be used in the API request.72137214 exclusiveMinimum: 072157216 - `response_inclusion: optional "full" or "excluded"`72177218 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.72197220 - `"full"`72217222 - `"excluded"`72237224 - `strict: optional boolean`72257226 When true, guarantees schema validation on tool names and inputs72277228 - `user_location: optional UserLocation or null`72297230 Parameters for the user's location. Used to provide more relevant search results.72317232 - `WebFetchTool20260318 object`72337234 - `type: "web_fetch_20260318"`72357236 - `name: "web_fetch"`72377238 Name of the tool.72397240 This is how the tool will be called by the model and in `tool_use` blocks.72417242 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`72437244 - `"direct"`72457246 - `"code_execution_20250825"`72477248 - `"code_execution_20260120"`72497250 - `"code_execution_20260521"`72517252 - `allowed_domains: optional array of string or null`72537254 List of domains to allow fetching from72557256 - `blocked_domains: optional array of string or null`72577258 List of domains to block fetching from72597260 - `cache_control: optional CacheControlEphemeral or null`72617262 Create a cache control breakpoint at this content block.72637264 - `citations: optional CitationsConfigParam or null`72657266 Citations configuration for fetched documents. Citations are disabled by default.72677268 - `defer_loading: optional boolean`72697270 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.72717272 - `max_content_tokens: optional number or null`72737274 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.72757276 exclusiveMinimum: 072777278 - `max_uses: optional number or null`72797280 Maximum number of times the tool can be used in the API request.72817282 exclusiveMinimum: 072837284 - `response_inclusion: optional "full" or "excluded"`72857286 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.72877288 - `"full"`72897290 - `"excluded"`72917292 - `strict: optional boolean`72937294 When true, guarantees schema validation on tool names and inputs72957296 - `url_sources: optional WebFetchURLSources or null`72977298 Which sources contribute to the set of URLs web fetch may fetch.72997300 Each key is a tagged variant: `user_input` is `all` or `none`; the7301 two tool filters are `all`, `none`, `only` (only the named tools'7302 results) or `except` (every result but the named tools'). A named tool7303 must be declared in this request's `tools[]`.73047305 - `use_cache: optional boolean`73067307 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.73087309 - `ToolSearchToolBm25_20251119 object`73107311 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`73127313 - `"tool_search_tool_bm25_20251119"`73147315 - `"tool_search_tool_bm25"`73167317 - `name: "tool_search_tool_bm25"`73187319 Name of the tool.73207321 This is how the tool will be called by the model and in `tool_use` blocks.73227323 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`73247325 - `"direct"`73267327 - `"code_execution_20250825"`73287329 - `"code_execution_20260120"`73307331 - `"code_execution_20260521"`73327333 - `cache_control: optional CacheControlEphemeral or null`73347335 Create a cache control breakpoint at this content block.73367337 - `defer_loading: optional boolean`73387339 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.73407341 - `strict: optional boolean`73427343 When true, guarantees schema validation on tool names and inputs73447345 - `ToolSearchToolRegex20251119 object`73467347 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`73487349 - `"tool_search_tool_regex_20251119"`73507351 - `"tool_search_tool_regex"`73527353 - `name: "tool_search_tool_regex"`73547355 Name of the tool.73567357 This is how the tool will be called by the model and in `tool_use` blocks.73587359 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`73607361 - `"direct"`73627363 - `"code_execution_20250825"`73647365 - `"code_execution_20260120"`73667367 - `"code_execution_20260521"`73687369 - `cache_control: optional CacheControlEphemeral or null`73707371 Create a cache control breakpoint at this content block.73727373 - `defer_loading: optional boolean`73747375 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.73767377 - `strict: optional boolean`73787379 When true, guarantees schema validation on tool names and inputs73807381### Returns73827383- `MessageTokensCount object`73847385 - `input_tokens: number`73867387 The total number of tokens across the provided list of messages, system prompt, and tools.73887389### Example73907391```bash7392curl https://api.anthropic.com/v1/messages/count_tokens \7393 -H 'Content-Type: application/json' \7394 -H 'anthropic-version: 2023-06-01' \7395 -H "X-Api-Key: $ANTHROPIC_API_KEY" \7396 -d '{7397 "messages": [7398 {7399 "content": "Hello, world",7400 "role": "user"7401 }7402 ],7403 "model": "claude-opus-5",7404 "system": [7405 {7406 "text": "Today'\''s date is 2024-06-01.",7407 "type": "text"7408 }7409 ],7410 "thinking": {7411 "type": "adaptive"7412 },7413 "tools": [7414 {7415 "input_schema": {7416 "type": "object",7417 "properties": {7418 "location": "bar",7419 "unit": "bar"7420 },7421 "required": [7422 "location"7423 ]7424 },7425 "name": "name"7426 }7427 ]7428 }'7429```74307431#### Response (200)74327433```json7434{7435 "input_tokens": 20957436}7437```74387439## Domain types74407441### Base64 Image Source74427443- `Base64ImageSource object`74447445 - `type: "base64"`74467447 - `data: string`74487449 format: byte74507451 - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"`74527453 - `"image/jpeg"`74547455 - `"image/png"`74567457 - `"image/gif"`74587459 - `"image/webp"`74607461### Base64 PDF Source74627463- `Base64PDFSource object`74647465 - `type: "base64"`74667467 - `data: string`74687469 format: byte74707471 - `media_type: "application/pdf"`74727473### Bash Code Execution Output Block74747475- `BashCodeExecutionOutputBlock object`74767477 - `type: "bash_code_execution_output"`74787479 default: bash_code_execution_output74807481 - `file_id: string`74827483### Bash Code Execution Output Block Param74847485- `BashCodeExecutionOutputBlockParam object`74867487 - `type: "bash_code_execution_output"`74887489 - `file_id: string`74907491### Bash Code Execution Result Block74927493- `BashCodeExecutionResultBlock object`74947495 - `type: "bash_code_execution_result"`74967497 default: bash_code_execution_result74987499 - `content: array of BashCodeExecutionOutputBlock`75007501 - `type: "bash_code_execution_output"`75027503 default: bash_code_execution_output75047505 - `file_id: string`75067507 - `return_code: number`75087509 - `stderr: string`75107511 - `stdout: string`75127513### Bash Code Execution Result Block Param75147515- `BashCodeExecutionResultBlockParam object`75167517 - `type: "bash_code_execution_result"`75187519 - `content: array of BashCodeExecutionOutputBlockParam`75207521 - `type: "bash_code_execution_output"`75227523 - `file_id: string`75247525 - `return_code: number`75267527 - `stderr: string`75287529 - `stdout: string`75307531### Bash Code Execution Tool Result Block75327533- `BashCodeExecutionToolResultBlock object`75347535 - `type: "bash_code_execution_tool_result"`75367537 default: bash_code_execution_tool_result75387539 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`75407541 - `BashCodeExecutionToolResultError object`75427543 - `type: "bash_code_execution_tool_result_error"`75447545 default: bash_code_execution_tool_result_error75467547 - `error_code: BashCodeExecutionToolResultErrorCode`75487549 - `"invalid_tool_input"`75507551 - `"unavailable"`75527553 - `"too_many_requests"`75547555 - `"execution_time_exceeded"`75567557 - `"output_file_too_large"`75587559 - `BashCodeExecutionResultBlock object`75607561 - `type: "bash_code_execution_result"`75627563 default: bash_code_execution_result75647565 - `content: array of BashCodeExecutionOutputBlock`75667567 - `type: "bash_code_execution_output"`75687569 default: bash_code_execution_output75707571 - `file_id: string`75727573 - `return_code: number`75747575 - `stderr: string`75767577 - `stdout: string`75787579 - `tool_use_id: string`75807581 pattern: ^srvtoolu_[a-zA-Z0-9_]+$75827583### Bash Code Execution Tool Result Block Param75847585- `BashCodeExecutionToolResultBlockParam object`75867587 - `type: "bash_code_execution_tool_result"`75887589 - `content: BashCodeExecutionToolResultErrorParam or BashCodeExecutionResultBlockParam`75907591 - `BashCodeExecutionToolResultErrorParam object`75927593 - `type: "bash_code_execution_tool_result_error"`75947595 - `error_code: BashCodeExecutionToolResultErrorCode`75967597 - `"invalid_tool_input"`75987599 - `"unavailable"`76007601 - `"too_many_requests"`76027603 - `"execution_time_exceeded"`76047605 - `"output_file_too_large"`76067607 - `BashCodeExecutionResultBlockParam object`76087609 - `type: "bash_code_execution_result"`76107611 - `content: array of BashCodeExecutionOutputBlockParam`76127613 - `type: "bash_code_execution_output"`76147615 - `file_id: string`76167617 - `return_code: number`76187619 - `stderr: string`76207621 - `stdout: string`76227623 - `tool_use_id: string`76247625 pattern: ^srvtoolu_[a-zA-Z0-9_]+$76267627 - `cache_control: optional CacheControlEphemeral or null`76287629 Create a cache control breakpoint at this content block.76307631 - `type: "ephemeral"`76327633 - `ttl: optional "5m" or "1h"`76347635 The time-to-live for the cache control breakpoint.76367637 This may be one the following values:76387639 - `5m`: 5 minutes7640 - `1h`: 1 hour76417642 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.76437644 - `"5m"`76457646 - `"1h"`76477648### Bash Code Execution Tool Result Error76497650- `BashCodeExecutionToolResultError object`76517652 - `type: "bash_code_execution_tool_result_error"`76537654 default: bash_code_execution_tool_result_error76557656 - `error_code: BashCodeExecutionToolResultErrorCode`76577658 - `"invalid_tool_input"`76597660 - `"unavailable"`76617662 - `"too_many_requests"`76637664 - `"execution_time_exceeded"`76657666 - `"output_file_too_large"`76677668### Bash Code Execution Tool Result Error Code76697670- `BashCodeExecutionToolResultErrorCode = "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more`76717672 - `"invalid_tool_input"`76737674 - `"unavailable"`76757676 - `"too_many_requests"`76777678 - `"execution_time_exceeded"`76797680 - `"output_file_too_large"`76817682### Bash Code Execution Tool Result Error Param76837684- `BashCodeExecutionToolResultErrorParam object`76857686 - `type: "bash_code_execution_tool_result_error"`76877688 - `error_code: BashCodeExecutionToolResultErrorCode`76897690 - `"invalid_tool_input"`76917692 - `"unavailable"`76937694 - `"too_many_requests"`76957696 - `"execution_time_exceeded"`76977698 - `"output_file_too_large"`76997700### Browser Close Tab Config77017702- `BrowserCloseTabConfig object`77037704 `close_tab`'s config overrides.77057706 - `defer_loading: optional boolean or null`77077708 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.77097710 - `enabled: optional boolean or null`77117712 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.77137714### Browser Double Click Config77157716- `BrowserDoubleClickConfig object`77177718 `double_click`'s config overrides.77197720 - `defer_loading: optional boolean or null`77217722 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.77237724 - `enabled: optional boolean or null`77257726 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.77277728### Browser File Upload Config77297730- `BrowserFileUploadConfig object`77317732 `file_upload`'s config overrides.77337734 - `defer_loading: optional boolean or null`77357736 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.77377738 - `enabled: optional boolean or null`77397740 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.77417742### Browser Find Config77437744- `BrowserFindConfig object`77457746 `find`'s config overrides.77477748 - `defer_loading: optional boolean or null`77497750 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.77517752 - `enabled: optional boolean or null`77537754 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.77557756### Browser Form Input Config77577758- `BrowserFormInputConfig object`77597760 `form_input`'s config overrides.77617762 - `defer_loading: optional boolean or null`77637764 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.77657766 - `enabled: optional boolean or null`77677768 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.77697770### Browser Get Page Text Config77717772- `BrowserGetPageTextConfig object`77737774 `get_page_text`'s config overrides.77757776 - `defer_loading: optional boolean or null`77777778 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.77797780 - `enabled: optional boolean or null`77817782 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.77837784### Browser Hold Key Config77857786- `BrowserHoldKeyConfig object`77877788 `hold_key`'s config overrides.77897790 - `defer_loading: optional boolean or null`77917792 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.77937794 - `enabled: optional boolean or null`77957796 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.77977798### Browser Hover Config77997800- `BrowserHoverConfig object`78017802 `hover`'s config overrides.78037804 - `defer_loading: optional boolean or null`78057806 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.78077808 - `enabled: optional boolean or null`78097810 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.78117812### Browser Javascript Exec Config78137814- `BrowserJavascriptExecConfig object`78157816 `javascript_exec`'s config overrides.78177818 - `defer_loading: optional boolean or null`78197820 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.78217822 - `enabled: optional boolean or null`78237824 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.78257826### Browser Key Config78277828- `BrowserKeyConfig object`78297830 `key`'s config overrides.78317832 - `defer_loading: optional boolean or null`78337834 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.78357836 - `enabled: optional boolean or null`78377838 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.78397840### Browser Left Click Config78417842- `BrowserLeftClickConfig object`78437844 `left_click`'s config overrides.78457846 - `defer_loading: optional boolean or null`78477848 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.78497850 - `enabled: optional boolean or null`78517852 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.78537854### Browser Left Click Drag Config78557856- `BrowserLeftClickDragConfig object`78577858 `left_click_drag`'s config overrides.78597860 - `defer_loading: optional boolean or null`78617862 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.78637864 - `enabled: optional boolean or null`78657866 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.78677868### Browser Left Mouse Down Config78697870- `BrowserLeftMouseDownConfig object`78717872 `left_mouse_down`'s config overrides.78737874 - `defer_loading: optional boolean or null`78757876 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.78777878 - `enabled: optional boolean or null`78797880 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.78817882### Browser Left Mouse Up Config78837884- `BrowserLeftMouseUpConfig object`78857886 `left_mouse_up`'s config overrides.78877888 - `defer_loading: optional boolean or null`78897890 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.78917892 - `enabled: optional boolean or null`78937894 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.78957896### Browser List Tabs Config78977898- `BrowserListTabsConfig object`78997900 `list_tabs`'s config overrides.79017902 - `defer_loading: optional boolean or null`79037904 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.79057906 - `enabled: optional boolean or null`79077908 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.79097910### Browser Middle Click Config79117912- `BrowserMiddleClickConfig object`79137914 `middle_click`'s config overrides.79157916 - `defer_loading: optional boolean or null`79177918 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.79197920 - `enabled: optional boolean or null`79217922 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.79237924### Browser Mouse Move Config79257926- `BrowserMouseMoveConfig object`79277928 `mouse_move`'s config overrides.79297930 - `defer_loading: optional boolean or null`79317932 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.79337934 - `enabled: optional boolean or null`79357936 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.79377938### Browser Navigate Config79397940- `BrowserNavigateConfig object`79417942 `navigate`'s config overrides.79437944 - `defer_loading: optional boolean or null`79457946 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.79477948 - `enabled: optional boolean or null`79497950 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.79517952### Browser New Tab Config79537954- `BrowserNewTabConfig object`79557956 `new_tab`'s config overrides.79577958 - `defer_loading: optional boolean or null`79597960 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.79617962 - `enabled: optional boolean or null`79637964 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.79657966### Browser Read Console Config79677968- `BrowserReadConsoleConfig object`79697970 `read_console`'s config overrides.79717972 - `defer_loading: optional boolean or null`79737974 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.79757976 - `enabled: optional boolean or null`79777978 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.79797980### Browser Read Network Config79817982- `BrowserReadNetworkConfig object`79837984 `read_network`'s config overrides.79857986 - `defer_loading: optional boolean or null`79877988 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.79897990 - `enabled: optional boolean or null`79917992 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.79937994### Browser Read Page Config79957996- `BrowserReadPageConfig object`79977998 `read_page`'s config overrides.79998000 - `defer_loading: optional boolean or null`80018002 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.80038004 - `enabled: optional boolean or null`80058006 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.80078008### Browser Right Click Config80098010- `BrowserRightClickConfig object`80118012 `right_click`'s config overrides.80138014 - `defer_loading: optional boolean or null`80158016 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.80178018 - `enabled: optional boolean or null`80198020 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.80218022### Browser Screenshot Config80238024- `BrowserScreenshotConfig object`80258026 `screenshot`'s config overrides.80278028 - `defer_loading: optional boolean or null`80298030 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.80318032 - `enabled: optional boolean or null`80338034 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.80358036### Browser Scroll Config80378038- `BrowserScrollConfig object`80398040 `scroll`'s config overrides.80418042 - `defer_loading: optional boolean or null`80438044 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.80458046 - `enabled: optional boolean or null`80478048 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.80498050### Browser Scroll To Config80518052- `BrowserScrollToConfig object`80538054 `scroll_to`'s config overrides.80558056 - `defer_loading: optional boolean or null`80578058 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.80598060 - `enabled: optional boolean or null`80618062 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.80638064### Browser State Block Param80658066- `BrowserStateBlockParam object`80678068 The caller's browser state after a browser toolset member call —8069 the full inventory of open tabs, which tab is active, and any side8070 effects (tabs opened, download state changes) the call produced.80718072 At most one per `tool_result`, only on a non-error result answering a8073 browser toolset member `tool_use`. The server renders the8074 model-visible text from it; the model never sees the raw fields.80758076 - `type: "browser_state"`80778078 - `tabs: array of BrowserStateTabEntry`80798080 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`.80818082 maxItems: 10080838084 - `tab_id: string`80858086 The caller-assigned identifier for this tab, unique within the inventory.80878088 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$80898090 - `title: string`80918092 The title of the page the tab is showing. May be empty.80938094 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$80958096 - `url: string`80978098 The URL of the page the tab is showing. May be empty.80998100 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$81018102 - `active: optional boolean`81038104 Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.81058106 - `cache_control: optional CacheControlEphemeral or null`81078108 Create a cache control breakpoint at this content block.81098110 - `type: "ephemeral"`81118112 - `ttl: optional "5m" or "1h"`81138114 The time-to-live for the cache control breakpoint.81158116 This may be one the following values:81178118 - `5m`: 5 minutes8119 - `1h`: 1 hour81208121 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.81228123 - `"5m"`81248125 - `"1h"`81268127 - `state_changes: optional array of BrowserStateChange or null`81288129 Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list.81308131 maxItems: 200, minItems: 181328133 - `BrowserStateChangeTabOpened object`81348135 A tab this call's execution opened that remains open at its end —8136 the creation delta of the `tabs` inventory, not an event log.81378138 Carries only the `tab_id`; the tab's `title` and `url` live on its8139 `tabs` entry, which must include the same `tab_id`. A tab opened8140 during a failed call gets no deferred `tab_opened`; it simply appears8141 in the next result's `tabs` inventory.81428143 - `type: "tab_opened"`81448145 - `tab_id: string`81468147 The `tab_id` of the opened tab, present in `tabs`.81488149 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$81508151 - `BrowserStateChangeDownloadStarted object`81528153 A file download that started during this call.81548155 - `type: "download_started"`81568157 - `download_id: string`81588159 The caller-assigned identifier for this download, stable across the state changes reporting it.81608161 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$81628163 - `url: string`81648165 The final post-redirect URL the download was served from.81668167 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$81688169 - `BrowserStateChangeDownloadCompleted object`81708171 A file download that finished during this call, reported with the8172 same `download_id` as its `download_started` — or without a prior8173 `download_started`, when the download finished during the call that8174 started it (at most one state change per `download_id` per result).81758176 - `type: "download_completed"`81778178 - `download_id: string`81798180 The caller-assigned identifier for this download, stable across the state changes reporting it.81818182 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$81838184 - `url: string`81858186 The final post-redirect URL the download was served from.81878188 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$81898190 - `path: optional string or null`81918192 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.81938194 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 409681958196 - `size_bytes: optional number or null`81978198 The completed download's size.81998200 minimum: 082018202 - `BrowserStateChangeDownloadFailed object`82038204 A file download that failed — or was cancelled — during this call.82058206 - `type: "download_failed"`82078208 - `download_id: string`82098210 The caller-assigned identifier for this download, stable across the state changes reporting it.82118212 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$82138214 - `url: string`82158216 The final post-redirect URL the download was served from.82178218 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$82198220 - `error: optional string or null`82218222 The failure or cancellation detail, when known.82238224 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 409682258226### Browser State Change82278228- `BrowserStateChange = BrowserStateChangeTabOpened or BrowserStateChangeDownloadStarted or BrowserStateChangeDownloadCompleted or BrowserStateChangeDownloadFailed`82298230 - `BrowserStateChangeTabOpened object`82318232 A tab this call's execution opened that remains open at its end —8233 the creation delta of the `tabs` inventory, not an event log.82348235 Carries only the `tab_id`; the tab's `title` and `url` live on its8236 `tabs` entry, which must include the same `tab_id`. A tab opened8237 during a failed call gets no deferred `tab_opened`; it simply appears8238 in the next result's `tabs` inventory.82398240 - `type: "tab_opened"`82418242 - `tab_id: string`82438244 The `tab_id` of the opened tab, present in `tabs`.82458246 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$82478248 - `BrowserStateChangeDownloadStarted object`82498250 A file download that started during this call.82518252 - `type: "download_started"`82538254 - `download_id: string`82558256 The caller-assigned identifier for this download, stable across the state changes reporting it.82578258 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$82598260 - `url: string`82618262 The final post-redirect URL the download was served from.82638264 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$82658266 - `BrowserStateChangeDownloadCompleted object`82678268 A file download that finished during this call, reported with the8269 same `download_id` as its `download_started` — or without a prior8270 `download_started`, when the download finished during the call that8271 started it (at most one state change per `download_id` per result).82728273 - `type: "download_completed"`82748275 - `download_id: string`82768277 The caller-assigned identifier for this download, stable across the state changes reporting it.82788279 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$82808281 - `url: string`82828283 The final post-redirect URL the download was served from.82848285 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$82868287 - `path: optional string or null`82888289 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.82908291 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 409682928293 - `size_bytes: optional number or null`82948295 The completed download's size.82968297 minimum: 082988299 - `BrowserStateChangeDownloadFailed object`83008301 A file download that failed — or was cancelled — during this call.83028303 - `type: "download_failed"`83048305 - `download_id: string`83068307 The caller-assigned identifier for this download, stable across the state changes reporting it.83088309 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$83108311 - `url: string`83128313 The final post-redirect URL the download was served from.83148315 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$83168317 - `error: optional string or null`83188319 The failure or cancellation detail, when known.83208321 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 409683228323### Browser State Change Download Completed83248325- `BrowserStateChangeDownloadCompleted object`83268327 A file download that finished during this call, reported with the8328 same `download_id` as its `download_started` — or without a prior8329 `download_started`, when the download finished during the call that8330 started it (at most one state change per `download_id` per result).83318332 - `type: "download_completed"`83338334 - `download_id: string`83358336 The caller-assigned identifier for this download, stable across the state changes reporting it.83378338 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$83398340 - `url: string`83418342 The final post-redirect URL the download was served from.83438344 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$83458346 - `path: optional string or null`83478348 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.83498350 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 409683518352 - `size_bytes: optional number or null`83538354 The completed download's size.83558356 minimum: 083578358### Browser State Change Download Failed83598360- `BrowserStateChangeDownloadFailed object`83618362 A file download that failed — or was cancelled — during this call.83638364 - `type: "download_failed"`83658366 - `download_id: string`83678368 The caller-assigned identifier for this download, stable across the state changes reporting it.83698370 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$83718372 - `url: string`83738374 The final post-redirect URL the download was served from.83758376 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$83778378 - `error: optional string or null`83798380 The failure or cancellation detail, when known.83818382 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 409683838384### Browser State Change Download Started83858386- `BrowserStateChangeDownloadStarted object`83878388 A file download that started during this call.83898390 - `type: "download_started"`83918392 - `download_id: string`83938394 The caller-assigned identifier for this download, stable across the state changes reporting it.83958396 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$83978398 - `url: string`83998400 The final post-redirect URL the download was served from.84018402 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$84038404### Browser State Change Tab Opened84058406- `BrowserStateChangeTabOpened object`84078408 A tab this call's execution opened that remains open at its end —8409 the creation delta of the `tabs` inventory, not an event log.84108411 Carries only the `tab_id`; the tab's `title` and `url` live on its8412 `tabs` entry, which must include the same `tab_id`. A tab opened8413 during a failed call gets no deferred `tab_opened`; it simply appears8414 in the next result's `tabs` inventory.84158416 - `type: "tab_opened"`84178418 - `tab_id: string`84198420 The `tab_id` of the opened tab, present in `tabs`.84218422 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$84238424### Browser State Tab Entry84258426- `BrowserStateTabEntry object`84278428 One open browser tab reported in a `browser_state` block's `tabs`8429 inventory.84308431 `tab_id` is the caller-assigned identifier for the tab; `title` and8432 `url` describe the page the tab is currently showing and may be empty8433 strings (a blank tab legitimately has both empty). `active` marks the8434 tab that is active after this call; whenever `tabs` is non-empty,8435 exactly one entry is marked.84368437 - `tab_id: string`84388439 The caller-assigned identifier for this tab, unique within the inventory.84408441 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$84428443 - `title: string`84448445 The title of the page the tab is showing. May be empty.84468447 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$84488449 - `url: string`84508451 The URL of the page the tab is showing. May be empty.84528453 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$84548455 - `active: optional boolean`84568457 Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.84588459### Browser Switch Tab Config84608461- `BrowserSwitchTabConfig object`84628463 `switch_tab`'s config overrides.84648465 - `defer_loading: optional boolean or null`84668467 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.84688469 - `enabled: optional boolean or null`84708471 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.84728473### Browser Toolset 2026080184748475- `BrowserToolset20260801 object`84768477 The browser toolset: a single `tools[]` entry (carrying no8478 `name`) that declares the browser tool family. The model is served8479 the family's tool with any members disabled via `configs` removed8480 from its schema.84818482 - `type: "browser_toolset_20260801"`84838484 - `cache_control: optional CacheControlEphemeral or null`84858486 Create a cache control breakpoint at this content block.84878488 - `type: "ephemeral"`84898490 - `ttl: optional "5m" or "1h"`84918492 The time-to-live for the cache control breakpoint.84938494 This may be one the following values:84958496 - `5m`: 5 minutes8497 - `1h`: 1 hour84988499 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.85008501 - `"5m"`85028503 - `"1h"`85048505 - `configs: optional BrowserToolsetConfigs or null`85068507 Per-member configuration for `browser_toolset_20260801`: one8508 optional field per member tool, keyed by the member name — the same8509 name the member's `tool_use` blocks carry. Every member is an8510 accepted key, and a member's defaults apply wherever its key is8511 absent. Unknown keys are rejected: the field set is this toolset8512 version's complete member set.85138514 - `type: optional BrowserTypeConfig or null`85158516 `type`'s config overrides.85178518 - `defer_loading: optional boolean or null`85198520 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.85218522 - `enabled: optional boolean or null`85238524 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.85258526 - `close_tab: optional BrowserCloseTabConfig or null`85278528 `close_tab`'s config overrides.85298530 - `defer_loading: optional boolean or null`85318532 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.85338534 - `enabled: optional boolean or null`85358536 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.85378538 - `double_click: optional BrowserDoubleClickConfig or null`85398540 `double_click`'s config overrides.85418542 - `defer_loading: optional boolean or null`85438544 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.85458546 - `enabled: optional boolean or null`85478548 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.85498550 - `file_upload: optional BrowserFileUploadConfig or null`85518552 `file_upload`'s config overrides.85538554 - `defer_loading: optional boolean or null`85558556 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.85578558 - `enabled: optional boolean or null`85598560 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.85618562 - `find: optional BrowserFindConfig or null`85638564 `find`'s config overrides.85658566 - `defer_loading: optional boolean or null`85678568 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.85698570 - `enabled: optional boolean or null`85718572 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.85738574 - `form_input: optional BrowserFormInputConfig or null`85758576 `form_input`'s config overrides.85778578 - `defer_loading: optional boolean or null`85798580 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.85818582 - `enabled: optional boolean or null`85838584 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.85858586 - `get_page_text: optional BrowserGetPageTextConfig or null`85878588 `get_page_text`'s config overrides.85898590 - `defer_loading: optional boolean or null`85918592 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.85938594 - `enabled: optional boolean or null`85958596 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.85978598 - `hold_key: optional BrowserHoldKeyConfig or null`85998600 `hold_key`'s config overrides.86018602 - `defer_loading: optional boolean or null`86038604 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.86058606 - `enabled: optional boolean or null`86078608 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.86098610 - `hover: optional BrowserHoverConfig or null`86118612 `hover`'s config overrides.86138614 - `defer_loading: optional boolean or null`86158616 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.86178618 - `enabled: optional boolean or null`86198620 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.86218622 - `javascript_exec: optional BrowserJavascriptExecConfig or null`86238624 `javascript_exec`'s config overrides.86258626 - `defer_loading: optional boolean or null`86278628 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.86298630 - `enabled: optional boolean or null`86318632 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.86338634 - `key: optional BrowserKeyConfig or null`86358636 `key`'s config overrides.86378638 - `defer_loading: optional boolean or null`86398640 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.86418642 - `enabled: optional boolean or null`86438644 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.86458646 - `left_click: optional BrowserLeftClickConfig or null`86478648 `left_click`'s config overrides.86498650 - `defer_loading: optional boolean or null`86518652 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.86538654 - `enabled: optional boolean or null`86558656 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.86578658 - `left_click_drag: optional BrowserLeftClickDragConfig or null`86598660 `left_click_drag`'s config overrides.86618662 - `defer_loading: optional boolean or null`86638664 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.86658666 - `enabled: optional boolean or null`86678668 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.86698670 - `left_mouse_down: optional BrowserLeftMouseDownConfig or null`86718672 `left_mouse_down`'s config overrides.86738674 - `defer_loading: optional boolean or null`86758676 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.86778678 - `enabled: optional boolean or null`86798680 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.86818682 - `left_mouse_up: optional BrowserLeftMouseUpConfig or null`86838684 `left_mouse_up`'s config overrides.86858686 - `defer_loading: optional boolean or null`86878688 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.86898690 - `enabled: optional boolean or null`86918692 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.86938694 - `list_tabs: optional BrowserListTabsConfig or null`86958696 `list_tabs`'s config overrides.86978698 - `defer_loading: optional boolean or null`86998700 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.87018702 - `enabled: optional boolean or null`87038704 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.87058706 - `middle_click: optional BrowserMiddleClickConfig or null`87078708 `middle_click`'s config overrides.87098710 - `defer_loading: optional boolean or null`87118712 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.87138714 - `enabled: optional boolean or null`87158716 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.87178718 - `mouse_move: optional BrowserMouseMoveConfig or null`87198720 `mouse_move`'s config overrides.87218722 - `defer_loading: optional boolean or null`87238724 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.87258726 - `enabled: optional boolean or null`87278728 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.87298730 - `navigate: optional BrowserNavigateConfig or null`87318732 `navigate`'s config overrides.87338734 - `defer_loading: optional boolean or null`87358736 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.87378738 - `enabled: optional boolean or null`87398740 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.87418742 - `new_tab: optional BrowserNewTabConfig or null`87438744 `new_tab`'s config overrides.87458746 - `defer_loading: optional boolean or null`87478748 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.87498750 - `enabled: optional boolean or null`87518752 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.87538754 - `read_console: optional BrowserReadConsoleConfig or null`87558756 `read_console`'s config overrides.87578758 - `defer_loading: optional boolean or null`87598760 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.87618762 - `enabled: optional boolean or null`87638764 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.87658766 - `read_network: optional BrowserReadNetworkConfig or null`87678768 `read_network`'s config overrides.87698770 - `defer_loading: optional boolean or null`87718772 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.87738774 - `enabled: optional boolean or null`87758776 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.87778778 - `read_page: optional BrowserReadPageConfig or null`87798780 `read_page`'s config overrides.87818782 - `defer_loading: optional boolean or null`87838784 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.87858786 - `enabled: optional boolean or null`87878788 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.87898790 - `right_click: optional BrowserRightClickConfig or null`87918792 `right_click`'s config overrides.87938794 - `defer_loading: optional boolean or null`87958796 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.87978798 - `enabled: optional boolean or null`87998800 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.88018802 - `screenshot: optional BrowserScreenshotConfig or null`88038804 `screenshot`'s config overrides.88058806 - `defer_loading: optional boolean or null`88078808 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.88098810 - `enabled: optional boolean or null`88118812 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.88138814 - `scroll: optional BrowserScrollConfig or null`88158816 `scroll`'s config overrides.88178818 - `defer_loading: optional boolean or null`88198820 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.88218822 - `enabled: optional boolean or null`88238824 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.88258826 - `scroll_to: optional BrowserScrollToConfig or null`88278828 `scroll_to`'s config overrides.88298830 - `defer_loading: optional boolean or null`88318832 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.88338834 - `enabled: optional boolean or null`88358836 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.88378838 - `switch_tab: optional BrowserSwitchTabConfig or null`88398840 `switch_tab`'s config overrides.88418842 - `defer_loading: optional boolean or null`88438844 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.88458846 - `enabled: optional boolean or null`88478848 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.88498850 - `triple_click: optional BrowserTripleClickConfig or null`88518852 `triple_click`'s config overrides.88538854 - `defer_loading: optional boolean or null`88558856 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.88578858 - `enabled: optional boolean or null`88598860 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.88618862 - `wait: optional BrowserWaitConfig or null`88638864 `wait`'s config overrides.88658866 - `defer_loading: optional boolean or null`88678868 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.88698870 - `enabled: optional boolean or null`88718872 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.88738874 - `zoom: optional BrowserZoomConfig or null`88758876 `zoom`'s config overrides.88778878 - `defer_loading: optional boolean or null`88798880 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.88818882 - `enabled: optional boolean or null`88838884 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.88858886### Browser Toolset Configs88878888- `BrowserToolsetConfigs object`88898890 Per-member configuration for `browser_toolset_20260801`: one8891 optional field per member tool, keyed by the member name — the same8892 name the member's `tool_use` blocks carry. Every member is an8893 accepted key, and a member's defaults apply wherever its key is8894 absent. Unknown keys are rejected: the field set is this toolset8895 version's complete member set.88968897 - `type: optional BrowserTypeConfig or null`88988899 `type`'s config overrides.89008901 - `defer_loading: optional boolean or null`89028903 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.89048905 - `enabled: optional boolean or null`89068907 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.89088909 - `close_tab: optional BrowserCloseTabConfig or null`89108911 `close_tab`'s config overrides.89128913 - `defer_loading: optional boolean or null`89148915 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.89168917 - `enabled: optional boolean or null`89188919 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.89208921 - `double_click: optional BrowserDoubleClickConfig or null`89228923 `double_click`'s config overrides.89248925 - `defer_loading: optional boolean or null`89268927 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.89288929 - `enabled: optional boolean or null`89308931 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.89328933 - `file_upload: optional BrowserFileUploadConfig or null`89348935 `file_upload`'s config overrides.89368937 - `defer_loading: optional boolean or null`89388939 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.89408941 - `enabled: optional boolean or null`89428943 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.89448945 - `find: optional BrowserFindConfig or null`89468947 `find`'s config overrides.89488949 - `defer_loading: optional boolean or null`89508951 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.89528953 - `enabled: optional boolean or null`89548955 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.89568957 - `form_input: optional BrowserFormInputConfig or null`89588959 `form_input`'s config overrides.89608961 - `defer_loading: optional boolean or null`89628963 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.89648965 - `enabled: optional boolean or null`89668967 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.89688969 - `get_page_text: optional BrowserGetPageTextConfig or null`89708971 `get_page_text`'s config overrides.89728973 - `defer_loading: optional boolean or null`89748975 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.89768977 - `enabled: optional boolean or null`89788979 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.89808981 - `hold_key: optional BrowserHoldKeyConfig or null`89828983 `hold_key`'s config overrides.89848985 - `defer_loading: optional boolean or null`89868987 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.89888989 - `enabled: optional boolean or null`89908991 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.89928993 - `hover: optional BrowserHoverConfig or null`89948995 `hover`'s config overrides.89968997 - `defer_loading: optional boolean or null`89988999 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.90009001 - `enabled: optional boolean or null`90029003 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.90049005 - `javascript_exec: optional BrowserJavascriptExecConfig or null`90069007 `javascript_exec`'s config overrides.90089009 - `defer_loading: optional boolean or null`90109011 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.90129013 - `enabled: optional boolean or null`90149015 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.90169017 - `key: optional BrowserKeyConfig or null`90189019 `key`'s config overrides.90209021 - `defer_loading: optional boolean or null`90229023 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.90249025 - `enabled: optional boolean or null`90269027 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.90289029 - `left_click: optional BrowserLeftClickConfig or null`90309031 `left_click`'s config overrides.90329033 - `defer_loading: optional boolean or null`90349035 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.90369037 - `enabled: optional boolean or null`90389039 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.90409041 - `left_click_drag: optional BrowserLeftClickDragConfig or null`90429043 `left_click_drag`'s config overrides.90449045 - `defer_loading: optional boolean or null`90469047 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.90489049 - `enabled: optional boolean or null`90509051 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.90529053 - `left_mouse_down: optional BrowserLeftMouseDownConfig or null`90549055 `left_mouse_down`'s config overrides.90569057 - `defer_loading: optional boolean or null`90589059 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.90609061 - `enabled: optional boolean or null`90629063 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.90649065 - `left_mouse_up: optional BrowserLeftMouseUpConfig or null`90669067 `left_mouse_up`'s config overrides.90689069 - `defer_loading: optional boolean or null`90709071 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.90729073 - `enabled: optional boolean or null`90749075 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.90769077 - `list_tabs: optional BrowserListTabsConfig or null`90789079 `list_tabs`'s config overrides.90809081 - `defer_loading: optional boolean or null`90829083 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.90849085 - `enabled: optional boolean or null`90869087 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.90889089 - `middle_click: optional BrowserMiddleClickConfig or null`90909091 `middle_click`'s config overrides.90929093 - `defer_loading: optional boolean or null`90949095 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.90969097 - `enabled: optional boolean or null`90989099 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.91009101 - `mouse_move: optional BrowserMouseMoveConfig or null`91029103 `mouse_move`'s config overrides.91049105 - `defer_loading: optional boolean or null`91069107 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.91089109 - `enabled: optional boolean or null`91109111 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.91129113 - `navigate: optional BrowserNavigateConfig or null`91149115 `navigate`'s config overrides.91169117 - `defer_loading: optional boolean or null`91189119 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.91209121 - `enabled: optional boolean or null`91229123 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.91249125 - `new_tab: optional BrowserNewTabConfig or null`91269127 `new_tab`'s config overrides.91289129 - `defer_loading: optional boolean or null`91309131 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.91329133 - `enabled: optional boolean or null`91349135 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.91369137 - `read_console: optional BrowserReadConsoleConfig or null`91389139 `read_console`'s config overrides.91409141 - `defer_loading: optional boolean or null`91429143 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.91449145 - `enabled: optional boolean or null`91469147 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.91489149 - `read_network: optional BrowserReadNetworkConfig or null`91509151 `read_network`'s config overrides.91529153 - `defer_loading: optional boolean or null`91549155 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.91569157 - `enabled: optional boolean or null`91589159 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.91609161 - `read_page: optional BrowserReadPageConfig or null`91629163 `read_page`'s config overrides.91649165 - `defer_loading: optional boolean or null`91669167 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.91689169 - `enabled: optional boolean or null`91709171 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.91729173 - `right_click: optional BrowserRightClickConfig or null`91749175 `right_click`'s config overrides.91769177 - `defer_loading: optional boolean or null`91789179 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.91809181 - `enabled: optional boolean or null`91829183 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.91849185 - `screenshot: optional BrowserScreenshotConfig or null`91869187 `screenshot`'s config overrides.91889189 - `defer_loading: optional boolean or null`91909191 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.91929193 - `enabled: optional boolean or null`91949195 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.91969197 - `scroll: optional BrowserScrollConfig or null`91989199 `scroll`'s config overrides.92009201 - `defer_loading: optional boolean or null`92029203 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.92049205 - `enabled: optional boolean or null`92069207 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.92089209 - `scroll_to: optional BrowserScrollToConfig or null`92109211 `scroll_to`'s config overrides.92129213 - `defer_loading: optional boolean or null`92149215 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.92169217 - `enabled: optional boolean or null`92189219 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.92209221 - `switch_tab: optional BrowserSwitchTabConfig or null`92229223 `switch_tab`'s config overrides.92249225 - `defer_loading: optional boolean or null`92269227 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.92289229 - `enabled: optional boolean or null`92309231 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.92329233 - `triple_click: optional BrowserTripleClickConfig or null`92349235 `triple_click`'s config overrides.92369237 - `defer_loading: optional boolean or null`92389239 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.92409241 - `enabled: optional boolean or null`92429243 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.92449245 - `wait: optional BrowserWaitConfig or null`92469247 `wait`'s config overrides.92489249 - `defer_loading: optional boolean or null`92509251 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.92529253 - `enabled: optional boolean or null`92549255 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.92569257 - `zoom: optional BrowserZoomConfig or null`92589259 `zoom`'s config overrides.92609261 - `defer_loading: optional boolean or null`92629263 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.92649265 - `enabled: optional boolean or null`92669267 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.92689269### Browser Triple Click Config92709271- `BrowserTripleClickConfig object`92729273 `triple_click`'s config overrides.92749275 - `defer_loading: optional boolean or null`92769277 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.92789279 - `enabled: optional boolean or null`92809281 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.92829283### Browser Type Config92849285- `BrowserTypeConfig object`92869287 `type`'s config overrides.92889289 - `defer_loading: optional boolean or null`92909291 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.92929293 - `enabled: optional boolean or null`92949295 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.92969297### Browser Wait Config92989299- `BrowserWaitConfig object`93009301 `wait`'s config overrides.93029303 - `defer_loading: optional boolean or null`93049305 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.93069307 - `enabled: optional boolean or null`93089309 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.93109311### Browser Zoom Config93129313- `BrowserZoomConfig object`93149315 `zoom`'s config overrides.93169317 - `defer_loading: optional boolean or null`93189319 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.93209321 - `enabled: optional boolean or null`93229323 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.93249325### Cache Control Ephemeral93269327- `CacheControlEphemeral object`93289329 - `type: "ephemeral"`93309331 - `ttl: optional "5m" or "1h"`93329333 The time-to-live for the cache control breakpoint.93349335 This may be one the following values:93369337 - `5m`: 5 minutes9338 - `1h`: 1 hour93399340 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.93419342 - `"5m"`93439344 - `"1h"`93459346### Cache Creation93479348- `CacheCreation object`93499350 - `ephemeral_1h_input_tokens: number`93519352 The number of input tokens used to create the 1 hour cache entry.93539354 default: 0, minimum: 093559356 - `ephemeral_5m_input_tokens: number`93579358 The number of input tokens used to create the 5 minute cache entry.93599360 default: 0, minimum: 093619362### Citation Char Location93639364- `CitationCharLocation object`93659366 - `type: "char_location"`93679368 default: char_location93699370 - `cited_text: string`93719372 - `document_index: number`93739374 minimum: 093759376 - `document_title: string or null`93779378 - `end_char_index: number`93799380 - `file_id: string or null`93819382 - `start_char_index: number`93839384 minimum: 093859386### Citation Char Location Param93879388- `CitationCharLocationParam object`93899390 - `type: "char_location"`93919392 - `cited_text: string`93939394 - `document_index: number`93959396 minimum: 093979398 - `document_title: string or null`93999400 maxLength: 500, minLength: 194019402 - `end_char_index: number`94039404 - `start_char_index: number`94059406 minimum: 094079408### Citation Content Block Location94099410- `CitationContentBlockLocation object`94119412 - `type: "content_block_location"`94139414 default: content_block_location94159416 - `cited_text: string`94179418 The full text of the cited block range, concatenated.94199420 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.94219422 - `document_index: number`94239424 minimum: 094259426 - `document_title: string or null`94279428 - `end_block_index: number`94299430 Exclusive 0-based end index of the cited block range in the source's `content` array.94319432 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.94339434 - `file_id: string or null`94359436 - `start_block_index: number`94379438 0-based index of the first cited block in the source's `content` array.94399440 minimum: 094419442### Citation Content Block Location Param94439444- `CitationContentBlockLocationParam object`94459446 - `type: "content_block_location"`94479448 - `cited_text: string`94499450 The full text of the cited block range, concatenated.94519452 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.94539454 - `document_index: number`94559456 minimum: 094579458 - `document_title: string or null`94599460 maxLength: 500, minLength: 194619462 - `end_block_index: number`94639464 Exclusive 0-based end index of the cited block range in the source's `content` array.94659466 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.94679468 - `start_block_index: number`94699470 0-based index of the first cited block in the source's `content` array.94719472 minimum: 094739474### Citation Page Location94759476- `CitationPageLocation object`94779478 - `type: "page_location"`94799480 default: page_location94819482 - `cited_text: string`94839484 - `document_index: number`94859486 minimum: 094879488 - `document_title: string or null`94899490 - `end_page_number: number`94919492 - `file_id: string or null`94939494 - `start_page_number: number`94959496 minimum: 194979498### Citation Page Location Param94999500- `CitationPageLocationParam object`95019502 - `type: "page_location"`95039504 - `cited_text: string`95059506 - `document_index: number`95079508 minimum: 095099510 - `document_title: string or null`95119512 maxLength: 500, minLength: 195139514 - `end_page_number: number`95159516 - `start_page_number: number`95179518 minimum: 195199520### Citation Search Result Location Param95219522- `CitationSearchResultLocationParam object`95239524 - `type: "search_result_location"`95259526 - `cited_text: string`95279528 The full text of the cited block range, concatenated.95299530 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.95319532 - `end_block_index: number`95339534 Exclusive 0-based end index of the cited block range in the source's `content` array.95359536 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.95379538 - `search_result_index: number`95399540 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.95419542 Counted separately from `document_index`; server-side web search results are not included in this count.95439544 minimum: 095459546 - `source: string`95479548 - `start_block_index: number`95499550 0-based index of the first cited block in the source's `content` array.95519552 minimum: 095539554 - `title: string or null`95559556### Citation Web Search Result Location Param95579558- `CitationWebSearchResultLocationParam object`95599560 - `type: "web_search_result_location"`95619562 - `cited_text: string`95639564 - `encrypted_index: string`95659566 - `title: string or null`95679568 maxLength: 512, minLength: 195699570 - `url: string`95719572 minLength: 195739574### Citations Config95759576- `CitationsConfig object`95779578 - `enabled: boolean`95799580 default: false95819582### Citations Config Param95839584- `CitationsConfigParam object`95859586 - `enabled: optional boolean`95879588### Citations Delta95899590- `CitationsDelta object`95919592 - `type: "citations_delta"`95939594 default: citations_delta95959596 - `citation: CitationCharLocation or CitationPageLocation or CitationContentBlockLocation or 2 more`95979598 - `CitationCharLocation object`95999600 - `type: "char_location"`96019602 default: char_location96039604 - `cited_text: string`96059606 - `document_index: number`96079608 minimum: 096099610 - `document_title: string or null`96119612 - `end_char_index: number`96139614 - `file_id: string or null`96159616 - `start_char_index: number`96179618 minimum: 096199620 - `CitationPageLocation object`96219622 - `type: "page_location"`96239624 default: page_location96259626 - `cited_text: string`96279628 - `document_index: number`96299630 minimum: 096319632 - `document_title: string or null`96339634 - `end_page_number: number`96359636 - `file_id: string or null`96379638 - `start_page_number: number`96399640 minimum: 196419642 - `CitationContentBlockLocation object`96439644 - `type: "content_block_location"`96459646 default: content_block_location96479648 - `cited_text: string`96499650 The full text of the cited block range, concatenated.96519652 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.96539654 - `document_index: number`96559656 minimum: 096579658 - `document_title: string or null`96599660 - `end_block_index: number`96619662 Exclusive 0-based end index of the cited block range in the source's `content` array.96639664 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.96659666 - `file_id: string or null`96679668 - `start_block_index: number`96699670 0-based index of the first cited block in the source's `content` array.96719672 minimum: 096739674 - `CitationsWebSearchResultLocation object`96759676 - `type: "web_search_result_location"`96779678 default: web_search_result_location96799680 - `cited_text: string`96819682 - `encrypted_index: string`96839684 - `title: string or null`96859686 maxLength: 51296879688 - `url: string`96899690 - `CitationsSearchResultLocation object`96919692 - `type: "search_result_location"`96939694 default: search_result_location96959696 - `cited_text: string`96979698 The full text of the cited block range, concatenated.96999700 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.97019702 - `end_block_index: number`97039704 Exclusive 0-based end index of the cited block range in the source's `content` array.97059706 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.97079708 - `search_result_index: number`97099710 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.97119712 Counted separately from `document_index`; server-side web search results are not included in this count.97139714 minimum: 097159716 - `source: string`97179718 - `start_block_index: number`97199720 0-based index of the first cited block in the source's `content` array.97219722 minimum: 097239724 - `title: string or null`97259726### Citations Search Result Location97279728- `CitationsSearchResultLocation object`97299730 - `type: "search_result_location"`97319732 default: search_result_location97339734 - `cited_text: string`97359736 The full text of the cited block range, concatenated.97379738 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.97399740 - `end_block_index: number`97419742 Exclusive 0-based end index of the cited block range in the source's `content` array.97439744 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.97459746 - `search_result_index: number`97479748 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.97499750 Counted separately from `document_index`; server-side web search results are not included in this count.97519752 minimum: 097539754 - `source: string`97559756 - `start_block_index: number`97579758 0-based index of the first cited block in the source's `content` array.97599760 minimum: 097619762 - `title: string or null`97639764### Citations Web Search Result Location97659766- `CitationsWebSearchResultLocation object`97679768 - `type: "web_search_result_location"`97699770 default: web_search_result_location97719772 - `cited_text: string`97739774 - `encrypted_index: string`97759776 - `title: string or null`97779778 maxLength: 51297799780 - `url: string`97819782### Code Execution Output Block97839784- `CodeExecutionOutputBlock object`97859786 - `type: "code_execution_output"`97879788 default: code_execution_output97899790 - `file_id: string`97919792### Code Execution Output Block Param97939794- `CodeExecutionOutputBlockParam object`97959796 - `type: "code_execution_output"`97979798 - `file_id: string`97999800### Code Execution Result Block98019802- `CodeExecutionResultBlock object`98039804 - `type: "code_execution_result"`98059806 default: code_execution_result98079808 - `content: array of CodeExecutionOutputBlock`98099810 - `type: "code_execution_output"`98119812 default: code_execution_output98139814 - `file_id: string`98159816 - `return_code: number`98179818 - `stderr: string`98199820 - `stdout: string`98219822### Code Execution Result Block Param98239824- `CodeExecutionResultBlockParam object`98259826 - `type: "code_execution_result"`98279828 - `content: array of CodeExecutionOutputBlockParam`98299830 - `type: "code_execution_output"`98319832 - `file_id: string`98339834 - `return_code: number`98359836 - `stderr: string`98379838 - `stdout: string`98399840### Code Execution Tool 2025052298419842- `CodeExecutionTool20250522 object`98439844 - `type: "code_execution_20250522"`98459846 - `name: "code_execution"`98479848 Name of the tool.98499850 This is how the tool will be called by the model and in `tool_use` blocks.98519852 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`98539854 - `"direct"`98559856 - `"code_execution_20250825"`98579858 - `"code_execution_20260120"`98599860 - `"code_execution_20260521"`98619862 - `cache_control: optional CacheControlEphemeral or null`98639864 Create a cache control breakpoint at this content block.98659866 - `type: "ephemeral"`98679868 - `ttl: optional "5m" or "1h"`98699870 The time-to-live for the cache control breakpoint.98719872 This may be one the following values:98739874 - `5m`: 5 minutes9875 - `1h`: 1 hour98769877 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.98789879 - `"5m"`98809881 - `"1h"`98829883 - `defer_loading: optional boolean`98849885 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.98869887 - `strict: optional boolean`98889889 When true, guarantees schema validation on tool names and inputs98909891### Code Execution Tool 2025082598929893- `CodeExecutionTool20250825 object`98949895 - `type: "code_execution_20250825"`98969897 - `name: "code_execution"`98989899 Name of the tool.99009901 This is how the tool will be called by the model and in `tool_use` blocks.99029903 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`99049905 - `"direct"`99069907 - `"code_execution_20250825"`99089909 - `"code_execution_20260120"`99109911 - `"code_execution_20260521"`99129913 - `cache_control: optional CacheControlEphemeral or null`99149915 Create a cache control breakpoint at this content block.99169917 - `type: "ephemeral"`99189919 - `ttl: optional "5m" or "1h"`99209921 The time-to-live for the cache control breakpoint.99229923 This may be one the following values:99249925 - `5m`: 5 minutes9926 - `1h`: 1 hour99279928 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.99299930 - `"5m"`99319932 - `"1h"`99339934 - `defer_loading: optional boolean`99359936 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.99379938 - `strict: optional boolean`99399940 When true, guarantees schema validation on tool names and inputs99419942### Code Execution Tool 2026012099439944- `CodeExecutionTool20260120 object`99459946 Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).99479948 - `type: "code_execution_20260120"`99499950 - `name: "code_execution"`99519952 Name of the tool.99539954 This is how the tool will be called by the model and in `tool_use` blocks.99559956 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`99579958 - `"direct"`99599960 - `"code_execution_20250825"`99619962 - `"code_execution_20260120"`99639964 - `"code_execution_20260521"`99659966 - `cache_control: optional CacheControlEphemeral or null`99679968 Create a cache control breakpoint at this content block.99699970 - `type: "ephemeral"`99719972 - `ttl: optional "5m" or "1h"`99739974 The time-to-live for the cache control breakpoint.99759976 This may be one the following values:99779978 - `5m`: 5 minutes9979 - `1h`: 1 hour99809981 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.99829983 - `"5m"`99849985 - `"1h"`99869987 - `defer_loading: optional boolean`99889989 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.99909991 - `strict: optional boolean`99929993 When true, guarantees schema validation on tool names and inputs99949995### Code Execution Tool 2026052199969997- `CodeExecutionTool20260521 object`99989999 Code execution tool with REPL state persistence.1000010001 - `type: "code_execution_20260521"`1000210003 - `name: "code_execution"`1000410005 Name of the tool.1000610007 This is how the tool will be called by the model and in `tool_use` blocks.1000810009 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1001010011 - `"direct"`1001210013 - `"code_execution_20250825"`1001410015 - `"code_execution_20260120"`1001610017 - `"code_execution_20260521"`1001810019 - `cache_control: optional CacheControlEphemeral or null`1002010021 Create a cache control breakpoint at this content block.1002210023 - `type: "ephemeral"`1002410025 - `ttl: optional "5m" or "1h"`1002610027 The time-to-live for the cache control breakpoint.1002810029 This may be one the following values:1003010031 - `5m`: 5 minutes10032 - `1h`: 1 hour1003310034 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.1003510036 - `"5m"`1003710038 - `"1h"`1003910040 - `defer_loading: optional boolean`1004110042 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1004310044 - `strict: optional boolean`1004510046 When true, guarantees schema validation on tool names and inputs1004710048### Code Execution Tool Result Block1004910050- `CodeExecutionToolResultBlock object`1005110052 - `type: "code_execution_tool_result"`1005310054 default: code_execution_tool_result1005510056 - `content: CodeExecutionToolResultBlockContent`1005710058 - `CodeExecutionToolResultError object`1005910060 - `type: "code_execution_tool_result_error"`1006110062 default: code_execution_tool_result_error1006310064 - `error_code: CodeExecutionToolResultErrorCode`1006510066 - `"invalid_tool_input"`1006710068 - `"unavailable"`1006910070 - `"too_many_requests"`1007110072 - `"execution_time_exceeded"`1007310074 - `CodeExecutionResultBlock object`1007510076 - `type: "code_execution_result"`1007710078 default: code_execution_result1007910080 - `content: array of CodeExecutionOutputBlock`1008110082 - `type: "code_execution_output"`1008310084 default: code_execution_output1008510086 - `file_id: string`1008710088 - `return_code: number`1008910090 - `stderr: string`1009110092 - `stdout: string`1009310094 - `EncryptedCodeExecutionResultBlock object`1009510096 Code execution result with encrypted stdout for PFC + web_search results.1009710098 - `type: "encrypted_code_execution_result"`1009910100 default: encrypted_code_execution_result1010110102 - `content: array of CodeExecutionOutputBlock`1010310104 - `type: "code_execution_output"`1010510106 default: code_execution_output1010710108 - `file_id: string`1010910110 - `encrypted_stdout: string`1011110112 - `return_code: number`1011310114 - `stderr: string`1011510116 - `tool_use_id: string`1011710118 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1011910120### Code Execution Tool Result Block Content1012110122- `CodeExecutionToolResultBlockContent = CodeExecutionToolResultError or CodeExecutionResultBlock or EncryptedCodeExecutionResultBlock`1012310124 - `CodeExecutionToolResultError object`1012510126 - `type: "code_execution_tool_result_error"`1012710128 default: code_execution_tool_result_error1012910130 - `error_code: CodeExecutionToolResultErrorCode`1013110132 - `"invalid_tool_input"`1013310134 - `"unavailable"`1013510136 - `"too_many_requests"`1013710138 - `"execution_time_exceeded"`1013910140 - `CodeExecutionResultBlock object`1014110142 - `type: "code_execution_result"`1014310144 default: code_execution_result1014510146 - `content: array of CodeExecutionOutputBlock`1014710148 - `type: "code_execution_output"`1014910150 default: code_execution_output1015110152 - `file_id: string`1015310154 - `return_code: number`1015510156 - `stderr: string`1015710158 - `stdout: string`1015910160 - `EncryptedCodeExecutionResultBlock object`1016110162 Code execution result with encrypted stdout for PFC + web_search results.1016310164 - `type: "encrypted_code_execution_result"`1016510166 default: encrypted_code_execution_result1016710168 - `content: array of CodeExecutionOutputBlock`1016910170 - `type: "code_execution_output"`1017110172 default: code_execution_output1017310174 - `file_id: string`1017510176 - `encrypted_stdout: string`1017710178 - `return_code: number`1017910180 - `stderr: string`1018110182### Code Execution Tool Result Block Param1018310184- `CodeExecutionToolResultBlockParam object`1018510186 - `type: "code_execution_tool_result"`1018710188 - `content: CodeExecutionToolResultBlockParamContent`1018910190 - `CodeExecutionToolResultErrorParam object`1019110192 - `type: "code_execution_tool_result_error"`1019310194 - `error_code: CodeExecutionToolResultErrorCode`1019510196 - `"invalid_tool_input"`1019710198 - `"unavailable"`1019910200 - `"too_many_requests"`1020110202 - `"execution_time_exceeded"`1020310204 - `CodeExecutionResultBlockParam object`1020510206 - `type: "code_execution_result"`1020710208 - `content: array of CodeExecutionOutputBlockParam`1020910210 - `type: "code_execution_output"`1021110212 - `file_id: string`1021310214 - `return_code: number`1021510216 - `stderr: string`1021710218 - `stdout: string`1021910220 - `EncryptedCodeExecutionResultBlockParam object`1022110222 Code execution result with encrypted stdout for PFC + web_search results.1022310224 - `type: "encrypted_code_execution_result"`1022510226 - `content: array of CodeExecutionOutputBlockParam`1022710228 - `type: "code_execution_output"`1022910230 - `file_id: string`1023110232 - `encrypted_stdout: string`1023310234 - `return_code: number`1023510236 - `stderr: string`1023710238 - `tool_use_id: string`1023910240 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1024110242 - `cache_control: optional CacheControlEphemeral or null`1024310244 Create a cache control breakpoint at this content block.1024510246 - `type: "ephemeral"`1024710248 - `ttl: optional "5m" or "1h"`1024910250 The time-to-live for the cache control breakpoint.1025110252 This may be one the following values:1025310254 - `5m`: 5 minutes10255 - `1h`: 1 hour1025610257 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.1025810259 - `"5m"`1026010261 - `"1h"`1026210263### Code Execution Tool Result Block Param Content1026410265- `CodeExecutionToolResultBlockParamContent = CodeExecutionToolResultErrorParam or CodeExecutionResultBlockParam or EncryptedCodeExecutionResultBlockParam`1026610267 - `CodeExecutionToolResultErrorParam object`1026810269 - `type: "code_execution_tool_result_error"`1027010271 - `error_code: CodeExecutionToolResultErrorCode`1027210273 - `"invalid_tool_input"`1027410275 - `"unavailable"`1027610277 - `"too_many_requests"`1027810279 - `"execution_time_exceeded"`1028010281 - `CodeExecutionResultBlockParam object`1028210283 - `type: "code_execution_result"`1028410285 - `content: array of CodeExecutionOutputBlockParam`1028610287 - `type: "code_execution_output"`1028810289 - `file_id: string`1029010291 - `return_code: number`1029210293 - `stderr: string`1029410295 - `stdout: string`1029610297 - `EncryptedCodeExecutionResultBlockParam object`1029810299 Code execution result with encrypted stdout for PFC + web_search results.1030010301 - `type: "encrypted_code_execution_result"`1030210303 - `content: array of CodeExecutionOutputBlockParam`1030410305 - `type: "code_execution_output"`1030610307 - `file_id: string`1030810309 - `encrypted_stdout: string`1031010311 - `return_code: number`1031210313 - `stderr: string`1031410315### Code Execution Tool Result Error1031610317- `CodeExecutionToolResultError object`1031810319 - `type: "code_execution_tool_result_error"`1032010321 default: code_execution_tool_result_error1032210323 - `error_code: CodeExecutionToolResultErrorCode`1032410325 - `"invalid_tool_input"`1032610327 - `"unavailable"`1032810329 - `"too_many_requests"`1033010331 - `"execution_time_exceeded"`1033210333### Code Execution Tool Result Error Code1033410335- `CodeExecutionToolResultErrorCode = "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"`1033610337 - `"invalid_tool_input"`1033810339 - `"unavailable"`1034010341 - `"too_many_requests"`1034210343 - `"execution_time_exceeded"`1034410345### Code Execution Tool Result Error Param1034610347- `CodeExecutionToolResultErrorParam object`1034810349 - `type: "code_execution_tool_result_error"`1035010351 - `error_code: CodeExecutionToolResultErrorCode`1035210353 - `"invalid_tool_input"`1035410355 - `"unavailable"`1035610357 - `"too_many_requests"`1035810359 - `"execution_time_exceeded"`1036010361### Computer Cursor Position Config1036210363- `ComputerCursorPositionConfig object`1036410365 `cursor_position`'s config overrides.1036610367 - `defer_loading: optional boolean or null`1036810369 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1037010371 - `enabled: optional boolean or null`1037210373 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1037410375### Computer Double Click Config1037610377- `ComputerDoubleClickConfig object`1037810379 `double_click`'s config overrides.1038010381 - `defer_loading: optional boolean or null`1038210383 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1038410385 - `enabled: optional boolean or null`1038610387 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1038810389### Computer Hold Key Config1039010391- `ComputerHoldKeyConfig object`1039210393 `hold_key`'s config overrides.1039410395 - `defer_loading: optional boolean or null`1039610397 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1039810399 - `enabled: optional boolean or null`1040010401 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1040210403### Computer Key Config1040410405- `ComputerKeyConfig object`1040610407 `key`'s config overrides.1040810409 - `defer_loading: optional boolean or null`1041010411 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1041210413 - `enabled: optional boolean or null`1041410415 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1041610417### Computer Left Click Config1041810419- `ComputerLeftClickConfig object`1042010421 `left_click`'s config overrides.1042210423 - `defer_loading: optional boolean or null`1042410425 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1042610427 - `enabled: optional boolean or null`1042810429 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1043010431### Computer Left Click Drag Config1043210433- `ComputerLeftClickDragConfig object`1043410435 `left_click_drag`'s config overrides.1043610437 - `defer_loading: optional boolean or null`1043810439 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1044010441 - `enabled: optional boolean or null`1044210443 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1044410445### Computer Left Mouse Down Config1044610447- `ComputerLeftMouseDownConfig object`1044810449 `left_mouse_down`'s config overrides.1045010451 - `defer_loading: optional boolean or null`1045210453 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1045410455 - `enabled: optional boolean or null`1045610457 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1045810459### Computer Left Mouse Up Config1046010461- `ComputerLeftMouseUpConfig object`1046210463 `left_mouse_up`'s config overrides.1046410465 - `defer_loading: optional boolean or null`1046610467 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1046810469 - `enabled: optional boolean or null`1047010471 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1047210473### Computer Middle Click Config1047410475- `ComputerMiddleClickConfig object`1047610477 `middle_click`'s config overrides.1047810479 - `defer_loading: optional boolean or null`1048010481 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1048210483 - `enabled: optional boolean or null`1048410485 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1048610487### Computer Mouse Move Config1048810489- `ComputerMouseMoveConfig object`1049010491 `mouse_move`'s config overrides.1049210493 - `defer_loading: optional boolean or null`1049410495 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1049610497 - `enabled: optional boolean or null`1049810499 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1050010501### Computer Right Click Config1050210503- `ComputerRightClickConfig object`1050410505 `right_click`'s config overrides.1050610507 - `defer_loading: optional boolean or null`1050810509 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1051010511 - `enabled: optional boolean or null`1051210513 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1051410515### Computer Screenshot Config1051610517- `ComputerScreenshotConfig object`1051810519 `screenshot`'s config overrides.1052010521 - `defer_loading: optional boolean or null`1052210523 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1052410525 - `enabled: optional boolean or null`1052610527 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1052810529### Computer Scroll Config1053010531- `ComputerScrollConfig object`1053210533 `scroll`'s config overrides.1053410535 - `defer_loading: optional boolean or null`1053610537 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1053810539 - `enabled: optional boolean or null`1054010541 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1054210543### Computer Toolset 202608011054410545- `ComputerToolset20260801 object`1054610547 The computer toolset: a single `tools[]` entry (carrying no10548 `name`) that declares the computer tool family. The model is10549 served the family's tool with any members disabled via `configs`10550 removed from its schema. Every member is enabled by default, zoom10551 included. The single-tool options `display_number` and10552 `enable_zoom` are not fields of a toolset entry — it carries only10553 `type`, `configs`, and `cache_control`; zoom is controlled10554 via `configs.zoom.enabled`.1055510556 - `type: "computer_toolset_20260801"`1055710558 - `cache_control: optional CacheControlEphemeral or null`1055910560 Create a cache control breakpoint at this content block.1056110562 - `type: "ephemeral"`1056310564 - `ttl: optional "5m" or "1h"`1056510566 The time-to-live for the cache control breakpoint.1056710568 This may be one the following values:1056910570 - `5m`: 5 minutes10571 - `1h`: 1 hour1057210573 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.1057410575 - `"5m"`1057610577 - `"1h"`1057810579 - `configs: optional ComputerToolsetConfigs or null`1058010581 Per-member configuration for `computer_toolset_20260801`: one10582 optional field per member tool, keyed by the member name — the same10583 name the member's `tool_use` blocks carry. Every member is an10584 accepted key, and a member's defaults apply wherever its key is10585 absent. Unknown keys are rejected: the field set is this toolset10586 version's complete member set.1058710588 - `type: optional ComputerTypeConfig or null`1058910590 `type`'s config overrides.1059110592 - `defer_loading: optional boolean or null`1059310594 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1059510596 - `enabled: optional boolean or null`1059710598 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1059910600 - `cursor_position: optional ComputerCursorPositionConfig or null`1060110602 `cursor_position`'s config overrides.1060310604 - `defer_loading: optional boolean or null`1060510606 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1060710608 - `enabled: optional boolean or null`1060910610 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1061110612 - `double_click: optional ComputerDoubleClickConfig or null`1061310614 `double_click`'s config overrides.1061510616 - `defer_loading: optional boolean or null`1061710618 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1061910620 - `enabled: optional boolean or null`1062110622 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1062310624 - `hold_key: optional ComputerHoldKeyConfig or null`1062510626 `hold_key`'s config overrides.1062710628 - `defer_loading: optional boolean or null`1062910630 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1063110632 - `enabled: optional boolean or null`1063310634 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1063510636 - `key: optional ComputerKeyConfig or null`1063710638 `key`'s config overrides.1063910640 - `defer_loading: optional boolean or null`1064110642 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1064310644 - `enabled: optional boolean or null`1064510646 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1064710648 - `left_click: optional ComputerLeftClickConfig or null`1064910650 `left_click`'s config overrides.1065110652 - `defer_loading: optional boolean or null`1065310654 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1065510656 - `enabled: optional boolean or null`1065710658 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1065910660 - `left_click_drag: optional ComputerLeftClickDragConfig or null`1066110662 `left_click_drag`'s config overrides.1066310664 - `defer_loading: optional boolean or null`1066510666 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1066710668 - `enabled: optional boolean or null`1066910670 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1067110672 - `left_mouse_down: optional ComputerLeftMouseDownConfig or null`1067310674 `left_mouse_down`'s config overrides.1067510676 - `defer_loading: optional boolean or null`1067710678 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1067910680 - `enabled: optional boolean or null`1068110682 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1068310684 - `left_mouse_up: optional ComputerLeftMouseUpConfig or null`1068510686 `left_mouse_up`'s config overrides.1068710688 - `defer_loading: optional boolean or null`1068910690 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1069110692 - `enabled: optional boolean or null`1069310694 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1069510696 - `middle_click: optional ComputerMiddleClickConfig or null`1069710698 `middle_click`'s config overrides.1069910700 - `defer_loading: optional boolean or null`1070110702 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1070310704 - `enabled: optional boolean or null`1070510706 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1070710708 - `mouse_move: optional ComputerMouseMoveConfig or null`1070910710 `mouse_move`'s config overrides.1071110712 - `defer_loading: optional boolean or null`1071310714 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1071510716 - `enabled: optional boolean or null`1071710718 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1071910720 - `right_click: optional ComputerRightClickConfig or null`1072110722 `right_click`'s config overrides.1072310724 - `defer_loading: optional boolean or null`1072510726 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1072710728 - `enabled: optional boolean or null`1072910730 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1073110732 - `screenshot: optional ComputerScreenshotConfig or null`1073310734 `screenshot`'s config overrides.1073510736 - `defer_loading: optional boolean or null`1073710738 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1073910740 - `enabled: optional boolean or null`1074110742 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1074310744 - `scroll: optional ComputerScrollConfig or null`1074510746 `scroll`'s config overrides.1074710748 - `defer_loading: optional boolean or null`1074910750 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1075110752 - `enabled: optional boolean or null`1075310754 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1075510756 - `triple_click: optional ComputerTripleClickConfig or null`1075710758 `triple_click`'s config overrides.1075910760 - `defer_loading: optional boolean or null`1076110762 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1076310764 - `enabled: optional boolean or null`1076510766 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1076710768 - `wait: optional ComputerWaitConfig or null`1076910770 `wait`'s config overrides.1077110772 - `defer_loading: optional boolean or null`1077310774 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1077510776 - `enabled: optional boolean or null`1077710778 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1077910780 - `zoom: optional ComputerZoomConfig or null`1078110782 `zoom`'s config overrides.1078310784 - `defer_loading: optional boolean or null`1078510786 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1078710788 - `enabled: optional boolean or null`1078910790 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1079110792### Computer Toolset Configs1079310794- `ComputerToolsetConfigs object`1079510796 Per-member configuration for `computer_toolset_20260801`: one10797 optional field per member tool, keyed by the member name — the same10798 name the member's `tool_use` blocks carry. Every member is an10799 accepted key, and a member's defaults apply wherever its key is10800 absent. Unknown keys are rejected: the field set is this toolset10801 version's complete member set.1080210803 - `type: optional ComputerTypeConfig or null`1080410805 `type`'s config overrides.1080610807 - `defer_loading: optional boolean or null`1080810809 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1081010811 - `enabled: optional boolean or null`1081210813 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1081410815 - `cursor_position: optional ComputerCursorPositionConfig or null`1081610817 `cursor_position`'s config overrides.1081810819 - `defer_loading: optional boolean or null`1082010821 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1082210823 - `enabled: optional boolean or null`1082410825 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1082610827 - `double_click: optional ComputerDoubleClickConfig or null`1082810829 `double_click`'s config overrides.1083010831 - `defer_loading: optional boolean or null`1083210833 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1083410835 - `enabled: optional boolean or null`1083610837 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1083810839 - `hold_key: optional ComputerHoldKeyConfig or null`1084010841 `hold_key`'s config overrides.1084210843 - `defer_loading: optional boolean or null`1084410845 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1084610847 - `enabled: optional boolean or null`1084810849 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1085010851 - `key: optional ComputerKeyConfig or null`1085210853 `key`'s config overrides.1085410855 - `defer_loading: optional boolean or null`1085610857 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1085810859 - `enabled: optional boolean or null`1086010861 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1086210863 - `left_click: optional ComputerLeftClickConfig or null`1086410865 `left_click`'s config overrides.1086610867 - `defer_loading: optional boolean or null`1086810869 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1087010871 - `enabled: optional boolean or null`1087210873 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1087410875 - `left_click_drag: optional ComputerLeftClickDragConfig or null`1087610877 `left_click_drag`'s config overrides.1087810879 - `defer_loading: optional boolean or null`1088010881 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1088210883 - `enabled: optional boolean or null`1088410885 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1088610887 - `left_mouse_down: optional ComputerLeftMouseDownConfig or null`1088810889 `left_mouse_down`'s config overrides.1089010891 - `defer_loading: optional boolean or null`1089210893 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1089410895 - `enabled: optional boolean or null`1089610897 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1089810899 - `left_mouse_up: optional ComputerLeftMouseUpConfig or null`1090010901 `left_mouse_up`'s config overrides.1090210903 - `defer_loading: optional boolean or null`1090410905 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1090610907 - `enabled: optional boolean or null`1090810909 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1091010911 - `middle_click: optional ComputerMiddleClickConfig or null`1091210913 `middle_click`'s config overrides.1091410915 - `defer_loading: optional boolean or null`1091610917 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1091810919 - `enabled: optional boolean or null`1092010921 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1092210923 - `mouse_move: optional ComputerMouseMoveConfig or null`1092410925 `mouse_move`'s config overrides.1092610927 - `defer_loading: optional boolean or null`1092810929 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1093010931 - `enabled: optional boolean or null`1093210933 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1093410935 - `right_click: optional ComputerRightClickConfig or null`1093610937 `right_click`'s config overrides.1093810939 - `defer_loading: optional boolean or null`1094010941 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1094210943 - `enabled: optional boolean or null`1094410945 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1094610947 - `screenshot: optional ComputerScreenshotConfig or null`1094810949 `screenshot`'s config overrides.1095010951 - `defer_loading: optional boolean or null`1095210953 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1095410955 - `enabled: optional boolean or null`1095610957 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1095810959 - `scroll: optional ComputerScrollConfig or null`1096010961 `scroll`'s config overrides.1096210963 - `defer_loading: optional boolean or null`1096410965 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1096610967 - `enabled: optional boolean or null`1096810969 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1097010971 - `triple_click: optional ComputerTripleClickConfig or null`1097210973 `triple_click`'s config overrides.1097410975 - `defer_loading: optional boolean or null`1097610977 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1097810979 - `enabled: optional boolean or null`1098010981 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1098210983 - `wait: optional ComputerWaitConfig or null`1098410985 `wait`'s config overrides.1098610987 - `defer_loading: optional boolean or null`1098810989 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1099010991 - `enabled: optional boolean or null`1099210993 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1099410995 - `zoom: optional ComputerZoomConfig or null`1099610997 `zoom`'s config overrides.1099810999 - `defer_loading: optional boolean or null`1100011001 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1100211003 - `enabled: optional boolean or null`1100411005 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1100611007### Computer Triple Click Config1100811009- `ComputerTripleClickConfig object`1101011011 `triple_click`'s config overrides.1101211013 - `defer_loading: optional boolean or null`1101411015 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1101611017 - `enabled: optional boolean or null`1101811019 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1102011021### Computer Type Config1102211023- `ComputerTypeConfig object`1102411025 `type`'s config overrides.1102611027 - `defer_loading: optional boolean or null`1102811029 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1103011031 - `enabled: optional boolean or null`1103211033 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1103411035### Computer Wait Config1103611037- `ComputerWaitConfig object`1103811039 `wait`'s config overrides.1104011041 - `defer_loading: optional boolean or null`1104211043 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1104411045 - `enabled: optional boolean or null`1104611047 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1104811049### Computer Zoom Config1105011051- `ComputerZoomConfig object`1105211053 `zoom`'s config overrides.1105411055 - `defer_loading: optional boolean or null`1105611057 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1105811059 - `enabled: optional boolean or null`1106011061 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1106211063### Container1106411065- `Container object`1106611067 Information about the container used in the request (for the code execution tool)1106811069 - `id: string`1107011071 Identifier for the container used in this request1107211073 - `expires_at: string`1107411075 The time at which the container will expire.1107611077 format: date-time1107811079 - `skills: array of ContainerSkill or null`1108011081 Skills loaded in the container1108211083 - `type: "anthropic" or "custom"`1108411085 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)1108611087 - `"anthropic"`1108811089 - `"custom"`1109011091 - `skill_id: string`1109211093 Skill ID1109411095 maxLength: 64, minLength: 11109611097 - `version: string`1109811099 The resolved version: a skill version ID for custom skills.1110011101 maxLength: 64, minLength: 11110211103### Container Params1110411105- `ContainerParams object`1110611107 Container parameters with skills to be loaded.1110811109 - `id: optional string or null`1111011111 Container id1111211113 - `skills: optional array of SkillParams or null`1111411115 List of skills to load in the container1111611117 maxItems: 201111811119 - `type: "anthropic" or "custom"`1112011121 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)1112211123 - `"anthropic"`1112411125 - `"custom"`1112611127 - `skill_id: string`1112811129 Skill ID1113011131 maxLength: 64, minLength: 11113211133 - `version: optional string`1113411135 Skill version or 'latest' for most recent version1113611137 maxLength: 64, minLength: 11113811139### Container Skill1114011141- `ContainerSkill object`1114211143 A skill that was loaded in a container (response model).1114411145 - `type: "anthropic" or "custom"`1114611147 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)1114811149 - `"anthropic"`1115011151 - `"custom"`1115211153 - `skill_id: string`1115411155 Skill ID1115611157 maxLength: 64, minLength: 11115811159 - `version: string`1116011161 The resolved version: a skill version ID for custom skills.1116211163 maxLength: 64, minLength: 11116411165### Container Upload Block1116611167- `ContainerUploadBlock object`1116811169 Response model for a file uploaded to the container.1117011171 - `type: "container_upload"`1117211173 default: container_upload1117411175 - `file_id: string`1117611177### Container Upload Block Param1117811179- `ContainerUploadBlockParam object`1118011181 A content block that represents a file to be uploaded to the container11182 Files uploaded via this block will be available in the container's input directory.1118311184 - `type: "container_upload"`1118511186 - `file_id: string`1118711188 - `cache_control: optional CacheControlEphemeral or null`1118911190 Create a cache control breakpoint at this content block.1119111192 - `type: "ephemeral"`1119311194 - `ttl: optional "5m" or "1h"`1119511196 The time-to-live for the cache control breakpoint.1119711198 This may be one the following values:1119911200 - `5m`: 5 minutes11201 - `1h`: 1 hour1120211203 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.1120411205 - `"5m"`1120611207 - `"1h"`1120811209### Content Block1121011211- `ContentBlock = TextBlock or ThinkingBlock or RedactedThinkingBlock or 9 more`1121211213 - `TextBlock object`1121411215 - `type: "text"`1121611217 default: text1121811219 - `citations: array of TextCitation or null`1122011221 Citations supporting the text block.1122211223 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`.1122411225 - `CitationCharLocation object`1122611227 - `type: "char_location"`1122811229 default: char_location1123011231 - `cited_text: string`1123211233 - `document_index: number`1123411235 minimum: 01123611237 - `document_title: string or null`1123811239 - `end_char_index: number`1124011241 - `file_id: string or null`1124211243 - `start_char_index: number`1124411245 minimum: 01124611247 - `CitationPageLocation object`1124811249 - `type: "page_location"`1125011251 default: page_location1125211253 - `cited_text: string`1125411255 - `document_index: number`1125611257 minimum: 01125811259 - `document_title: string or null`1126011261 - `end_page_number: number`1126211263 - `file_id: string or null`1126411265 - `start_page_number: number`1126611267 minimum: 11126811269 - `CitationContentBlockLocation object`1127011271 - `type: "content_block_location"`1127211273 default: content_block_location1127411275 - `cited_text: string`1127611277 The full text of the cited block range, concatenated.1127811279 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.1128011281 - `document_index: number`1128211283 minimum: 01128411285 - `document_title: string or null`1128611287 - `end_block_index: number`1128811289 Exclusive 0-based end index of the cited block range in the source's `content` array.1129011291 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1129211293 - `file_id: string or null`1129411295 - `start_block_index: number`1129611297 0-based index of the first cited block in the source's `content` array.1129811299 minimum: 01130011301 - `CitationsWebSearchResultLocation object`1130211303 - `type: "web_search_result_location"`1130411305 default: web_search_result_location1130611307 - `cited_text: string`1130811309 - `encrypted_index: string`1131011311 - `title: string or null`1131211313 maxLength: 5121131411315 - `url: string`1131611317 - `CitationsSearchResultLocation object`1131811319 - `type: "search_result_location"`1132011321 default: search_result_location1132211323 - `cited_text: string`1132411325 The full text of the cited block range, concatenated.1132611327 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.1132811329 - `end_block_index: number`1133011331 Exclusive 0-based end index of the cited block range in the source's `content` array.1133211333 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1133411335 - `search_result_index: number`1133611337 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.1133811339 Counted separately from `document_index`; server-side web search results are not included in this count.1134011341 minimum: 01134211343 - `source: string`1134411345 - `start_block_index: number`1134611347 0-based index of the first cited block in the source's `content` array.1134811349 minimum: 01135011351 - `title: string or null`1135211353 - `text: string`1135411355 minLength: 01135611357 - `ThinkingBlock object`1135811359 - `type: "thinking"`1136011361 default: thinking1136211363 - `signature: string`1136411365 A value used to verify that this thinking block was generated by Claude when it is passed back to the API.1136611367 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.1136811369 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.1137011371 - `thinking: string`1137211373 The text of Claude's thinking process for this block.1137411375 - `RedactedThinkingBlock object`1137611377 - `type: "redacted_thinking"`1137811379 default: redacted_thinking1138011381 - `data: string`1138211383 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.1138411385 Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.1138611387 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.1138811389 - `ToolUseBlock object`1139011391 - `type: "tool_use"`1139211393 default: tool_use1139411395 - `id: string`1139611397 pattern: ^[a-zA-Z0-9_-]+$1139811399 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`1140011401 default: {"type":"direct"}1140211403 - `DirectCaller object`1140411405 Tool invocation directly from the model.1140611407 - `type: "direct"`1140811409 - `ServerToolCaller object`1141011411 Tool invocation generated by a server-side tool.1141211413 - `type: "code_execution_20250825"`1141411415 - `tool_id: string`1141611417 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1141811419 - `ServerToolCaller20260120 object`1142011421 - `type: "code_execution_20260120"`1142211423 - `tool_id: string`1142411425 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1142611427 - `input: map[unknown]`1142811429 - `name: string`1143011431 minLength: 11143211433 - `toolset_name: optional string or null`1143411435 For a toolset member tool_use, the toolset family.1143611437 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$1143811439 - `ServerToolUseBlock object`1144011441 - `type: "server_tool_use"`1144211443 default: server_tool_use1144411445 - `id: string`1144611447 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1144811449 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`1145011451 default: {"type":"direct"}1145211453 - `DirectCaller object`1145411455 Tool invocation directly from the model.1145611457 - `ServerToolCaller object`1145811459 Tool invocation generated by a server-side tool.1146011461 - `ServerToolCaller20260120 object`1146211463 - `input: map[unknown]`1146411465 - `name: "web_search" or "web_fetch" or "code_execution" or 4 more`1146611467 - `"web_search"`1146811469 - `"web_fetch"`1147011471 - `"code_execution"`1147211473 - `"bash_code_execution"`1147411475 - `"text_editor_code_execution"`1147611477 - `"tool_search_tool_regex"`1147811479 - `"tool_search_tool_bm25"`1148011481 - `WebSearchToolResultBlock object`1148211483 - `type: "web_search_tool_result"`1148411485 default: web_search_tool_result1148611487 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`1148811489 default: {"type":"direct"}1149011491 - `DirectCaller object`1149211493 Tool invocation directly from the model.1149411495 - `ServerToolCaller object`1149611497 Tool invocation generated by a server-side tool.1149811499 - `ServerToolCaller20260120 object`1150011501 - `content: WebSearchToolResultBlockContent`1150211503 - `WebSearchToolResultError object`1150411505 - `type: "web_search_tool_result_error"`1150611507 default: web_search_tool_result_error1150811509 - `error_code: WebSearchToolResultErrorCode`1151011511 - `"invalid_tool_input"`1151211513 - `"unavailable"`1151411515 - `"max_uses_exceeded"`1151611517 - `"too_many_requests"`1151811519 - `"query_too_long"`1152011521 - `"request_too_large"`1152211523 - `array of WebSearchResultBlock`1152411525 - `type: "web_search_result"`1152611527 default: web_search_result1152811529 - `encrypted_content: string`1153011531 - `page_age: string or null`1153211533 - `title: string`1153411535 - `url: string`1153611537 - `tool_use_id: string`1153811539 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1154011541 - `WebFetchToolResultBlock object`1154211543 - `type: "web_fetch_tool_result"`1154411545 default: web_fetch_tool_result1154611547 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`1154811549 default: {"type":"direct"}1155011551 - `DirectCaller object`1155211553 Tool invocation directly from the model.1155411555 - `ServerToolCaller object`1155611557 Tool invocation generated by a server-side tool.1155811559 - `ServerToolCaller20260120 object`1156011561 - `content: WebFetchToolResultErrorBlock or WebFetchBlock`1156211563 - `WebFetchToolResultErrorBlock object`1156411565 - `type: "web_fetch_tool_result_error"`1156611567 default: web_fetch_tool_result_error1156811569 - `error_code: WebFetchToolResultErrorCode`1157011571 - `"invalid_tool_input"`1157211573 - `"url_too_long"`1157411575 - `"url_not_allowed"`1157611577 - `"url_not_in_prior_context"`1157811579 - `"url_not_accessible"`1158011581 - `"unsupported_content_type"`1158211583 - `"too_many_requests"`1158411585 - `"max_uses_exceeded"`1158611587 - `"unavailable"`1158811589 - `"content_too_large"`1159011591 - `WebFetchBlock object`1159211593 - `type: "web_fetch_result"`1159411595 default: web_fetch_result1159611597 - `content: DocumentBlock`1159811599 - `type: "document"`1160011601 default: document1160211603 - `citations: CitationsConfig or null`1160411605 Citation configuration for the document1160611607 - `enabled: boolean`1160811609 default: false1161011611 - `source: Base64PDFSource or PlainTextSource`1161211613 - `Base64PDFSource object`1161411615 - `type: "base64"`1161611617 - `data: string`1161811619 format: byte1162011621 - `media_type: "application/pdf"`1162211623 - `PlainTextSource object`1162411625 - `type: "text"`1162611627 - `data: string`1162811629 - `media_type: "text/plain"`1163011631 - `title: string or null`1163211633 The title of the document1163411635 - `retrieved_at: string or null`1163611637 ISO 8601 timestamp when the content was retrieved1163811639 - `url: string`1164011641 Fetched content URL1164211643 - `tool_use_id: string`1164411645 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1164611647 - `CodeExecutionToolResultBlock object`1164811649 - `type: "code_execution_tool_result"`1165011651 default: code_execution_tool_result1165211653 - `content: CodeExecutionToolResultBlockContent`1165411655 - `CodeExecutionToolResultError object`1165611657 - `type: "code_execution_tool_result_error"`1165811659 default: code_execution_tool_result_error1166011661 - `error_code: CodeExecutionToolResultErrorCode`1166211663 - `"invalid_tool_input"`1166411665 - `"unavailable"`1166611667 - `"too_many_requests"`1166811669 - `"execution_time_exceeded"`1167011671 - `CodeExecutionResultBlock object`1167211673 - `type: "code_execution_result"`1167411675 default: code_execution_result1167611677 - `content: array of CodeExecutionOutputBlock`1167811679 - `type: "code_execution_output"`1168011681 default: code_execution_output1168211683 - `file_id: string`1168411685 - `return_code: number`1168611687 - `stderr: string`1168811689 - `stdout: string`1169011691 - `EncryptedCodeExecutionResultBlock object`1169211693 Code execution result with encrypted stdout for PFC + web_search results.1169411695 - `type: "encrypted_code_execution_result"`1169611697 default: encrypted_code_execution_result1169811699 - `content: array of CodeExecutionOutputBlock`1170011701 - `type: "code_execution_output"`1170211703 default: code_execution_output1170411705 - `file_id: string`1170611707 - `encrypted_stdout: string`1170811709 - `return_code: number`1171011711 - `stderr: string`1171211713 - `tool_use_id: string`1171411715 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1171611717 - `BashCodeExecutionToolResultBlock object`1171811719 - `type: "bash_code_execution_tool_result"`1172011721 default: bash_code_execution_tool_result1172211723 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`1172411725 - `BashCodeExecutionToolResultError object`1172611727 - `type: "bash_code_execution_tool_result_error"`1172811729 default: bash_code_execution_tool_result_error1173011731 - `error_code: BashCodeExecutionToolResultErrorCode`1173211733 - `"invalid_tool_input"`1173411735 - `"unavailable"`1173611737 - `"too_many_requests"`1173811739 - `"execution_time_exceeded"`1174011741 - `"output_file_too_large"`1174211743 - `BashCodeExecutionResultBlock object`1174411745 - `type: "bash_code_execution_result"`1174611747 default: bash_code_execution_result1174811749 - `content: array of BashCodeExecutionOutputBlock`1175011751 - `type: "bash_code_execution_output"`1175211753 default: bash_code_execution_output1175411755 - `file_id: string`1175611757 - `return_code: number`1175811759 - `stderr: string`1176011761 - `stdout: string`1176211763 - `tool_use_id: string`1176411765 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1176611767 - `TextEditorCodeExecutionToolResultBlock object`1176811769 - `type: "text_editor_code_execution_tool_result"`1177011771 default: text_editor_code_execution_tool_result1177211773 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`1177411775 - `TextEditorCodeExecutionToolResultError object`1177611777 - `type: "text_editor_code_execution_tool_result_error"`1177811779 default: text_editor_code_execution_tool_result_error1178011781 - `error_code: TextEditorCodeExecutionToolResultErrorCode`1178211783 - `"invalid_tool_input"`1178411785 - `"unavailable"`1178611787 - `"too_many_requests"`1178811789 - `"execution_time_exceeded"`1179011791 - `"file_not_found"`1179211793 - `error_message: string or null`1179411795 - `TextEditorCodeExecutionViewResultBlock object`1179611797 - `type: "text_editor_code_execution_view_result"`1179811799 default: text_editor_code_execution_view_result1180011801 - `content: string`1180211803 - `file_type: "text" or "image" or "pdf"`1180411805 - `"text"`1180611807 - `"image"`1180811809 - `"pdf"`1181011811 - `num_lines: number or null`1181211813 - `start_line: number or null`1181411815 - `total_lines: number or null`1181611817 - `TextEditorCodeExecutionCreateResultBlock object`1181811819 - `type: "text_editor_code_execution_create_result"`1182011821 default: text_editor_code_execution_create_result1182211823 - `is_file_update: boolean`1182411825 - `TextEditorCodeExecutionStrReplaceResultBlock object`1182611827 - `type: "text_editor_code_execution_str_replace_result"`1182811829 default: text_editor_code_execution_str_replace_result1183011831 - `lines: array of string or null`1183211833 - `new_lines: number or null`1183411835 - `new_start: number or null`1183611837 - `old_lines: number or null`1183811839 - `old_start: number or null`1184011841 - `tool_use_id: string`1184211843 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1184411845 - `ToolSearchToolResultBlock object`1184611847 - `type: "tool_search_tool_result"`1184811849 default: tool_search_tool_result1185011851 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`1185211853 - `ToolSearchToolResultError object`1185411855 - `type: "tool_search_tool_result_error"`1185611857 default: tool_search_tool_result_error1185811859 - `error_code: ToolSearchToolResultErrorCode`1186011861 - `"invalid_tool_input"`1186211863 - `"unavailable"`1186411865 - `"too_many_requests"`1186611867 - `"execution_time_exceeded"`1186811869 - `error_message: string or null`1187011871 - `ToolSearchToolSearchResultBlock object`1187211873 - `type: "tool_search_tool_search_result"`1187411875 default: tool_search_tool_search_result1187611877 - `tool_references: array of ToolReferenceBlock`1187811879 - `type: "tool_reference"`1188011881 default: tool_reference1188211883 - `tool_name: string`1188411885 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$1188611887 - `tool_use_id: string`1188811889 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1189011891 - `ContainerUploadBlock object`1189211893 Response model for a file uploaded to the container.1189411895 - `type: "container_upload"`1189611897 default: container_upload1189811899 - `file_id: string`1190011901### Content Block Param1190211903- `ContentBlockParam = TextBlockParam or ImageBlockParam or DocumentBlockParam or 13 more`1190411905 - `TextBlockParam object`1190611907 - `type: "text"`1190811909 - `text: string`1191011911 minLength: 11191211913 - `cache_control: optional CacheControlEphemeral or null`1191411915 Create a cache control breakpoint at this content block.1191611917 - `type: "ephemeral"`1191811919 - `ttl: optional "5m" or "1h"`1192011921 The time-to-live for the cache control breakpoint.1192211923 This may be one the following values:1192411925 - `5m`: 5 minutes11926 - `1h`: 1 hour1192711928 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.1192911930 - `"5m"`1193111932 - `"1h"`1193311934 - `citations: optional array of TextCitationParam or null`1193511936 - `CitationCharLocationParam object`1193711938 - `type: "char_location"`1193911940 - `cited_text: string`1194111942 - `document_index: number`1194311944 minimum: 01194511946 - `document_title: string or null`1194711948 maxLength: 500, minLength: 11194911950 - `end_char_index: number`1195111952 - `start_char_index: number`1195311954 minimum: 01195511956 - `CitationPageLocationParam object`1195711958 - `type: "page_location"`1195911960 - `cited_text: string`1196111962 - `document_index: number`1196311964 minimum: 01196511966 - `document_title: string or null`1196711968 maxLength: 500, minLength: 11196911970 - `end_page_number: number`1197111972 - `start_page_number: number`1197311974 minimum: 11197511976 - `CitationContentBlockLocationParam object`1197711978 - `type: "content_block_location"`1197911980 - `cited_text: string`1198111982 The full text of the cited block range, concatenated.1198311984 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.1198511986 - `document_index: number`1198711988 minimum: 01198911990 - `document_title: string or null`1199111992 maxLength: 500, minLength: 11199311994 - `end_block_index: number`1199511996 Exclusive 0-based end index of the cited block range in the source's `content` array.1199711998 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1199912000 - `start_block_index: number`1200112002 0-based index of the first cited block in the source's `content` array.1200312004 minimum: 01200512006 - `CitationWebSearchResultLocationParam object`1200712008 - `type: "web_search_result_location"`1200912010 - `cited_text: string`1201112012 - `encrypted_index: string`1201312014 - `title: string or null`1201512016 maxLength: 512, minLength: 11201712018 - `url: string`1201912020 minLength: 11202112022 - `CitationSearchResultLocationParam object`1202312024 - `type: "search_result_location"`1202512026 - `cited_text: string`1202712028 The full text of the cited block range, concatenated.1202912030 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.1203112032 - `end_block_index: number`1203312034 Exclusive 0-based end index of the cited block range in the source's `content` array.1203512036 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1203712038 - `search_result_index: number`1203912040 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.1204112042 Counted separately from `document_index`; server-side web search results are not included in this count.1204312044 minimum: 01204512046 - `source: string`1204712048 - `start_block_index: number`1204912050 0-based index of the first cited block in the source's `content` array.1205112052 minimum: 01205312054 - `title: string or null`1205512056 - `ImageBlockParam object`1205712058 - `type: "image"`1205912060 - `source: Base64ImageSource or URLImageSource or FileImageSource`1206112062 - `Base64ImageSource object`1206312064 - `type: "base64"`1206512066 - `data: string`1206712068 format: byte1206912070 - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"`1207112072 - `"image/jpeg"`1207312074 - `"image/png"`1207512076 - `"image/gif"`1207712078 - `"image/webp"`1207912080 - `URLImageSource object`1208112082 - `type: "url"`1208312084 - `url: string`1208512086 - `FileImageSource object`1208712088 - `type: "file"`1208912090 - `file_id: string`1209112092 - `cache_control: optional CacheControlEphemeral or null`1209312094 Create a cache control breakpoint at this content block.1209512096 - `transformations: optional ImageTransformationsParam or null`1209712098 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.1209912100 - `oversized_image: optional "downsize" or "error"`1210112102 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.1210312104 - `"downsize"`1210512106 - `"error"`1210712108 - `DocumentBlockParam object`1210912110 - `type: "document"`1211112112 - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more`1211312114 - `Base64PDFSource object`1211512116 - `type: "base64"`1211712118 - `data: string`1211912120 format: byte1212112122 - `media_type: "application/pdf"`1212312124 - `PlainTextSource object`1212512126 - `type: "text"`1212712128 - `data: string`1212912130 - `media_type: "text/plain"`1213112132 - `ContentBlockSource object`1213312134 - `type: "content"`1213512136 - `content: string or array of ContentBlockSourceContent`1213712138 - `string`1213912140 - `ContentBlockSourceContent = array of ContentBlockSourceContent`1214112142 - `TextBlockParam object`1214312144 - `ImageBlockParam object`1214512146 - `URLPDFSource object`1214712148 - `type: "url"`1214912150 - `url: string`1215112152 - `FileDocumentSource object`1215312154 - `type: "file"`1215512156 - `file_id: string`1215712158 - `cache_control: optional CacheControlEphemeral or null`1215912160 Create a cache control breakpoint at this content block.1216112162 - `citations: optional CitationsConfigParam or null`1216312164 - `enabled: optional boolean`1216512166 - `context: optional string or null`1216712168 minLength: 11216912170 - `title: optional string or null`1217112172 maxLength: 500, minLength: 11217312174 - `SearchResultBlockParam object`1217512176 - `type: "search_result"`1217712178 - `content: array of TextBlockParam`1217912180 - `type: "text"`1218112182 - `text: string`1218312184 minLength: 11218512186 - `cache_control: optional CacheControlEphemeral or null`1218712188 Create a cache control breakpoint at this content block.1218912190 - `citations: optional array of TextCitationParam or null`1219112192 - `source: string`1219312194 - `title: string`1219512196 - `cache_control: optional CacheControlEphemeral or null`1219712198 Create a cache control breakpoint at this content block.1219912200 - `citations: optional CitationsConfigParam`1220112202 - `ThinkingBlockParam object`1220312204 - `type: "thinking"`1220512206 - `signature: string`1220712208 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.1220912210 Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`.1221112212 - `thinking: string`1221312214 The `thinking` text of this block as returned by the API.1221512216 - `RedactedThinkingBlockParam object`1221712218 - `type: "redacted_thinking"`1221912220 - `data: string`1222112222 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.1222312224 - `ToolUseBlockParam object`1222512226 - `type: "tool_use"`1222712228 - `id: string`1222912230 pattern: ^[a-zA-Z0-9_-]+$1223112232 - `input: map[unknown]`1223312234 - `name: string`1223512236 maxLength: 200, minLength: 11223712238 - `cache_control: optional CacheControlEphemeral or null`1223912240 Create a cache control breakpoint at this content block.1224112242 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`1224312244 - `DirectCaller object`1224512246 Tool invocation directly from the model.1224712248 - `type: "direct"`1224912250 - `ServerToolCaller object`1225112252 Tool invocation generated by a server-side tool.1225312254 - `type: "code_execution_20250825"`1225512256 - `tool_id: string`1225712258 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1225912260 - `ServerToolCaller20260120 object`1226112262 - `type: "code_execution_20260120"`1226312264 - `tool_id: string`1226512266 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1226712268 - `toolset_name: optional string or null`1226912270 For a toolset member tool_use, the toolset family this member belongs to.1227112272 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$1227312274 - `ToolResultBlockParam object`1227512276 - `type: "tool_result"`1227712278 - `tool_use_id: string`1227912280 pattern: ^[a-zA-Z0-9_-]+$1228112282 - `cache_control: optional CacheControlEphemeral or null`1228312284 Create a cache control breakpoint at this content block.1228512286 - `content: optional string or array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 3 more`1228712288 - `string`1228912290 - `array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 3 more`1229112292 - `TextBlockParam object`1229312294 - `ImageBlockParam object`1229512296 - `SearchResultBlockParam object`1229712298 - `DocumentBlockParam object`1229912300 - `ToolReferenceBlockParam object`1230112302 Tool reference block that can be included in tool_result content.1230312304 - `type: "tool_reference"`1230512306 - `tool_name: string`1230712308 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$1230912310 - `cache_control: optional CacheControlEphemeral or null`1231112312 Create a cache control breakpoint at this content block.1231312314 - `BrowserStateBlockParam object`1231512316 The caller's browser state after a browser toolset member call —12317 the full inventory of open tabs, which tab is active, and any side12318 effects (tabs opened, download state changes) the call produced.1231912320 At most one per `tool_result`, only on a non-error result answering a12321 browser toolset member `tool_use`. The server renders the12322 model-visible text from it; the model never sees the raw fields.1232312324 - `type: "browser_state"`1232512326 - `tabs: array of BrowserStateTabEntry`1232712328 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`.1232912330 maxItems: 1001233112332 - `tab_id: string`1233312334 The caller-assigned identifier for this tab, unique within the inventory.1233512336 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1233712338 - `title: string`1233912340 The title of the page the tab is showing. May be empty.1234112342 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1234312344 - `url: string`1234512346 The URL of the page the tab is showing. May be empty.1234712348 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1234912350 - `active: optional boolean`1235112352 Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.1235312354 - `cache_control: optional CacheControlEphemeral or null`1235512356 Create a cache control breakpoint at this content block.1235712358 - `state_changes: optional array of BrowserStateChange or null`1235912360 Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list.1236112362 maxItems: 200, minItems: 11236312364 - `BrowserStateChangeTabOpened object`1236512366 A tab this call's execution opened that remains open at its end —12367 the creation delta of the `tabs` inventory, not an event log.1236812369 Carries only the `tab_id`; the tab's `title` and `url` live on its12370 `tabs` entry, which must include the same `tab_id`. A tab opened12371 during a failed call gets no deferred `tab_opened`; it simply appears12372 in the next result's `tabs` inventory.1237312374 - `type: "tab_opened"`1237512376 - `tab_id: string`1237712378 The `tab_id` of the opened tab, present in `tabs`.1237912380 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1238112382 - `BrowserStateChangeDownloadStarted object`1238312384 A file download that started during this call.1238512386 - `type: "download_started"`1238712388 - `download_id: string`1238912390 The caller-assigned identifier for this download, stable across the state changes reporting it.1239112392 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1239312394 - `url: string`1239512396 The final post-redirect URL the download was served from.1239712398 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1239912400 - `BrowserStateChangeDownloadCompleted object`1240112402 A file download that finished during this call, reported with the12403 same `download_id` as its `download_started` — or without a prior12404 `download_started`, when the download finished during the call that12405 started it (at most one state change per `download_id` per result).1240612407 - `type: "download_completed"`1240812409 - `download_id: string`1241012411 The caller-assigned identifier for this download, stable across the state changes reporting it.1241212413 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1241412415 - `url: string`1241612417 The final post-redirect URL the download was served from.1241812419 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1242012421 - `path: optional string or null`1242212423 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.1242412425 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 40961242612427 - `size_bytes: optional number or null`1242812429 The completed download's size.1243012431 minimum: 01243212433 - `BrowserStateChangeDownloadFailed object`1243412435 A file download that failed — or was cancelled — during this call.1243612437 - `type: "download_failed"`1243812439 - `download_id: string`1244012441 The caller-assigned identifier for this download, stable across the state changes reporting it.1244212443 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1244412445 - `url: string`1244612447 The final post-redirect URL the download was served from.1244812449 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1245012451 - `error: optional string or null`1245212453 The failure or cancellation detail, when known.1245412455 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 40961245612457 - `is_error: optional boolean`1245812459 - `toolset_name: optional string or null`1246012461 For a toolset member tool_result, the toolset family of the paired tool_use.1246212463 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$1246412465 - `ServerToolUseBlockParam object`1246612467 - `type: "server_tool_use"`1246812469 - `id: string`1247012471 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1247212473 - `input: map[unknown]`1247412475 - `name: "web_search" or "web_fetch" or "code_execution" or 4 more`1247612477 - `"web_search"`1247812479 - `"web_fetch"`1248012481 - `"code_execution"`1248212483 - `"bash_code_execution"`1248412485 - `"text_editor_code_execution"`1248612487 - `"tool_search_tool_regex"`1248812489 - `"tool_search_tool_bm25"`1249012491 - `cache_control: optional CacheControlEphemeral or null`1249212493 Create a cache control breakpoint at this content block.1249412495 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`1249612497 - `DirectCaller object`1249812499 Tool invocation directly from the model.1250012501 - `ServerToolCaller object`1250212503 Tool invocation generated by a server-side tool.1250412505 - `ServerToolCaller20260120 object`1250612507 - `WebSearchToolResultBlockParam object`1250812509 - `type: "web_search_tool_result"`1251012511 - `content: WebSearchToolResultBlockParamContent`1251212513 - `WebSearchToolResultBlockItem = array of WebSearchResultBlockParam`1251412515 - `type: "web_search_result"`1251612517 - `encrypted_content: string`1251812519 - `title: string`1252012521 - `url: string`1252212523 - `page_age: optional string or null`1252412525 - `WebSearchToolRequestError object`1252612527 - `type: "web_search_tool_result_error"`1252812529 - `error_code: WebSearchToolResultErrorCode`1253012531 - `"invalid_tool_input"`1253212533 - `"unavailable"`1253412535 - `"max_uses_exceeded"`1253612537 - `"too_many_requests"`1253812539 - `"query_too_long"`1254012541 - `"request_too_large"`1254212543 - `tool_use_id: string`1254412545 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1254612547 - `cache_control: optional CacheControlEphemeral or null`1254812549 Create a cache control breakpoint at this content block.1255012551 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`1255212553 - `DirectCaller object`1255412555 Tool invocation directly from the model.1255612557 - `ServerToolCaller object`1255812559 Tool invocation generated by a server-side tool.1256012561 - `ServerToolCaller20260120 object`1256212563 - `WebFetchToolResultBlockParam object`1256412565 - `type: "web_fetch_tool_result"`1256612567 - `content: WebFetchToolResultErrorBlockParam or WebFetchBlockParam`1256812569 - `WebFetchToolResultErrorBlockParam object`1257012571 - `type: "web_fetch_tool_result_error"`1257212573 - `error_code: WebFetchToolResultErrorCode`1257412575 - `"invalid_tool_input"`1257612577 - `"url_too_long"`1257812579 - `"url_not_allowed"`1258012581 - `"url_not_in_prior_context"`1258212583 - `"url_not_accessible"`1258412585 - `"unsupported_content_type"`1258612587 - `"too_many_requests"`1258812589 - `"max_uses_exceeded"`1259012591 - `"unavailable"`1259212593 - `"content_too_large"`1259412595 - `WebFetchBlockParam object`1259612597 - `type: "web_fetch_result"`1259812599 - `content: DocumentBlockParam`1260012601 - `url: string`1260212603 Fetched content URL1260412605 - `retrieved_at: optional string or null`1260612607 ISO 8601 timestamp when the content was retrieved1260812609 - `tool_use_id: string`1261012611 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1261212613 - `cache_control: optional CacheControlEphemeral or null`1261412615 Create a cache control breakpoint at this content block.1261612617 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`1261812619 - `DirectCaller object`1262012621 Tool invocation directly from the model.1262212623 - `ServerToolCaller object`1262412625 Tool invocation generated by a server-side tool.1262612627 - `ServerToolCaller20260120 object`1262812629 - `CodeExecutionToolResultBlockParam object`1263012631 - `type: "code_execution_tool_result"`1263212633 - `content: CodeExecutionToolResultBlockParamContent`1263412635 - `CodeExecutionToolResultErrorParam object`1263612637 - `type: "code_execution_tool_result_error"`1263812639 - `error_code: CodeExecutionToolResultErrorCode`1264012641 - `"invalid_tool_input"`1264212643 - `"unavailable"`1264412645 - `"too_many_requests"`1264612647 - `"execution_time_exceeded"`1264812649 - `CodeExecutionResultBlockParam object`1265012651 - `type: "code_execution_result"`1265212653 - `content: array of CodeExecutionOutputBlockParam`1265412655 - `type: "code_execution_output"`1265612657 - `file_id: string`1265812659 - `return_code: number`1266012661 - `stderr: string`1266212663 - `stdout: string`1266412665 - `EncryptedCodeExecutionResultBlockParam object`1266612667 Code execution result with encrypted stdout for PFC + web_search results.1266812669 - `type: "encrypted_code_execution_result"`1267012671 - `content: array of CodeExecutionOutputBlockParam`1267212673 - `type: "code_execution_output"`1267412675 - `file_id: string`1267612677 - `encrypted_stdout: string`1267812679 - `return_code: number`1268012681 - `stderr: string`1268212683 - `tool_use_id: string`1268412685 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1268612687 - `cache_control: optional CacheControlEphemeral or null`1268812689 Create a cache control breakpoint at this content block.1269012691 - `BashCodeExecutionToolResultBlockParam object`1269212693 - `type: "bash_code_execution_tool_result"`1269412695 - `content: BashCodeExecutionToolResultErrorParam or BashCodeExecutionResultBlockParam`1269612697 - `BashCodeExecutionToolResultErrorParam object`1269812699 - `type: "bash_code_execution_tool_result_error"`1270012701 - `error_code: BashCodeExecutionToolResultErrorCode`1270212703 - `"invalid_tool_input"`1270412705 - `"unavailable"`1270612707 - `"too_many_requests"`1270812709 - `"execution_time_exceeded"`1271012711 - `"output_file_too_large"`1271212713 - `BashCodeExecutionResultBlockParam object`1271412715 - `type: "bash_code_execution_result"`1271612717 - `content: array of BashCodeExecutionOutputBlockParam`1271812719 - `type: "bash_code_execution_output"`1272012721 - `file_id: string`1272212723 - `return_code: number`1272412725 - `stderr: string`1272612727 - `stdout: string`1272812729 - `tool_use_id: string`1273012731 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1273212733 - `cache_control: optional CacheControlEphemeral or null`1273412735 Create a cache control breakpoint at this content block.1273612737 - `TextEditorCodeExecutionToolResultBlockParam object`1273812739 - `type: "text_editor_code_execution_tool_result"`1274012741 - `content: TextEditorCodeExecutionToolResultErrorParam or TextEditorCodeExecutionViewResultBlockParam or TextEditorCodeExecutionCreateResultBlockParam or TextEditorCodeExecutionStrReplaceResultBlockParam`1274212743 - `TextEditorCodeExecutionToolResultErrorParam object`1274412745 - `type: "text_editor_code_execution_tool_result_error"`1274612747 - `error_code: TextEditorCodeExecutionToolResultErrorCode`1274812749 - `"invalid_tool_input"`1275012751 - `"unavailable"`1275212753 - `"too_many_requests"`1275412755 - `"execution_time_exceeded"`1275612757 - `"file_not_found"`1275812759 - `error_message: optional string or null`1276012761 - `TextEditorCodeExecutionViewResultBlockParam object`1276212763 - `type: "text_editor_code_execution_view_result"`1276412765 - `content: string`1276612767 - `file_type: "text" or "image" or "pdf"`1276812769 - `"text"`1277012771 - `"image"`1277212773 - `"pdf"`1277412775 - `num_lines: optional number or null`1277612777 - `start_line: optional number or null`1277812779 - `total_lines: optional number or null`1278012781 - `TextEditorCodeExecutionCreateResultBlockParam object`1278212783 - `type: "text_editor_code_execution_create_result"`1278412785 - `is_file_update: boolean`1278612787 - `TextEditorCodeExecutionStrReplaceResultBlockParam object`1278812789 - `type: "text_editor_code_execution_str_replace_result"`1279012791 - `lines: optional array of string or null`1279212793 - `new_lines: optional number or null`1279412795 - `new_start: optional number or null`1279612797 - `old_lines: optional number or null`1279812799 - `old_start: optional number or null`1280012801 - `tool_use_id: string`1280212803 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1280412805 - `cache_control: optional CacheControlEphemeral or null`1280612807 Create a cache control breakpoint at this content block.1280812809 - `ToolSearchToolResultBlockParam object`1281012811 - `type: "tool_search_tool_result"`1281212813 - `content: ToolSearchToolResultErrorParam or ToolSearchToolSearchResultBlockParam`1281412815 - `ToolSearchToolResultErrorParam object`1281612817 - `type: "tool_search_tool_result_error"`1281812819 - `error_code: ToolSearchToolResultErrorCode`1282012821 - `"invalid_tool_input"`1282212823 - `"unavailable"`1282412825 - `"too_many_requests"`1282612827 - `"execution_time_exceeded"`1282812829 - `error_message: optional string or null`1283012831 - `ToolSearchToolSearchResultBlockParam object`1283212833 - `type: "tool_search_tool_search_result"`1283412835 - `tool_references: array of ToolReferenceBlockParam`1283612837 - `type: "tool_reference"`1283812839 - `tool_name: string`1284012841 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$1284212843 - `cache_control: optional CacheControlEphemeral or null`1284412845 Create a cache control breakpoint at this content block.1284612847 - `tool_use_id: string`1284812849 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1285012851 - `cache_control: optional CacheControlEphemeral or null`1285212853 Create a cache control breakpoint at this content block.1285412855 - `ContainerUploadBlockParam object`1285612857 A content block that represents a file to be uploaded to the container12858 Files uploaded via this block will be available in the container's input directory.1285912860 - `type: "container_upload"`1286112862 - `file_id: string`1286312864 - `cache_control: optional CacheControlEphemeral or null`1286512866 Create a cache control breakpoint at this content block.1286712868### Content Block Source1286912870- `ContentBlockSource object`1287112872 - `type: "content"`1287312874 - `content: string or array of ContentBlockSourceContent`1287512876 - `string`1287712878 - `ContentBlockSourceContent = array of ContentBlockSourceContent`1287912880 - `TextBlockParam object`1288112882 - `type: "text"`1288312884 - `text: string`1288512886 minLength: 11288712888 - `cache_control: optional CacheControlEphemeral or null`1288912890 Create a cache control breakpoint at this content block.1289112892 - `type: "ephemeral"`1289312894 - `ttl: optional "5m" or "1h"`1289512896 The time-to-live for the cache control breakpoint.1289712898 This may be one the following values:1289912900 - `5m`: 5 minutes12901 - `1h`: 1 hour1290212903 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.1290412905 - `"5m"`1290612907 - `"1h"`1290812909 - `citations: optional array of TextCitationParam or null`1291012911 - `CitationCharLocationParam object`1291212913 - `type: "char_location"`1291412915 - `cited_text: string`1291612917 - `document_index: number`1291812919 minimum: 01292012921 - `document_title: string or null`1292212923 maxLength: 500, minLength: 11292412925 - `end_char_index: number`1292612927 - `start_char_index: number`1292812929 minimum: 01293012931 - `CitationPageLocationParam object`1293212933 - `type: "page_location"`1293412935 - `cited_text: string`1293612937 - `document_index: number`1293812939 minimum: 01294012941 - `document_title: string or null`1294212943 maxLength: 500, minLength: 11294412945 - `end_page_number: number`1294612947 - `start_page_number: number`1294812949 minimum: 11295012951 - `CitationContentBlockLocationParam object`1295212953 - `type: "content_block_location"`1295412955 - `cited_text: string`1295612957 The full text of the cited block range, concatenated.1295812959 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.1296012961 - `document_index: number`1296212963 minimum: 01296412965 - `document_title: string or null`1296612967 maxLength: 500, minLength: 11296812969 - `end_block_index: number`1297012971 Exclusive 0-based end index of the cited block range in the source's `content` array.1297212973 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1297412975 - `start_block_index: number`1297612977 0-based index of the first cited block in the source's `content` array.1297812979 minimum: 01298012981 - `CitationWebSearchResultLocationParam object`1298212983 - `type: "web_search_result_location"`1298412985 - `cited_text: string`1298612987 - `encrypted_index: string`1298812989 - `title: string or null`1299012991 maxLength: 512, minLength: 11299212993 - `url: string`1299412995 minLength: 11299612997 - `CitationSearchResultLocationParam object`1299812999 - `type: "search_result_location"`1300013001 - `cited_text: string`1300213003 The full text of the cited block range, concatenated.1300413005 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.1300613007 - `end_block_index: number`1300813009 Exclusive 0-based end index of the cited block range in the source's `content` array.1301013011 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1301213013 - `search_result_index: number`1301413015 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.1301613017 Counted separately from `document_index`; server-side web search results are not included in this count.1301813019 minimum: 01302013021 - `source: string`1302213023 - `start_block_index: number`1302413025 0-based index of the first cited block in the source's `content` array.1302613027 minimum: 01302813029 - `title: string or null`1303013031 - `ImageBlockParam object`1303213033 - `type: "image"`1303413035 - `source: Base64ImageSource or URLImageSource or FileImageSource`1303613037 - `Base64ImageSource object`1303813039 - `type: "base64"`1304013041 - `data: string`1304213043 format: byte1304413045 - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"`1304613047 - `"image/jpeg"`1304813049 - `"image/png"`1305013051 - `"image/gif"`1305213053 - `"image/webp"`1305413055 - `URLImageSource object`1305613057 - `type: "url"`1305813059 - `url: string`1306013061 - `FileImageSource object`1306213063 - `type: "file"`1306413065 - `file_id: string`1306613067 - `cache_control: optional CacheControlEphemeral or null`1306813069 Create a cache control breakpoint at this content block.1307013071 - `transformations: optional ImageTransformationsParam or null`1307213073 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.1307413075 - `oversized_image: optional "downsize" or "error"`1307613077 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.1307813079 - `"downsize"`1308013081 - `"error"`1308213083### Content Block Source Content1308413085- `ContentBlockSourceContent = TextBlockParam or ImageBlockParam`1308613087 - `TextBlockParam object`1308813089 - `type: "text"`1309013091 - `text: string`1309213093 minLength: 11309413095 - `cache_control: optional CacheControlEphemeral or null`1309613097 Create a cache control breakpoint at this content block.1309813099 - `type: "ephemeral"`1310013101 - `ttl: optional "5m" or "1h"`1310213103 The time-to-live for the cache control breakpoint.1310413105 This may be one the following values:1310613107 - `5m`: 5 minutes13108 - `1h`: 1 hour1310913110 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.1311113112 - `"5m"`1311313114 - `"1h"`1311513116 - `citations: optional array of TextCitationParam or null`1311713118 - `CitationCharLocationParam object`1311913120 - `type: "char_location"`1312113122 - `cited_text: string`1312313124 - `document_index: number`1312513126 minimum: 01312713128 - `document_title: string or null`1312913130 maxLength: 500, minLength: 11313113132 - `end_char_index: number`1313313134 - `start_char_index: number`1313513136 minimum: 01313713138 - `CitationPageLocationParam object`1313913140 - `type: "page_location"`1314113142 - `cited_text: string`1314313144 - `document_index: number`1314513146 minimum: 01314713148 - `document_title: string or null`1314913150 maxLength: 500, minLength: 11315113152 - `end_page_number: number`1315313154 - `start_page_number: number`1315513156 minimum: 11315713158 - `CitationContentBlockLocationParam object`1315913160 - `type: "content_block_location"`1316113162 - `cited_text: string`1316313164 The full text of the cited block range, concatenated.1316513166 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.1316713168 - `document_index: number`1316913170 minimum: 01317113172 - `document_title: string or null`1317313174 maxLength: 500, minLength: 11317513176 - `end_block_index: number`1317713178 Exclusive 0-based end index of the cited block range in the source's `content` array.1317913180 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1318113182 - `start_block_index: number`1318313184 0-based index of the first cited block in the source's `content` array.1318513186 minimum: 01318713188 - `CitationWebSearchResultLocationParam object`1318913190 - `type: "web_search_result_location"`1319113192 - `cited_text: string`1319313194 - `encrypted_index: string`1319513196 - `title: string or null`1319713198 maxLength: 512, minLength: 11319913200 - `url: string`1320113202 minLength: 11320313204 - `CitationSearchResultLocationParam object`1320513206 - `type: "search_result_location"`1320713208 - `cited_text: string`1320913210 The full text of the cited block range, concatenated.1321113212 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.1321313214 - `end_block_index: number`1321513216 Exclusive 0-based end index of the cited block range in the source's `content` array.1321713218 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1321913220 - `search_result_index: number`1322113222 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.1322313224 Counted separately from `document_index`; server-side web search results are not included in this count.1322513226 minimum: 01322713228 - `source: string`1322913230 - `start_block_index: number`1323113232 0-based index of the first cited block in the source's `content` array.1323313234 minimum: 01323513236 - `title: string or null`1323713238 - `ImageBlockParam object`1323913240 - `type: "image"`1324113242 - `source: Base64ImageSource or URLImageSource or FileImageSource`1324313244 - `Base64ImageSource object`1324513246 - `type: "base64"`1324713248 - `data: string`1324913250 format: byte1325113252 - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"`1325313254 - `"image/jpeg"`1325513256 - `"image/png"`1325713258 - `"image/gif"`1325913260 - `"image/webp"`1326113262 - `URLImageSource object`1326313264 - `type: "url"`1326513266 - `url: string`1326713268 - `FileImageSource object`1326913270 - `type: "file"`1327113272 - `file_id: string`1327313274 - `cache_control: optional CacheControlEphemeral or null`1327513276 Create a cache control breakpoint at this content block.1327713278 - `transformations: optional ImageTransformationsParam or null`1327913280 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.1328113282 - `oversized_image: optional "downsize" or "error"`1328313284 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.1328513286 - `"downsize"`1328713288 - `"error"`1328913290### Direct Caller1329113292- `DirectCaller object`1329313294 Tool invocation directly from the model.1329513296 - `type: "direct"`1329713298### Document Block1329913300- `DocumentBlock object`1330113302 - `type: "document"`1330313304 default: document1330513306 - `citations: CitationsConfig or null`1330713308 Citation configuration for the document1330913310 - `enabled: boolean`1331113312 default: false1331313314 - `source: Base64PDFSource or PlainTextSource`1331513316 - `Base64PDFSource object`1331713318 - `type: "base64"`1331913320 - `data: string`1332113322 format: byte1332313324 - `media_type: "application/pdf"`1332513326 - `PlainTextSource object`1332713328 - `type: "text"`1332913330 - `data: string`1333113332 - `media_type: "text/plain"`1333313334 - `title: string or null`1333513336 The title of the document1333713338### Document Block Param1333913340- `DocumentBlockParam object`1334113342 - `type: "document"`1334313344 - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more`1334513346 - `Base64PDFSource object`1334713348 - `type: "base64"`1334913350 - `data: string`1335113352 format: byte1335313354 - `media_type: "application/pdf"`1335513356 - `PlainTextSource object`1335713358 - `type: "text"`1335913360 - `data: string`1336113362 - `media_type: "text/plain"`1336313364 - `ContentBlockSource object`1336513366 - `type: "content"`1336713368 - `content: string or array of ContentBlockSourceContent`1336913370 - `string`1337113372 - `ContentBlockSourceContent = array of ContentBlockSourceContent`1337313374 - `TextBlockParam object`1337513376 - `type: "text"`1337713378 - `text: string`1337913380 minLength: 11338113382 - `cache_control: optional CacheControlEphemeral or null`1338313384 Create a cache control breakpoint at this content block.1338513386 - `type: "ephemeral"`1338713388 - `ttl: optional "5m" or "1h"`1338913390 The time-to-live for the cache control breakpoint.1339113392 This may be one the following values:1339313394 - `5m`: 5 minutes13395 - `1h`: 1 hour1339613397 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.1339813399 - `"5m"`1340013401 - `"1h"`1340213403 - `citations: optional array of TextCitationParam or null`1340413405 - `CitationCharLocationParam object`1340613407 - `type: "char_location"`1340813409 - `cited_text: string`1341013411 - `document_index: number`1341213413 minimum: 01341413415 - `document_title: string or null`1341613417 maxLength: 500, minLength: 11341813419 - `end_char_index: number`1342013421 - `start_char_index: number`1342213423 minimum: 01342413425 - `CitationPageLocationParam object`1342613427 - `type: "page_location"`1342813429 - `cited_text: string`1343013431 - `document_index: number`1343213433 minimum: 01343413435 - `document_title: string or null`1343613437 maxLength: 500, minLength: 11343813439 - `end_page_number: number`1344013441 - `start_page_number: number`1344213443 minimum: 11344413445 - `CitationContentBlockLocationParam object`1344613447 - `type: "content_block_location"`1344813449 - `cited_text: string`1345013451 The full text of the cited block range, concatenated.1345213453 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.1345413455 - `document_index: number`1345613457 minimum: 01345813459 - `document_title: string or null`1346013461 maxLength: 500, minLength: 11346213463 - `end_block_index: number`1346413465 Exclusive 0-based end index of the cited block range in the source's `content` array.1346613467 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1346813469 - `start_block_index: number`1347013471 0-based index of the first cited block in the source's `content` array.1347213473 minimum: 01347413475 - `CitationWebSearchResultLocationParam object`1347613477 - `type: "web_search_result_location"`1347813479 - `cited_text: string`1348013481 - `encrypted_index: string`1348213483 - `title: string or null`1348413485 maxLength: 512, minLength: 11348613487 - `url: string`1348813489 minLength: 11349013491 - `CitationSearchResultLocationParam object`1349213493 - `type: "search_result_location"`1349413495 - `cited_text: string`1349613497 The full text of the cited block range, concatenated.1349813499 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.1350013501 - `end_block_index: number`1350213503 Exclusive 0-based end index of the cited block range in the source's `content` array.1350413505 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1350613507 - `search_result_index: number`1350813509 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.1351013511 Counted separately from `document_index`; server-side web search results are not included in this count.1351213513 minimum: 01351413515 - `source: string`1351613517 - `start_block_index: number`1351813519 0-based index of the first cited block in the source's `content` array.1352013521 minimum: 01352213523 - `title: string or null`1352413525 - `ImageBlockParam object`1352613527 - `type: "image"`1352813529 - `source: Base64ImageSource or URLImageSource or FileImageSource`1353013531 - `Base64ImageSource object`1353213533 - `type: "base64"`1353413535 - `data: string`1353613537 format: byte1353813539 - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"`1354013541 - `"image/jpeg"`1354213543 - `"image/png"`1354413545 - `"image/gif"`1354613547 - `"image/webp"`1354813549 - `URLImageSource object`1355013551 - `type: "url"`1355213553 - `url: string`1355413555 - `FileImageSource object`1355613557 - `type: "file"`1355813559 - `file_id: string`1356013561 - `cache_control: optional CacheControlEphemeral or null`1356213563 Create a cache control breakpoint at this content block.1356413565 - `transformations: optional ImageTransformationsParam or null`1356613567 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.1356813569 - `oversized_image: optional "downsize" or "error"`1357013571 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.1357213573 - `"downsize"`1357413575 - `"error"`1357613577 - `URLPDFSource object`1357813579 - `type: "url"`1358013581 - `url: string`1358213583 - `FileDocumentSource object`1358413585 - `type: "file"`1358613587 - `file_id: string`1358813589 - `cache_control: optional CacheControlEphemeral or null`1359013591 Create a cache control breakpoint at this content block.1359213593 - `citations: optional CitationsConfigParam or null`1359413595 - `enabled: optional boolean`1359613597 - `context: optional string or null`1359813599 minLength: 11360013601 - `title: optional string or null`1360213603 maxLength: 500, minLength: 11360413605### Encrypted Code Execution Result Block1360613607- `EncryptedCodeExecutionResultBlock object`1360813609 Code execution result with encrypted stdout for PFC + web_search results.1361013611 - `type: "encrypted_code_execution_result"`1361213613 default: encrypted_code_execution_result1361413615 - `content: array of CodeExecutionOutputBlock`1361613617 - `type: "code_execution_output"`1361813619 default: code_execution_output1362013621 - `file_id: string`1362213623 - `encrypted_stdout: string`1362413625 - `return_code: number`1362613627 - `stderr: string`1362813629### Encrypted Code Execution Result Block Param1363013631- `EncryptedCodeExecutionResultBlockParam object`1363213633 Code execution result with encrypted stdout for PFC + web_search results.1363413635 - `type: "encrypted_code_execution_result"`1363613637 - `content: array of CodeExecutionOutputBlockParam`1363813639 - `type: "code_execution_output"`1364013641 - `file_id: string`1364213643 - `encrypted_stdout: string`1364413645 - `return_code: number`1364613647 - `stderr: string`1364813649### File Document Source1365013651- `FileDocumentSource object`1365213653 - `type: "file"`1365413655 - `file_id: string`1365613657### File Image Source1365813659- `FileImageSource object`1366013661 - `type: "file"`1366213663 - `file_id: string`1366413665### Image Block Param1366613667- `ImageBlockParam object`1366813669 - `type: "image"`1367013671 - `source: Base64ImageSource or URLImageSource or FileImageSource`1367213673 - `Base64ImageSource object`1367413675 - `type: "base64"`1367613677 - `data: string`1367813679 format: byte1368013681 - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"`1368213683 - `"image/jpeg"`1368413685 - `"image/png"`1368613687 - `"image/gif"`1368813689 - `"image/webp"`1369013691 - `URLImageSource object`1369213693 - `type: "url"`1369413695 - `url: string`1369613697 - `FileImageSource object`1369813699 - `type: "file"`1370013701 - `file_id: string`1370213703 - `cache_control: optional CacheControlEphemeral or null`1370413705 Create a cache control breakpoint at this content block.1370613707 - `type: "ephemeral"`1370813709 - `ttl: optional "5m" or "1h"`1371013711 The time-to-live for the cache control breakpoint.1371213713 This may be one the following values:1371413715 - `5m`: 5 minutes13716 - `1h`: 1 hour1371713718 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.1371913720 - `"5m"`1372113722 - `"1h"`1372313724 - `transformations: optional ImageTransformationsParam or null`1372513726 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.1372713728 - `oversized_image: optional "downsize" or "error"`1372913730 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.1373113732 - `"downsize"`1373313734 - `"error"`1373513736### Image Transformations Param1373713738- `ImageTransformationsParam object`1373913740 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.1374113742 - `oversized_image: optional "downsize" or "error"`1374313744 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.1374513746 - `"downsize"`1374713748 - `"error"`1374913750### Input JSON Delta1375113752- `InputJSONDelta object`1375313754 - `type: "input_json_delta"`1375513756 default: input_json_delta1375713758 - `partial_json: string`1375913760### JSON Output Format1376113762- `JSONOutputFormat object`1376313764 - `type: "json_schema"`1376513766 - `schema: map[unknown]`1376713768 The JSON schema of the format1376913770### Memory Tool 202508181377113772- `MemoryTool20250818 object`1377313774 - `type: "memory_20250818"`1377513776 - `name: "memory"`1377713778 Name of the tool.1377913780 This is how the tool will be called by the model and in `tool_use` blocks.1378113782 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1378313784 - `"direct"`1378513786 - `"code_execution_20250825"`1378713788 - `"code_execution_20260120"`1378913790 - `"code_execution_20260521"`1379113792 - `cache_control: optional CacheControlEphemeral or null`1379313794 Create a cache control breakpoint at this content block.1379513796 - `type: "ephemeral"`1379713798 - `ttl: optional "5m" or "1h"`1379913800 The time-to-live for the cache control breakpoint.1380113802 This may be one the following values:1380313804 - `5m`: 5 minutes13805 - `1h`: 1 hour1380613807 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.1380813809 - `"5m"`1381013811 - `"1h"`1381213813 - `defer_loading: optional boolean`1381413815 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1381613817 - `input_examples: optional array of map[unknown]`1381813819 - `strict: optional boolean`1382013821 When true, guarantees schema validation on tool names and inputs1382213823### Message1382413825- `Message object`1382613827 - `type: "message"`1382813829 Object type.1383013831 For Messages, this is always `"message"`.1383213833 default: message1383413835 - `id: string`1383613837 Unique object identifier.1383813839 The format and length of IDs may change over time.1384013841 - `container: Container or null`1384213843 Information about the container used in the request (for the code execution tool)1384413845 - `id: string`1384613847 Identifier for the container used in this request1384813849 - `expires_at: string`1385013851 The time at which the container will expire.1385213853 format: date-time1385413855 - `skills: array of ContainerSkill or null`1385613857 Skills loaded in the container1385813859 - `type: "anthropic" or "custom"`1386013861 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)1386213863 - `"anthropic"`1386413865 - `"custom"`1386613867 - `skill_id: string`1386813869 Skill ID1387013871 maxLength: 64, minLength: 11387213873 - `version: string`1387413875 The resolved version: a skill version ID for custom skills.1387613877 maxLength: 64, minLength: 11387813879 - `content: array of ContentBlock`1388013881 Content generated by the model.1388213883 This is an array of content blocks, each of which has a `type` that determines its shape.1388413885 Example:1388613887 ```json13888 [{"type": "text", "text": "Hi, I'm Claude."}]13889 ```1389013891 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.1389213893 For example, if the input `messages` were:1389413895 ```json13896 [13897 {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},13898 {"role": "assistant", "content": "The best answer is ("}13899 ]13900 ```1390113902 Then the response `content` might be:1390313904 ```json13905 [{"type": "text", "text": "B)"}]13906 ```1390713908 - `TextBlock object`1390913910 - `type: "text"`1391113912 default: text1391313914 - `citations: array of TextCitation or null`1391513916 Citations supporting the text block.1391713918 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`.1391913920 - `CitationCharLocation object`1392113922 - `type: "char_location"`1392313924 default: char_location1392513926 - `cited_text: string`1392713928 - `document_index: number`1392913930 minimum: 01393113932 - `document_title: string or null`1393313934 - `end_char_index: number`1393513936 - `file_id: string or null`1393713938 - `start_char_index: number`1393913940 minimum: 01394113942 - `CitationPageLocation object`1394313944 - `type: "page_location"`1394513946 default: page_location1394713948 - `cited_text: string`1394913950 - `document_index: number`1395113952 minimum: 01395313954 - `document_title: string or null`1395513956 - `end_page_number: number`1395713958 - `file_id: string or null`1395913960 - `start_page_number: number`1396113962 minimum: 11396313964 - `CitationContentBlockLocation object`1396513966 - `type: "content_block_location"`1396713968 default: content_block_location1396913970 - `cited_text: string`1397113972 The full text of the cited block range, concatenated.1397313974 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.1397513976 - `document_index: number`1397713978 minimum: 01397913980 - `document_title: string or null`1398113982 - `end_block_index: number`1398313984 Exclusive 0-based end index of the cited block range in the source's `content` array.1398513986 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1398713988 - `file_id: string or null`1398913990 - `start_block_index: number`1399113992 0-based index of the first cited block in the source's `content` array.1399313994 minimum: 01399513996 - `CitationsWebSearchResultLocation object`1399713998 - `type: "web_search_result_location"`1399914000 default: web_search_result_location1400114002 - `cited_text: string`1400314004 - `encrypted_index: string`1400514006 - `title: string or null`1400714008 maxLength: 5121400914010 - `url: string`1401114012 - `CitationsSearchResultLocation object`1401314014 - `type: "search_result_location"`1401514016 default: search_result_location1401714018 - `cited_text: string`1401914020 The full text of the cited block range, concatenated.1402114022 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.1402314024 - `end_block_index: number`1402514026 Exclusive 0-based end index of the cited block range in the source's `content` array.1402714028 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1402914030 - `search_result_index: number`1403114032 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.1403314034 Counted separately from `document_index`; server-side web search results are not included in this count.1403514036 minimum: 01403714038 - `source: string`1403914040 - `start_block_index: number`1404114042 0-based index of the first cited block in the source's `content` array.1404314044 minimum: 01404514046 - `title: string or null`1404714048 - `text: string`1404914050 minLength: 01405114052 - `ThinkingBlock object`1405314054 - `type: "thinking"`1405514056 default: thinking1405714058 - `signature: string`1405914060 A value used to verify that this thinking block was generated by Claude when it is passed back to the API.1406114062 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.1406314064 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.1406514066 - `thinking: string`1406714068 The text of Claude's thinking process for this block.1406914070 - `RedactedThinkingBlock object`1407114072 - `type: "redacted_thinking"`1407314074 default: redacted_thinking1407514076 - `data: string`1407714078 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.1407914080 Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.1408114082 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.1408314084 - `ToolUseBlock object`1408514086 - `type: "tool_use"`1408714088 default: tool_use1408914090 - `id: string`1409114092 pattern: ^[a-zA-Z0-9_-]+$1409314094 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`1409514096 default: {"type":"direct"}1409714098 - `DirectCaller object`1409914100 Tool invocation directly from the model.1410114102 - `type: "direct"`1410314104 - `ServerToolCaller object`1410514106 Tool invocation generated by a server-side tool.1410714108 - `type: "code_execution_20250825"`1410914110 - `tool_id: string`1411114112 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1411314114 - `ServerToolCaller20260120 object`1411514116 - `type: "code_execution_20260120"`1411714118 - `tool_id: string`1411914120 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1412114122 - `input: map[unknown]`1412314124 - `name: string`1412514126 minLength: 11412714128 - `toolset_name: optional string or null`1412914130 For a toolset member tool_use, the toolset family.1413114132 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$1413314134 - `ServerToolUseBlock object`1413514136 - `type: "server_tool_use"`1413714138 default: server_tool_use1413914140 - `id: string`1414114142 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1414314144 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`1414514146 default: {"type":"direct"}1414714148 - `DirectCaller object`1414914150 Tool invocation directly from the model.1415114152 - `ServerToolCaller object`1415314154 Tool invocation generated by a server-side tool.1415514156 - `ServerToolCaller20260120 object`1415714158 - `input: map[unknown]`1415914160 - `name: "web_search" or "web_fetch" or "code_execution" or 4 more`1416114162 - `"web_search"`1416314164 - `"web_fetch"`1416514166 - `"code_execution"`1416714168 - `"bash_code_execution"`1416914170 - `"text_editor_code_execution"`1417114172 - `"tool_search_tool_regex"`1417314174 - `"tool_search_tool_bm25"`1417514176 - `WebSearchToolResultBlock object`1417714178 - `type: "web_search_tool_result"`1417914180 default: web_search_tool_result1418114182 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`1418314184 default: {"type":"direct"}1418514186 - `DirectCaller object`1418714188 Tool invocation directly from the model.1418914190 - `ServerToolCaller object`1419114192 Tool invocation generated by a server-side tool.1419314194 - `ServerToolCaller20260120 object`1419514196 - `content: WebSearchToolResultBlockContent`1419714198 - `WebSearchToolResultError object`1419914200 - `type: "web_search_tool_result_error"`1420114202 default: web_search_tool_result_error1420314204 - `error_code: WebSearchToolResultErrorCode`1420514206 - `"invalid_tool_input"`1420714208 - `"unavailable"`1420914210 - `"max_uses_exceeded"`1421114212 - `"too_many_requests"`1421314214 - `"query_too_long"`1421514216 - `"request_too_large"`1421714218 - `array of WebSearchResultBlock`1421914220 - `type: "web_search_result"`1422114222 default: web_search_result1422314224 - `encrypted_content: string`1422514226 - `page_age: string or null`1422714228 - `title: string`1422914230 - `url: string`1423114232 - `tool_use_id: string`1423314234 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1423514236 - `WebFetchToolResultBlock object`1423714238 - `type: "web_fetch_tool_result"`1423914240 default: web_fetch_tool_result1424114242 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`1424314244 default: {"type":"direct"}1424514246 - `DirectCaller object`1424714248 Tool invocation directly from the model.1424914250 - `ServerToolCaller object`1425114252 Tool invocation generated by a server-side tool.1425314254 - `ServerToolCaller20260120 object`1425514256 - `content: WebFetchToolResultErrorBlock or WebFetchBlock`1425714258 - `WebFetchToolResultErrorBlock object`1425914260 - `type: "web_fetch_tool_result_error"`1426114262 default: web_fetch_tool_result_error1426314264 - `error_code: WebFetchToolResultErrorCode`1426514266 - `"invalid_tool_input"`1426714268 - `"url_too_long"`1426914270 - `"url_not_allowed"`1427114272 - `"url_not_in_prior_context"`1427314274 - `"url_not_accessible"`1427514276 - `"unsupported_content_type"`1427714278 - `"too_many_requests"`1427914280 - `"max_uses_exceeded"`1428114282 - `"unavailable"`1428314284 - `"content_too_large"`1428514286 - `WebFetchBlock object`1428714288 - `type: "web_fetch_result"`1428914290 default: web_fetch_result1429114292 - `content: DocumentBlock`1429314294 - `type: "document"`1429514296 default: document1429714298 - `citations: CitationsConfig or null`1429914300 Citation configuration for the document1430114302 - `enabled: boolean`1430314304 default: false1430514306 - `source: Base64PDFSource or PlainTextSource`1430714308 - `Base64PDFSource object`1430914310 - `type: "base64"`1431114312 - `data: string`1431314314 format: byte1431514316 - `media_type: "application/pdf"`1431714318 - `PlainTextSource object`1431914320 - `type: "text"`1432114322 - `data: string`1432314324 - `media_type: "text/plain"`1432514326 - `title: string or null`1432714328 The title of the document1432914330 - `retrieved_at: string or null`1433114332 ISO 8601 timestamp when the content was retrieved1433314334 - `url: string`1433514336 Fetched content URL1433714338 - `tool_use_id: string`1433914340 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1434114342 - `CodeExecutionToolResultBlock object`1434314344 - `type: "code_execution_tool_result"`1434514346 default: code_execution_tool_result1434714348 - `content: CodeExecutionToolResultBlockContent`1434914350 - `CodeExecutionToolResultError object`1435114352 - `type: "code_execution_tool_result_error"`1435314354 default: code_execution_tool_result_error1435514356 - `error_code: CodeExecutionToolResultErrorCode`1435714358 - `"invalid_tool_input"`1435914360 - `"unavailable"`1436114362 - `"too_many_requests"`1436314364 - `"execution_time_exceeded"`1436514366 - `CodeExecutionResultBlock object`1436714368 - `type: "code_execution_result"`1436914370 default: code_execution_result1437114372 - `content: array of CodeExecutionOutputBlock`1437314374 - `type: "code_execution_output"`1437514376 default: code_execution_output1437714378 - `file_id: string`1437914380 - `return_code: number`1438114382 - `stderr: string`1438314384 - `stdout: string`1438514386 - `EncryptedCodeExecutionResultBlock object`1438714388 Code execution result with encrypted stdout for PFC + web_search results.1438914390 - `type: "encrypted_code_execution_result"`1439114392 default: encrypted_code_execution_result1439314394 - `content: array of CodeExecutionOutputBlock`1439514396 - `type: "code_execution_output"`1439714398 default: code_execution_output1439914400 - `file_id: string`1440114402 - `encrypted_stdout: string`1440314404 - `return_code: number`1440514406 - `stderr: string`1440714408 - `tool_use_id: string`1440914410 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1441114412 - `BashCodeExecutionToolResultBlock object`1441314414 - `type: "bash_code_execution_tool_result"`1441514416 default: bash_code_execution_tool_result1441714418 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`1441914420 - `BashCodeExecutionToolResultError object`1442114422 - `type: "bash_code_execution_tool_result_error"`1442314424 default: bash_code_execution_tool_result_error1442514426 - `error_code: BashCodeExecutionToolResultErrorCode`1442714428 - `"invalid_tool_input"`1442914430 - `"unavailable"`1443114432 - `"too_many_requests"`1443314434 - `"execution_time_exceeded"`1443514436 - `"output_file_too_large"`1443714438 - `BashCodeExecutionResultBlock object`1443914440 - `type: "bash_code_execution_result"`1444114442 default: bash_code_execution_result1444314444 - `content: array of BashCodeExecutionOutputBlock`1444514446 - `type: "bash_code_execution_output"`1444714448 default: bash_code_execution_output1444914450 - `file_id: string`1445114452 - `return_code: number`1445314454 - `stderr: string`1445514456 - `stdout: string`1445714458 - `tool_use_id: string`1445914460 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1446114462 - `TextEditorCodeExecutionToolResultBlock object`1446314464 - `type: "text_editor_code_execution_tool_result"`1446514466 default: text_editor_code_execution_tool_result1446714468 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`1446914470 - `TextEditorCodeExecutionToolResultError object`1447114472 - `type: "text_editor_code_execution_tool_result_error"`1447314474 default: text_editor_code_execution_tool_result_error1447514476 - `error_code: TextEditorCodeExecutionToolResultErrorCode`1447714478 - `"invalid_tool_input"`1447914480 - `"unavailable"`1448114482 - `"too_many_requests"`1448314484 - `"execution_time_exceeded"`1448514486 - `"file_not_found"`1448714488 - `error_message: string or null`1448914490 - `TextEditorCodeExecutionViewResultBlock object`1449114492 - `type: "text_editor_code_execution_view_result"`1449314494 default: text_editor_code_execution_view_result1449514496 - `content: string`1449714498 - `file_type: "text" or "image" or "pdf"`1449914500 - `"text"`1450114502 - `"image"`1450314504 - `"pdf"`1450514506 - `num_lines: number or null`1450714508 - `start_line: number or null`1450914510 - `total_lines: number or null`1451114512 - `TextEditorCodeExecutionCreateResultBlock object`1451314514 - `type: "text_editor_code_execution_create_result"`1451514516 default: text_editor_code_execution_create_result1451714518 - `is_file_update: boolean`1451914520 - `TextEditorCodeExecutionStrReplaceResultBlock object`1452114522 - `type: "text_editor_code_execution_str_replace_result"`1452314524 default: text_editor_code_execution_str_replace_result1452514526 - `lines: array of string or null`1452714528 - `new_lines: number or null`1452914530 - `new_start: number or null`1453114532 - `old_lines: number or null`1453314534 - `old_start: number or null`1453514536 - `tool_use_id: string`1453714538 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1453914540 - `ToolSearchToolResultBlock object`1454114542 - `type: "tool_search_tool_result"`1454314544 default: tool_search_tool_result1454514546 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`1454714548 - `ToolSearchToolResultError object`1454914550 - `type: "tool_search_tool_result_error"`1455114552 default: tool_search_tool_result_error1455314554 - `error_code: ToolSearchToolResultErrorCode`1455514556 - `"invalid_tool_input"`1455714558 - `"unavailable"`1455914560 - `"too_many_requests"`1456114562 - `"execution_time_exceeded"`1456314564 - `error_message: string or null`1456514566 - `ToolSearchToolSearchResultBlock object`1456714568 - `type: "tool_search_tool_search_result"`1456914570 default: tool_search_tool_search_result1457114572 - `tool_references: array of ToolReferenceBlock`1457314574 - `type: "tool_reference"`1457514576 default: tool_reference1457714578 - `tool_name: string`1457914580 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$1458114582 - `tool_use_id: string`1458314584 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1458514586 - `ContainerUploadBlock object`1458714588 Response model for a file uploaded to the container.1458914590 - `type: "container_upload"`1459114592 default: container_upload1459314594 - `file_id: string`1459514596 - `model: Model`1459714598 The model that will complete your prompt.1459914600 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.1460114602 - `"claude-fable-5-1" or "claude-mythos-5-1" or "claude-sonnet-5" or 14 more`1460314604 The model that will complete your prompt.1460514606 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.1460714608 - `"claude-fable-5-1"`1460914610 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows1461114612 - `"claude-mythos-5-1"`1461314614 Our most capable model for cybersecurity and biology research, available through trusted access programs1461514616 - `"claude-sonnet-5"`1461714618 High-performance model for coding and agents1461914620 - `"claude-fable-5"`1462114622 Next generation of intelligence for the hardest knowledge work and coding problems1462314624 - `"claude-mythos-5"`1462514626 Most capable model for cybersecurity and biology research1462714628 - `"claude-opus-5"`1462914630 Powerful intelligence for long-running agents and coding1463114632 - `"claude-opus-4-8"`1463314634 Powerful intelligence for long-running agents and coding1463514636 - `"claude-opus-4-7"`1463714638 Powerful intelligence for long-running agents and coding1463914640 - `"claude-mythos-preview"`1464114642 New class of intelligence, strongest in coding and cybersecurity1464314644 - `"claude-opus-4-6"`1464514646 Powerful intelligence for long-running agents and coding1464714648 - `"claude-sonnet-4-6"`1464914650 Best combination of speed and intelligence1465114652 - `"claude-haiku-4-5"`1465314654 Fastest model with near-frontier intelligence1465514656 - `"claude-haiku-4-5-20251001"`1465714658 Fastest model with near-frontier intelligence1465914660 - `"claude-opus-4-5"`1466114662 Powerful intelligence for long-running agents and coding1466314664 - `"claude-opus-4-5-20251101"`1466514666 Powerful intelligence for long-running agents and coding1466714668 - `"claude-sonnet-4-5"`1466914670 High-performance model for agents and coding1467114672 - `"claude-sonnet-4-5-20250929"`1467314674 High-performance model for agents and coding1467514676 - `string`1467714678 - `role: "assistant"`1467914680 Conversational role of the generated message.1468114682 This will always be `"assistant"`.1468314684 default: assistant1468514686 - `stop_details: RefusalStopDetails or null`1468714688 Structured information about a refusal.1468914690 - `type: "refusal"`1469114692 default: refusal1469314694 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`1469514696 The policy category that triggered a refusal.1469714698 - `"cyber"`1469914700 The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category.1470114702 - `"bio"`1470314704 The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category.1470514706 - `"frontier_llm"`1470714708 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.1470914710 - `"reasoning_extraction"`1471114712 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).1471314714 - `"general_harms"`1471514716 The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category.1471714718 - `explanation: string or null`1471914720 Human-readable explanation of the refusal.1472114722 This text is not guaranteed to be stable. `null` when no explanation is available for the category.1472314724 - `stop_reason: StopReason or null`1472514726 The reason that we stopped.1472714728 This may be one the following values:1472914730 * `"end_turn"`: the model reached a natural stopping point14731 * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum14732 * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated14733 * `"tool_use"`: the model invoked one or more tools14734 * `"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.14735 * `"refusal"`: when streaming classifiers intervene to handle potential policy violations14736 * `"model_context_window_exceeded"`: we exceeded the model's context window1473714738 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.1473914740 - `"end_turn"`1474114742 - `"max_tokens"`1474314744 - `"stop_sequence"`1474514746 - `"tool_use"`1474714748 - `"pause_turn"`1474914750 - `"refusal"`1475114752 - `"model_context_window_exceeded"`1475314754 - `stop_sequence: string or null`1475514756 Which custom stop sequence was generated, if any.1475714758 This value will be a non-null string if one of your custom stop sequences was generated.1475914760 - `usage: Usage`1476114762 Billing and rate-limit usage.1476314764 Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.1476514766 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.1476714768 For example, `output_tokens` will be non-zero, even for an empty string response from Claude.1476914770 Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`.1477114772 - `cache_creation: CacheCreation or null`1477314774 Breakdown of cached tokens by TTL1477514776 - `ephemeral_1h_input_tokens: number`1477714778 The number of input tokens used to create the 1 hour cache entry.1477914780 default: 0, minimum: 01478114782 - `ephemeral_5m_input_tokens: number`1478314784 The number of input tokens used to create the 5 minute cache entry.1478514786 default: 0, minimum: 01478714788 - `cache_creation_input_tokens: number or null`1478914790 The number of input tokens used to create the cache entry.1479114792 minimum: 01479314794 - `cache_read_input_tokens: number or null`1479514796 The number of input tokens read from the cache.1479714798 minimum: 01479914800 - `inference_geo: string or null`1480114802 The geographic region where inference was performed for this request.1480314804 - `input_tokens: number`1480514806 The number of input tokens which were used.1480714808 minimum: 01480914810 - `output_tokens: number`1481114812 The number of output tokens which were used.1481314814 minimum: 01481514816 - `output_tokens_details: OutputTokensDetails or null`1481714818 Breakdown of output tokens by category.1481914820 `output_tokens` remains the inclusive, authoritative total used for billing.14821 This object provides a read-only decomposition for observability — for example,14822 how many of the billed output tokens were spent on internal reasoning that may14823 have been summarized before being returned to you.1482414825 - `thinking_tokens: number`1482614827 Number of output tokens the model generated as internal reasoning, including14828 the thinking-block delimiter tokens.1482914830 Reflects the raw reasoning the model produced, not the (possibly shorter)14831 summarized thinking text returned in the response body. Computed by14832 re-tokenizing the raw reasoning text, so it may differ from the model's exact14833 generation count by a small number of tokens. Always ≤ `output_tokens`;14834 `output_tokens - thinking_tokens` approximates the non-reasoning output.1483514836 default: 0, minimum: 01483714838 - `server_tool_use: ServerToolUsage or null`1483914840 The number of server tool requests.1484114842 - `web_fetch_requests: number`1484314844 The number of web fetch tool requests.1484514846 default: 0, minimum: 01484714848 - `web_search_requests: number`1484914850 The number of web search tool requests.1485114852 default: 0, minimum: 01485314854 - `service_tier: "standard" or "priority" or "batch" or null`1485514856 If the request used the priority, standard, or batch tier.1485714858 - `"standard"`1485914860 - `"priority"`1486114862 - `"batch"`1486314864### Message Count Tokens Tool1486514866- `MessageCountTokensTool = Tool or ToolBash20250124 or CodeExecutionTool20250522 or 18 more`1486714868 - `Tool object`1486914870 - `type: optional "custom" or null`1487114872 - `input_schema: object`1487314874 [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.1487514876 This defines the shape of the `input` that your tool accepts and that the model will produce.1487714878 - `type: "object"`1487914880 - `properties: optional map[unknown] or null`1488114882 - `required: optional array of string or null`1488314884 - `name: string`1488514886 Name of the tool.1488714888 This is how the tool will be called by the model and in `tool_use` blocks.1488914890 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$1489114892 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1489314894 - `"direct"`1489514896 - `"code_execution_20250825"`1489714898 - `"code_execution_20260120"`1489914900 - `"code_execution_20260521"`1490114902 - `cache_control: optional CacheControlEphemeral or null`1490314904 Create a cache control breakpoint at this content block.1490514906 - `type: "ephemeral"`1490714908 - `ttl: optional "5m" or "1h"`1490914910 The time-to-live for the cache control breakpoint.1491114912 This may be one the following values:1491314914 - `5m`: 5 minutes14915 - `1h`: 1 hour1491614917 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.1491814919 - `"5m"`1492014921 - `"1h"`1492214923 - `defer_loading: optional boolean`1492414925 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1492614927 - `description: optional string`1492814929 Description of what this tool does.1493014931 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.1493214933 - `eager_input_streaming: optional boolean or null`1493414935 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.1493614937 - `input_examples: optional array of map[unknown]`1493814939 - `strict: optional boolean`1494014941 When true, guarantees schema validation on tool names and inputs1494214943 - `ToolBash20250124 object`1494414945 - `type: "bash_20250124"`1494614947 - `name: "bash"`1494814949 Name of the tool.1495014951 This is how the tool will be called by the model and in `tool_use` blocks.1495214953 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1495414955 - `"direct"`1495614957 - `"code_execution_20250825"`1495814959 - `"code_execution_20260120"`1496014961 - `"code_execution_20260521"`1496214963 - `cache_control: optional CacheControlEphemeral or null`1496414965 Create a cache control breakpoint at this content block.1496614967 - `defer_loading: optional boolean`1496814969 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1497014971 - `input_examples: optional array of map[unknown]`1497214973 - `strict: optional boolean`1497414975 When true, guarantees schema validation on tool names and inputs1497614977 - `CodeExecutionTool20250522 object`1497814979 - `type: "code_execution_20250522"`1498014981 - `name: "code_execution"`1498214983 Name of the tool.1498414985 This is how the tool will be called by the model and in `tool_use` blocks.1498614987 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1498814989 - `"direct"`1499014991 - `"code_execution_20250825"`1499214993 - `"code_execution_20260120"`1499414995 - `"code_execution_20260521"`1499614997 - `cache_control: optional CacheControlEphemeral or null`1499814999 Create a cache control breakpoint at this content block.1500015001 - `defer_loading: optional boolean`1500215003 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1500415005 - `strict: optional boolean`1500615007 When true, guarantees schema validation on tool names and inputs1500815009 - `CodeExecutionTool20250825 object`1501015011 - `type: "code_execution_20250825"`1501215013 - `name: "code_execution"`1501415015 Name of the tool.1501615017 This is how the tool will be called by the model and in `tool_use` blocks.1501815019 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1502015021 - `"direct"`1502215023 - `"code_execution_20250825"`1502415025 - `"code_execution_20260120"`1502615027 - `"code_execution_20260521"`1502815029 - `cache_control: optional CacheControlEphemeral or null`1503015031 Create a cache control breakpoint at this content block.1503215033 - `defer_loading: optional boolean`1503415035 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1503615037 - `strict: optional boolean`1503815039 When true, guarantees schema validation on tool names and inputs1504015041 - `CodeExecutionTool20260120 object`1504215043 Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).1504415045 - `type: "code_execution_20260120"`1504615047 - `name: "code_execution"`1504815049 Name of the tool.1505015051 This is how the tool will be called by the model and in `tool_use` blocks.1505215053 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1505415055 - `"direct"`1505615057 - `"code_execution_20250825"`1505815059 - `"code_execution_20260120"`1506015061 - `"code_execution_20260521"`1506215063 - `cache_control: optional CacheControlEphemeral or null`1506415065 Create a cache control breakpoint at this content block.1506615067 - `defer_loading: optional boolean`1506815069 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1507015071 - `strict: optional boolean`1507215073 When true, guarantees schema validation on tool names and inputs1507415075 - `CodeExecutionTool20260521 object`1507615077 Code execution tool with REPL state persistence.1507815079 - `type: "code_execution_20260521"`1508015081 - `name: "code_execution"`1508215083 Name of the tool.1508415085 This is how the tool will be called by the model and in `tool_use` blocks.1508615087 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1508815089 - `"direct"`1509015091 - `"code_execution_20250825"`1509215093 - `"code_execution_20260120"`1509415095 - `"code_execution_20260521"`1509615097 - `cache_control: optional CacheControlEphemeral or null`1509815099 Create a cache control breakpoint at this content block.1510015101 - `defer_loading: optional boolean`1510215103 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1510415105 - `strict: optional boolean`1510615107 When true, guarantees schema validation on tool names and inputs1510815109 - `BrowserToolset20260801 object`1511015111 The browser toolset: a single `tools[]` entry (carrying no15112 `name`) that declares the browser tool family. The model is served15113 the family's tool with any members disabled via `configs` removed15114 from its schema.1511515116 - `type: "browser_toolset_20260801"`1511715118 - `cache_control: optional CacheControlEphemeral or null`1511915120 Create a cache control breakpoint at this content block.1512115122 - `configs: optional BrowserToolsetConfigs or null`1512315124 Per-member configuration for `browser_toolset_20260801`: one15125 optional field per member tool, keyed by the member name — the same15126 name the member's `tool_use` blocks carry. Every member is an15127 accepted key, and a member's defaults apply wherever its key is15128 absent. Unknown keys are rejected: the field set is this toolset15129 version's complete member set.1513015131 - `type: optional BrowserTypeConfig or null`1513215133 `type`'s config overrides.1513415135 - `defer_loading: optional boolean or null`1513615137 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1513815139 - `enabled: optional boolean or null`1514015141 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1514215143 - `close_tab: optional BrowserCloseTabConfig or null`1514415145 `close_tab`'s config overrides.1514615147 - `defer_loading: optional boolean or null`1514815149 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1515015151 - `enabled: optional boolean or null`1515215153 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1515415155 - `double_click: optional BrowserDoubleClickConfig or null`1515615157 `double_click`'s config overrides.1515815159 - `defer_loading: optional boolean or null`1516015161 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1516215163 - `enabled: optional boolean or null`1516415165 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1516615167 - `file_upload: optional BrowserFileUploadConfig or null`1516815169 `file_upload`'s config overrides.1517015171 - `defer_loading: optional boolean or null`1517215173 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1517415175 - `enabled: optional boolean or null`1517615177 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1517815179 - `find: optional BrowserFindConfig or null`1518015181 `find`'s config overrides.1518215183 - `defer_loading: optional boolean or null`1518415185 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1518615187 - `enabled: optional boolean or null`1518815189 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1519015191 - `form_input: optional BrowserFormInputConfig or null`1519215193 `form_input`'s config overrides.1519415195 - `defer_loading: optional boolean or null`1519615197 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1519815199 - `enabled: optional boolean or null`1520015201 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1520215203 - `get_page_text: optional BrowserGetPageTextConfig or null`1520415205 `get_page_text`'s config overrides.1520615207 - `defer_loading: optional boolean or null`1520815209 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1521015211 - `enabled: optional boolean or null`1521215213 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1521415215 - `hold_key: optional BrowserHoldKeyConfig or null`1521615217 `hold_key`'s config overrides.1521815219 - `defer_loading: optional boolean or null`1522015221 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1522215223 - `enabled: optional boolean or null`1522415225 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1522615227 - `hover: optional BrowserHoverConfig or null`1522815229 `hover`'s config overrides.1523015231 - `defer_loading: optional boolean or null`1523215233 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1523415235 - `enabled: optional boolean or null`1523615237 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1523815239 - `javascript_exec: optional BrowserJavascriptExecConfig or null`1524015241 `javascript_exec`'s config overrides.1524215243 - `defer_loading: optional boolean or null`1524415245 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1524615247 - `enabled: optional boolean or null`1524815249 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1525015251 - `key: optional BrowserKeyConfig or null`1525215253 `key`'s config overrides.1525415255 - `defer_loading: optional boolean or null`1525615257 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1525815259 - `enabled: optional boolean or null`1526015261 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1526215263 - `left_click: optional BrowserLeftClickConfig or null`1526415265 `left_click`'s config overrides.1526615267 - `defer_loading: optional boolean or null`1526815269 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1527015271 - `enabled: optional boolean or null`1527215273 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1527415275 - `left_click_drag: optional BrowserLeftClickDragConfig or null`1527615277 `left_click_drag`'s config overrides.1527815279 - `defer_loading: optional boolean or null`1528015281 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1528215283 - `enabled: optional boolean or null`1528415285 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1528615287 - `left_mouse_down: optional BrowserLeftMouseDownConfig or null`1528815289 `left_mouse_down`'s config overrides.1529015291 - `defer_loading: optional boolean or null`1529215293 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1529415295 - `enabled: optional boolean or null`1529615297 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1529815299 - `left_mouse_up: optional BrowserLeftMouseUpConfig or null`1530015301 `left_mouse_up`'s config overrides.1530215303 - `defer_loading: optional boolean or null`1530415305 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1530615307 - `enabled: optional boolean or null`1530815309 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1531015311 - `list_tabs: optional BrowserListTabsConfig or null`1531215313 `list_tabs`'s config overrides.1531415315 - `defer_loading: optional boolean or null`1531615317 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1531815319 - `enabled: optional boolean or null`1532015321 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1532215323 - `middle_click: optional BrowserMiddleClickConfig or null`1532415325 `middle_click`'s config overrides.1532615327 - `defer_loading: optional boolean or null`1532815329 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1533015331 - `enabled: optional boolean or null`1533215333 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1533415335 - `mouse_move: optional BrowserMouseMoveConfig or null`1533615337 `mouse_move`'s config overrides.1533815339 - `defer_loading: optional boolean or null`1534015341 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1534215343 - `enabled: optional boolean or null`1534415345 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1534615347 - `navigate: optional BrowserNavigateConfig or null`1534815349 `navigate`'s config overrides.1535015351 - `defer_loading: optional boolean or null`1535215353 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1535415355 - `enabled: optional boolean or null`1535615357 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1535815359 - `new_tab: optional BrowserNewTabConfig or null`1536015361 `new_tab`'s config overrides.1536215363 - `defer_loading: optional boolean or null`1536415365 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1536615367 - `enabled: optional boolean or null`1536815369 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1537015371 - `read_console: optional BrowserReadConsoleConfig or null`1537215373 `read_console`'s config overrides.1537415375 - `defer_loading: optional boolean or null`1537615377 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1537815379 - `enabled: optional boolean or null`1538015381 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1538215383 - `read_network: optional BrowserReadNetworkConfig or null`1538415385 `read_network`'s config overrides.1538615387 - `defer_loading: optional boolean or null`1538815389 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1539015391 - `enabled: optional boolean or null`1539215393 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1539415395 - `read_page: optional BrowserReadPageConfig or null`1539615397 `read_page`'s config overrides.1539815399 - `defer_loading: optional boolean or null`1540015401 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1540215403 - `enabled: optional boolean or null`1540415405 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1540615407 - `right_click: optional BrowserRightClickConfig or null`1540815409 `right_click`'s config overrides.1541015411 - `defer_loading: optional boolean or null`1541215413 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1541415415 - `enabled: optional boolean or null`1541615417 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1541815419 - `screenshot: optional BrowserScreenshotConfig or null`1542015421 `screenshot`'s config overrides.1542215423 - `defer_loading: optional boolean or null`1542415425 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1542615427 - `enabled: optional boolean or null`1542815429 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1543015431 - `scroll: optional BrowserScrollConfig or null`1543215433 `scroll`'s config overrides.1543415435 - `defer_loading: optional boolean or null`1543615437 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1543815439 - `enabled: optional boolean or null`1544015441 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1544215443 - `scroll_to: optional BrowserScrollToConfig or null`1544415445 `scroll_to`'s config overrides.1544615447 - `defer_loading: optional boolean or null`1544815449 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1545015451 - `enabled: optional boolean or null`1545215453 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1545415455 - `switch_tab: optional BrowserSwitchTabConfig or null`1545615457 `switch_tab`'s config overrides.1545815459 - `defer_loading: optional boolean or null`1546015461 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1546215463 - `enabled: optional boolean or null`1546415465 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1546615467 - `triple_click: optional BrowserTripleClickConfig or null`1546815469 `triple_click`'s config overrides.1547015471 - `defer_loading: optional boolean or null`1547215473 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1547415475 - `enabled: optional boolean or null`1547615477 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1547815479 - `wait: optional BrowserWaitConfig or null`1548015481 `wait`'s config overrides.1548215483 - `defer_loading: optional boolean or null`1548415485 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1548615487 - `enabled: optional boolean or null`1548815489 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1549015491 - `zoom: optional BrowserZoomConfig or null`1549215493 `zoom`'s config overrides.1549415495 - `defer_loading: optional boolean or null`1549615497 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1549815499 - `enabled: optional boolean or null`1550015501 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1550215503 - `MemoryTool20250818 object`1550415505 - `type: "memory_20250818"`1550615507 - `name: "memory"`1550815509 Name of the tool.1551015511 This is how the tool will be called by the model and in `tool_use` blocks.1551215513 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1551415515 - `"direct"`1551615517 - `"code_execution_20250825"`1551815519 - `"code_execution_20260120"`1552015521 - `"code_execution_20260521"`1552215523 - `cache_control: optional CacheControlEphemeral or null`1552415525 Create a cache control breakpoint at this content block.1552615527 - `defer_loading: optional boolean`1552815529 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1553015531 - `input_examples: optional array of map[unknown]`1553215533 - `strict: optional boolean`1553415535 When true, guarantees schema validation on tool names and inputs1553615537 - `ComputerToolset20260801 object`1553815539 The computer toolset: a single `tools[]` entry (carrying no15540 `name`) that declares the computer tool family. The model is15541 served the family's tool with any members disabled via `configs`15542 removed from its schema. Every member is enabled by default, zoom15543 included. The single-tool options `display_number` and15544 `enable_zoom` are not fields of a toolset entry — it carries only15545 `type`, `configs`, and `cache_control`; zoom is controlled15546 via `configs.zoom.enabled`.1554715548 - `type: "computer_toolset_20260801"`1554915550 - `cache_control: optional CacheControlEphemeral or null`1555115552 Create a cache control breakpoint at this content block.1555315554 - `configs: optional ComputerToolsetConfigs or null`1555515556 Per-member configuration for `computer_toolset_20260801`: one15557 optional field per member tool, keyed by the member name — the same15558 name the member's `tool_use` blocks carry. Every member is an15559 accepted key, and a member's defaults apply wherever its key is15560 absent. Unknown keys are rejected: the field set is this toolset15561 version's complete member set.1556215563 - `type: optional ComputerTypeConfig or null`1556415565 `type`'s config overrides.1556615567 - `defer_loading: optional boolean or null`1556815569 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1557015571 - `enabled: optional boolean or null`1557215573 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1557415575 - `cursor_position: optional ComputerCursorPositionConfig or null`1557615577 `cursor_position`'s config overrides.1557815579 - `defer_loading: optional boolean or null`1558015581 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1558215583 - `enabled: optional boolean or null`1558415585 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1558615587 - `double_click: optional ComputerDoubleClickConfig or null`1558815589 `double_click`'s config overrides.1559015591 - `defer_loading: optional boolean or null`1559215593 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1559415595 - `enabled: optional boolean or null`1559615597 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1559815599 - `hold_key: optional ComputerHoldKeyConfig or null`1560015601 `hold_key`'s config overrides.1560215603 - `defer_loading: optional boolean or null`1560415605 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1560615607 - `enabled: optional boolean or null`1560815609 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1561015611 - `key: optional ComputerKeyConfig or null`1561215613 `key`'s config overrides.1561415615 - `defer_loading: optional boolean or null`1561615617 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1561815619 - `enabled: optional boolean or null`1562015621 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1562215623 - `left_click: optional ComputerLeftClickConfig or null`1562415625 `left_click`'s config overrides.1562615627 - `defer_loading: optional boolean or null`1562815629 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1563015631 - `enabled: optional boolean or null`1563215633 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1563415635 - `left_click_drag: optional ComputerLeftClickDragConfig or null`1563615637 `left_click_drag`'s config overrides.1563815639 - `defer_loading: optional boolean or null`1564015641 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1564215643 - `enabled: optional boolean or null`1564415645 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1564615647 - `left_mouse_down: optional ComputerLeftMouseDownConfig or null`1564815649 `left_mouse_down`'s config overrides.1565015651 - `defer_loading: optional boolean or null`1565215653 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1565415655 - `enabled: optional boolean or null`1565615657 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1565815659 - `left_mouse_up: optional ComputerLeftMouseUpConfig or null`1566015661 `left_mouse_up`'s config overrides.1566215663 - `defer_loading: optional boolean or null`1566415665 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1566615667 - `enabled: optional boolean or null`1566815669 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1567015671 - `middle_click: optional ComputerMiddleClickConfig or null`1567215673 `middle_click`'s config overrides.1567415675 - `defer_loading: optional boolean or null`1567615677 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1567815679 - `enabled: optional boolean or null`1568015681 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1568215683 - `mouse_move: optional ComputerMouseMoveConfig or null`1568415685 `mouse_move`'s config overrides.1568615687 - `defer_loading: optional boolean or null`1568815689 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1569015691 - `enabled: optional boolean or null`1569215693 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1569415695 - `right_click: optional ComputerRightClickConfig or null`1569615697 `right_click`'s config overrides.1569815699 - `defer_loading: optional boolean or null`1570015701 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1570215703 - `enabled: optional boolean or null`1570415705 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1570615707 - `screenshot: optional ComputerScreenshotConfig or null`1570815709 `screenshot`'s config overrides.1571015711 - `defer_loading: optional boolean or null`1571215713 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1571415715 - `enabled: optional boolean or null`1571615717 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1571815719 - `scroll: optional ComputerScrollConfig or null`1572015721 `scroll`'s config overrides.1572215723 - `defer_loading: optional boolean or null`1572415725 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1572615727 - `enabled: optional boolean or null`1572815729 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1573015731 - `triple_click: optional ComputerTripleClickConfig or null`1573215733 `triple_click`'s config overrides.1573415735 - `defer_loading: optional boolean or null`1573615737 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1573815739 - `enabled: optional boolean or null`1574015741 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1574215743 - `wait: optional ComputerWaitConfig or null`1574415745 `wait`'s config overrides.1574615747 - `defer_loading: optional boolean or null`1574815749 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1575015751 - `enabled: optional boolean or null`1575215753 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1575415755 - `zoom: optional ComputerZoomConfig or null`1575615757 `zoom`'s config overrides.1575815759 - `defer_loading: optional boolean or null`1576015761 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.1576215763 - `enabled: optional boolean or null`1576415765 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.1576615767 - `ToolTextEditor20250124 object`1576815769 - `type: "text_editor_20250124"`1577015771 - `name: "str_replace_editor"`1577215773 Name of the tool.1577415775 This is how the tool will be called by the model and in `tool_use` blocks.1577615777 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1577815779 - `"direct"`1578015781 - `"code_execution_20250825"`1578215783 - `"code_execution_20260120"`1578415785 - `"code_execution_20260521"`1578615787 - `cache_control: optional CacheControlEphemeral or null`1578815789 Create a cache control breakpoint at this content block.1579015791 - `defer_loading: optional boolean`1579215793 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1579415795 - `input_examples: optional array of map[unknown]`1579615797 - `strict: optional boolean`1579815799 When true, guarantees schema validation on tool names and inputs1580015801 - `ToolTextEditor20250429 object`1580215803 - `type: "text_editor_20250429"`1580415805 - `name: "str_replace_based_edit_tool"`1580615807 Name of the tool.1580815809 This is how the tool will be called by the model and in `tool_use` blocks.1581015811 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1581215813 - `"direct"`1581415815 - `"code_execution_20250825"`1581615817 - `"code_execution_20260120"`1581815819 - `"code_execution_20260521"`1582015821 - `cache_control: optional CacheControlEphemeral or null`1582215823 Create a cache control breakpoint at this content block.1582415825 - `defer_loading: optional boolean`1582615827 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1582815829 - `input_examples: optional array of map[unknown]`1583015831 - `strict: optional boolean`1583215833 When true, guarantees schema validation on tool names and inputs1583415835 - `ToolTextEditor20250728 object`1583615837 - `type: "text_editor_20250728"`1583815839 - `name: "str_replace_based_edit_tool"`1584015841 Name of the tool.1584215843 This is how the tool will be called by the model and in `tool_use` blocks.1584415845 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1584615847 - `"direct"`1584815849 - `"code_execution_20250825"`1585015851 - `"code_execution_20260120"`1585215853 - `"code_execution_20260521"`1585415855 - `cache_control: optional CacheControlEphemeral or null`1585615857 Create a cache control breakpoint at this content block.1585815859 - `defer_loading: optional boolean`1586015861 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1586215863 - `input_examples: optional array of map[unknown]`1586415865 - `max_characters: optional number or null`1586615867 Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.1586815869 minimum: 11587015871 - `strict: optional boolean`1587215873 When true, guarantees schema validation on tool names and inputs1587415875 - `WebSearchTool20250305 object`1587615877 - `type: "web_search_20250305"`1587815879 - `name: "web_search"`1588015881 Name of the tool.1588215883 This is how the tool will be called by the model and in `tool_use` blocks.1588415885 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1588615887 - `"direct"`1588815889 - `"code_execution_20250825"`1589015891 - `"code_execution_20260120"`1589215893 - `"code_execution_20260521"`1589415895 - `allowed_domains: optional array of string or null`1589615897 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.1589815899 - `blocked_domains: optional array of string or null`1590015901 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.1590215903 - `cache_control: optional CacheControlEphemeral or null`1590415905 Create a cache control breakpoint at this content block.1590615907 - `defer_loading: optional boolean`1590815909 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1591015911 - `max_uses: optional number or null`1591215913 Maximum number of times the tool can be used in the API request.1591415915 exclusiveMinimum: 01591615917 - `strict: optional boolean`1591815919 When true, guarantees schema validation on tool names and inputs1592015921 - `user_location: optional UserLocation or null`1592215923 Parameters for the user's location. Used to provide more relevant search results.1592415925 - `type: "approximate"`1592615927 - `city: optional string or null`1592815929 The city of the user.1593015931 maxLength: 255, minLength: 11593215933 - `country: optional string or null`1593415935 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.1593615937 maxLength: 2, minLength: 21593815939 - `region: optional string or null`1594015941 The region of the user.1594215943 maxLength: 255, minLength: 11594415945 - `timezone: optional string or null`1594615947 The [IANA timezone](https://nodatime.org/TimeZones) of the user.1594815949 maxLength: 255, minLength: 11595015951 - `WebFetchTool20250910 object`1595215953 - `type: "web_fetch_20250910"`1595415955 - `name: "web_fetch"`1595615957 Name of the tool.1595815959 This is how the tool will be called by the model and in `tool_use` blocks.1596015961 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1596215963 - `"direct"`1596415965 - `"code_execution_20250825"`1596615967 - `"code_execution_20260120"`1596815969 - `"code_execution_20260521"`1597015971 - `allowed_domains: optional array of string or null`1597215973 List of domains to allow fetching from1597415975 - `blocked_domains: optional array of string or null`1597615977 List of domains to block fetching from1597815979 - `cache_control: optional CacheControlEphemeral or null`1598015981 Create a cache control breakpoint at this content block.1598215983 - `citations: optional CitationsConfigParam or null`1598415985 Citations configuration for fetched documents. Citations are disabled by default.1598615987 - `enabled: optional boolean`1598815989 - `defer_loading: optional boolean`1599015991 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1599215993 - `max_content_tokens: optional number or null`1599415995 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.1599615997 exclusiveMinimum: 01599815999 - `max_uses: optional number or null`1600016001 Maximum number of times the tool can be used in the API request.1600216003 exclusiveMinimum: 01600416005 - `strict: optional boolean`1600616007 When true, guarantees schema validation on tool names and inputs1600816009 - `url_sources: optional WebFetchURLSources or null`1601016011 Which sources contribute to the set of URLs web fetch may fetch.1601216013 Each key is a tagged variant: `user_input` is `all` or `none`; the16014 two tool filters are `all`, `none`, `only` (only the named tools'16015 results) or `except` (every result but the named tools'). A named tool16016 must be declared in this request's `tools[]`.1601716018 - `client_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`1601916020 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].1602116022 - `WebFetchURLSourceAll object`1602316024 The `url_sources` variant under which a source contributes in16025 full: every result of the tool filter's source, or all user input.1602616027 - `type: "all"`1602816029 - `WebFetchURLSourceNone object`1603016031 The `url_sources` variant under which a source contributes nothing:16032 no result of the tool filter's source, or no user input.1603316034 - `type: "none"`1603516036 - `WebFetchURLSourceOnly object`1603716038 The tool filter variant under which only the named tools' results16039 contribute.1604016041 - `type: "only"`1604216043 - `tools: array of WebFetchURLSourceToolReference`1604416045 - `type: "tool_reference"`1604616047 - `name: string`1604816049 - `WebFetchURLSourceExcept object`1605016051 The tool filter variant under which every result but the named16052 tools' contributes.1605316054 - `type: "except"`1605516056 - `tools: array of WebFetchURLSourceToolReference`1605716058 - `type: "tool_reference"`1605916060 - `name: string`1606116062 - `server_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`1606316064 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.1606516066 - `WebFetchURLSourceAll object`1606716068 The `url_sources` variant under which a source contributes in16069 full: every result of the tool filter's source, or all user input.1607016071 - `WebFetchURLSourceNone object`1607216073 The `url_sources` variant under which a source contributes nothing:16074 no result of the tool filter's source, or no user input.1607516076 - `WebFetchURLSourceOnly object`1607716078 The tool filter variant under which only the named tools' results16079 contribute.1608016081 - `WebFetchURLSourceExcept object`1608216083 The tool filter variant under which every result but the named16084 tools' contributes.1608516086 - `user_input: optional WebFetchURLSourceAll or WebFetchURLSourceNone`1608716088 Whether URLs in user messages are fetchable: "all" or "none".1608916090 - `WebFetchURLSourceAll object`1609116092 The `url_sources` variant under which a source contributes in16093 full: every result of the tool filter's source, or all user input.1609416095 - `WebFetchURLSourceNone object`1609616097 The `url_sources` variant under which a source contributes nothing:16098 no result of the tool filter's source, or no user input.1609916100 - `WebSearchTool20260209 object`1610116102 - `type: "web_search_20260209"`1610316104 - `name: "web_search"`1610516106 Name of the tool.1610716108 This is how the tool will be called by the model and in `tool_use` blocks.1610916110 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1611116112 - `"direct"`1611316114 - `"code_execution_20250825"`1611516116 - `"code_execution_20260120"`1611716118 - `"code_execution_20260521"`1611916120 - `allowed_domains: optional array of string or null`1612116122 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.1612316124 - `blocked_domains: optional array of string or null`1612516126 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.1612716128 - `cache_control: optional CacheControlEphemeral or null`1612916130 Create a cache control breakpoint at this content block.1613116132 - `defer_loading: optional boolean`1613316134 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1613516136 - `max_uses: optional number or null`1613716138 Maximum number of times the tool can be used in the API request.1613916140 exclusiveMinimum: 01614116142 - `strict: optional boolean`1614316144 When true, guarantees schema validation on tool names and inputs1614516146 - `user_location: optional UserLocation or null`1614716148 Parameters for the user's location. Used to provide more relevant search results.1614916150 - `WebFetchTool20260209 object`1615116152 - `type: "web_fetch_20260209"`1615316154 - `name: "web_fetch"`1615516156 Name of the tool.1615716158 This is how the tool will be called by the model and in `tool_use` blocks.1615916160 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1616116162 - `"direct"`1616316164 - `"code_execution_20250825"`1616516166 - `"code_execution_20260120"`1616716168 - `"code_execution_20260521"`1616916170 - `allowed_domains: optional array of string or null`1617116172 List of domains to allow fetching from1617316174 - `blocked_domains: optional array of string or null`1617516176 List of domains to block fetching from1617716178 - `cache_control: optional CacheControlEphemeral or null`1617916180 Create a cache control breakpoint at this content block.1618116182 - `citations: optional CitationsConfigParam or null`1618316184 Citations configuration for fetched documents. Citations are disabled by default.1618516186 - `defer_loading: optional boolean`1618716188 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1618916190 - `max_content_tokens: optional number or null`1619116192 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.1619316194 exclusiveMinimum: 01619516196 - `max_uses: optional number or null`1619716198 Maximum number of times the tool can be used in the API request.1619916200 exclusiveMinimum: 01620116202 - `strict: optional boolean`1620316204 When true, guarantees schema validation on tool names and inputs1620516206 - `url_sources: optional WebFetchURLSources or null`1620716208 Which sources contribute to the set of URLs web fetch may fetch.1620916210 Each key is a tagged variant: `user_input` is `all` or `none`; the16211 two tool filters are `all`, `none`, `only` (only the named tools'16212 results) or `except` (every result but the named tools'). A named tool16213 must be declared in this request's `tools[]`.1621416215 - `WebFetchTool20260309 object`1621616217 Web fetch tool with use_cache parameter for bypassing cached content.1621816219 - `type: "web_fetch_20260309"`1622016221 - `name: "web_fetch"`1622216223 Name of the tool.1622416225 This is how the tool will be called by the model and in `tool_use` blocks.1622616227 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1622816229 - `"direct"`1623016231 - `"code_execution_20250825"`1623216233 - `"code_execution_20260120"`1623416235 - `"code_execution_20260521"`1623616237 - `allowed_domains: optional array of string or null`1623816239 List of domains to allow fetching from1624016241 - `blocked_domains: optional array of string or null`1624216243 List of domains to block fetching from1624416245 - `cache_control: optional CacheControlEphemeral or null`1624616247 Create a cache control breakpoint at this content block.1624816249 - `citations: optional CitationsConfigParam or null`1625016251 Citations configuration for fetched documents. Citations are disabled by default.1625216253 - `defer_loading: optional boolean`1625416255 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1625616257 - `max_content_tokens: optional number or null`1625816259 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.1626016261 exclusiveMinimum: 01626216263 - `max_uses: optional number or null`1626416265 Maximum number of times the tool can be used in the API request.1626616267 exclusiveMinimum: 01626816269 - `strict: optional boolean`1627016271 When true, guarantees schema validation on tool names and inputs1627216273 - `url_sources: optional WebFetchURLSources or null`1627416275 Which sources contribute to the set of URLs web fetch may fetch.1627616277 Each key is a tagged variant: `user_input` is `all` or `none`; the16278 two tool filters are `all`, `none`, `only` (only the named tools'16279 results) or `except` (every result but the named tools'). A named tool16280 must be declared in this request's `tools[]`.1628116282 - `use_cache: optional boolean`1628316284 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.1628516286 - `WebSearchTool20260318 object`1628716288 - `type: "web_search_20260318"`1628916290 - `name: "web_search"`1629116292 Name of the tool.1629316294 This is how the tool will be called by the model and in `tool_use` blocks.1629516296 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1629716298 - `"direct"`1629916300 - `"code_execution_20250825"`1630116302 - `"code_execution_20260120"`1630316304 - `"code_execution_20260521"`1630516306 - `allowed_domains: optional array of string or null`1630716308 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.1630916310 - `blocked_domains: optional array of string or null`1631116312 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.1631316314 - `cache_control: optional CacheControlEphemeral or null`1631516316 Create a cache control breakpoint at this content block.1631716318 - `defer_loading: optional boolean`1631916320 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1632116322 - `max_uses: optional number or null`1632316324 Maximum number of times the tool can be used in the API request.1632516326 exclusiveMinimum: 01632716328 - `response_inclusion: optional "full" or "excluded"`1632916330 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.1633116332 - `"full"`1633316334 - `"excluded"`1633516336 - `strict: optional boolean`1633716338 When true, guarantees schema validation on tool names and inputs1633916340 - `user_location: optional UserLocation or null`1634116342 Parameters for the user's location. Used to provide more relevant search results.1634316344 - `WebFetchTool20260318 object`1634516346 - `type: "web_fetch_20260318"`1634716348 - `name: "web_fetch"`1634916350 Name of the tool.1635116352 This is how the tool will be called by the model and in `tool_use` blocks.1635316354 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1635516356 - `"direct"`1635716358 - `"code_execution_20250825"`1635916360 - `"code_execution_20260120"`1636116362 - `"code_execution_20260521"`1636316364 - `allowed_domains: optional array of string or null`1636516366 List of domains to allow fetching from1636716368 - `blocked_domains: optional array of string or null`1636916370 List of domains to block fetching from1637116372 - `cache_control: optional CacheControlEphemeral or null`1637316374 Create a cache control breakpoint at this content block.1637516376 - `citations: optional CitationsConfigParam or null`1637716378 Citations configuration for fetched documents. Citations are disabled by default.1637916380 - `defer_loading: optional boolean`1638116382 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1638316384 - `max_content_tokens: optional number or null`1638516386 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.1638716388 exclusiveMinimum: 01638916390 - `max_uses: optional number or null`1639116392 Maximum number of times the tool can be used in the API request.1639316394 exclusiveMinimum: 01639516396 - `response_inclusion: optional "full" or "excluded"`1639716398 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.1639916400 - `"full"`1640116402 - `"excluded"`1640316404 - `strict: optional boolean`1640516406 When true, guarantees schema validation on tool names and inputs1640716408 - `url_sources: optional WebFetchURLSources or null`1640916410 Which sources contribute to the set of URLs web fetch may fetch.1641116412 Each key is a tagged variant: `user_input` is `all` or `none`; the16413 two tool filters are `all`, `none`, `only` (only the named tools'16414 results) or `except` (every result but the named tools'). A named tool16415 must be declared in this request's `tools[]`.1641616417 - `use_cache: optional boolean`1641816419 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.1642016421 - `ToolSearchToolBm25_20251119 object`1642216423 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`1642416425 - `"tool_search_tool_bm25_20251119"`1642616427 - `"tool_search_tool_bm25"`1642816429 - `name: "tool_search_tool_bm25"`1643016431 Name of the tool.1643216433 This is how the tool will be called by the model and in `tool_use` blocks.1643416435 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1643616437 - `"direct"`1643816439 - `"code_execution_20250825"`1644016441 - `"code_execution_20260120"`1644216443 - `"code_execution_20260521"`1644416445 - `cache_control: optional CacheControlEphemeral or null`1644616447 Create a cache control breakpoint at this content block.1644816449 - `defer_loading: optional boolean`1645016451 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1645216453 - `strict: optional boolean`1645416455 When true, guarantees schema validation on tool names and inputs1645616457 - `ToolSearchToolRegex20251119 object`1645816459 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`1646016461 - `"tool_search_tool_regex_20251119"`1646216463 - `"tool_search_tool_regex"`1646416465 - `name: "tool_search_tool_regex"`1646616467 Name of the tool.1646816469 This is how the tool will be called by the model and in `tool_use` blocks.1647016471 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`1647216473 - `"direct"`1647416475 - `"code_execution_20250825"`1647616477 - `"code_execution_20260120"`1647816479 - `"code_execution_20260521"`1648016481 - `cache_control: optional CacheControlEphemeral or null`1648216483 Create a cache control breakpoint at this content block.1648416485 - `defer_loading: optional boolean`1648616487 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.1648816489 - `strict: optional boolean`1649016491 When true, guarantees schema validation on tool names and inputs1649216493### Message Create Params Container1649416495- `MessageCreateParamsContainer = ContainerParams or string`1649616497 Container identifier for reuse across requests.1649816499 - `ContainerParams object`1650016501 Container parameters with skills to be loaded.1650216503 - `id: optional string or null`1650416505 Container id1650616507 - `skills: optional array of SkillParams or null`1650816509 List of skills to load in the container1651016511 maxItems: 201651216513 - `type: "anthropic" or "custom"`1651416515 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)1651616517 - `"anthropic"`1651816519 - `"custom"`1652016521 - `skill_id: string`1652216523 Skill ID1652416525 maxLength: 64, minLength: 11652616527 - `version: optional string`1652816529 Skill version or 'latest' for most recent version1653016531 maxLength: 64, minLength: 11653216533 - `string`1653416535### Message Delta Usage1653616537- `MessageDeltaUsage object`1653816539 - `cache_creation_input_tokens: number or null`1654016541 The cumulative number of input tokens used to create the cache entry.1654216543 minimum: 01654416545 - `cache_read_input_tokens: number or null`1654616547 The cumulative number of input tokens read from the cache.1654816549 minimum: 01655016551 - `input_tokens: number or null`1655216553 The cumulative number of input tokens which were used.1655416555 minimum: 01655616557 - `output_tokens: number`1655816559 The cumulative number of output tokens which were used.1656016561 - `output_tokens_details: OutputTokensDetails or null`1656216563 Breakdown of output tokens by category.1656416565 `output_tokens` remains the inclusive, authoritative total used for billing.16566 This object provides a read-only decomposition for observability — for example,16567 how many of the billed output tokens were spent on internal reasoning that may16568 have been summarized before being returned to you.1656916570 - `thinking_tokens: number`1657116572 Number of output tokens the model generated as internal reasoning, including16573 the thinking-block delimiter tokens.1657416575 Reflects the raw reasoning the model produced, not the (possibly shorter)16576 summarized thinking text returned in the response body. Computed by16577 re-tokenizing the raw reasoning text, so it may differ from the model's exact16578 generation count by a small number of tokens. Always ≤ `output_tokens`;16579 `output_tokens - thinking_tokens` approximates the non-reasoning output.1658016581 default: 0, minimum: 01658216583 - `server_tool_use: ServerToolUsage or null`1658416585 The number of server tool requests.1658616587 - `web_fetch_requests: number`1658816589 The number of web fetch tool requests.1659016591 default: 0, minimum: 01659216593 - `web_search_requests: number`1659416595 The number of web search tool requests.1659616597 default: 0, minimum: 01659816599### Message Param1660016601- `MessageParam object`1660216603 - `content: string or array of ContentBlockParam`1660416605 - `string`1660616607 - `array of ContentBlockParam`1660816609 - `TextBlockParam object`1661016611 - `type: "text"`1661216613 - `text: string`1661416615 minLength: 11661616617 - `cache_control: optional CacheControlEphemeral or null`1661816619 Create a cache control breakpoint at this content block.1662016621 - `type: "ephemeral"`1662216623 - `ttl: optional "5m" or "1h"`1662416625 The time-to-live for the cache control breakpoint.1662616627 This may be one the following values:1662816629 - `5m`: 5 minutes16630 - `1h`: 1 hour1663116632 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.1663316634 - `"5m"`1663516636 - `"1h"`1663716638 - `citations: optional array of TextCitationParam or null`1663916640 - `CitationCharLocationParam object`1664116642 - `type: "char_location"`1664316644 - `cited_text: string`1664516646 - `document_index: number`1664716648 minimum: 01664916650 - `document_title: string or null`1665116652 maxLength: 500, minLength: 11665316654 - `end_char_index: number`1665516656 - `start_char_index: number`1665716658 minimum: 01665916660 - `CitationPageLocationParam object`1666116662 - `type: "page_location"`1666316664 - `cited_text: string`1666516666 - `document_index: number`1666716668 minimum: 01666916670 - `document_title: string or null`1667116672 maxLength: 500, minLength: 11667316674 - `end_page_number: number`1667516676 - `start_page_number: number`1667716678 minimum: 11667916680 - `CitationContentBlockLocationParam object`1668116682 - `type: "content_block_location"`1668316684 - `cited_text: string`1668516686 The full text of the cited block range, concatenated.1668716688 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.1668916690 - `document_index: number`1669116692 minimum: 01669316694 - `document_title: string or null`1669516696 maxLength: 500, minLength: 11669716698 - `end_block_index: number`1669916700 Exclusive 0-based end index of the cited block range in the source's `content` array.1670116702 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1670316704 - `start_block_index: number`1670516706 0-based index of the first cited block in the source's `content` array.1670716708 minimum: 01670916710 - `CitationWebSearchResultLocationParam object`1671116712 - `type: "web_search_result_location"`1671316714 - `cited_text: string`1671516716 - `encrypted_index: string`1671716718 - `title: string or null`1671916720 maxLength: 512, minLength: 11672116722 - `url: string`1672316724 minLength: 11672516726 - `CitationSearchResultLocationParam object`1672716728 - `type: "search_result_location"`1672916730 - `cited_text: string`1673116732 The full text of the cited block range, concatenated.1673316734 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.1673516736 - `end_block_index: number`1673716738 Exclusive 0-based end index of the cited block range in the source's `content` array.1673916740 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1674116742 - `search_result_index: number`1674316744 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.1674516746 Counted separately from `document_index`; server-side web search results are not included in this count.1674716748 minimum: 01674916750 - `source: string`1675116752 - `start_block_index: number`1675316754 0-based index of the first cited block in the source's `content` array.1675516756 minimum: 01675716758 - `title: string or null`1675916760 - `ImageBlockParam object`1676116762 - `type: "image"`1676316764 - `source: Base64ImageSource or URLImageSource or FileImageSource`1676516766 - `Base64ImageSource object`1676716768 - `type: "base64"`1676916770 - `data: string`1677116772 format: byte1677316774 - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"`1677516776 - `"image/jpeg"`1677716778 - `"image/png"`1677916780 - `"image/gif"`1678116782 - `"image/webp"`1678316784 - `URLImageSource object`1678516786 - `type: "url"`1678716788 - `url: string`1678916790 - `FileImageSource object`1679116792 - `type: "file"`1679316794 - `file_id: string`1679516796 - `cache_control: optional CacheControlEphemeral or null`1679716798 Create a cache control breakpoint at this content block.1679916800 - `transformations: optional ImageTransformationsParam or null`1680116802 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.1680316804 - `oversized_image: optional "downsize" or "error"`1680516806 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.1680716808 - `"downsize"`1680916810 - `"error"`1681116812 - `DocumentBlockParam object`1681316814 - `type: "document"`1681516816 - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more`1681716818 - `Base64PDFSource object`1681916820 - `type: "base64"`1682116822 - `data: string`1682316824 format: byte1682516826 - `media_type: "application/pdf"`1682716828 - `PlainTextSource object`1682916830 - `type: "text"`1683116832 - `data: string`1683316834 - `media_type: "text/plain"`1683516836 - `ContentBlockSource object`1683716838 - `type: "content"`1683916840 - `content: string or array of ContentBlockSourceContent`1684116842 - `string`1684316844 - `ContentBlockSourceContent = array of ContentBlockSourceContent`1684516846 - `TextBlockParam object`1684716848 - `ImageBlockParam object`1684916850 - `URLPDFSource object`1685116852 - `type: "url"`1685316854 - `url: string`1685516856 - `FileDocumentSource object`1685716858 - `type: "file"`1685916860 - `file_id: string`1686116862 - `cache_control: optional CacheControlEphemeral or null`1686316864 Create a cache control breakpoint at this content block.1686516866 - `citations: optional CitationsConfigParam or null`1686716868 - `enabled: optional boolean`1686916870 - `context: optional string or null`1687116872 minLength: 11687316874 - `title: optional string or null`1687516876 maxLength: 500, minLength: 11687716878 - `SearchResultBlockParam object`1687916880 - `type: "search_result"`1688116882 - `content: array of TextBlockParam`1688316884 - `type: "text"`1688516886 - `text: string`1688716888 minLength: 11688916890 - `cache_control: optional CacheControlEphemeral or null`1689116892 Create a cache control breakpoint at this content block.1689316894 - `citations: optional array of TextCitationParam or null`1689516896 - `source: string`1689716898 - `title: string`1689916900 - `cache_control: optional CacheControlEphemeral or null`1690116902 Create a cache control breakpoint at this content block.1690316904 - `citations: optional CitationsConfigParam`1690516906 - `ThinkingBlockParam object`1690716908 - `type: "thinking"`1690916910 - `signature: string`1691116912 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.1691316914 Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`.1691516916 - `thinking: string`1691716918 The `thinking` text of this block as returned by the API.1691916920 - `RedactedThinkingBlockParam object`1692116922 - `type: "redacted_thinking"`1692316924 - `data: string`1692516926 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.1692716928 - `ToolUseBlockParam object`1692916930 - `type: "tool_use"`1693116932 - `id: string`1693316934 pattern: ^[a-zA-Z0-9_-]+$1693516936 - `input: map[unknown]`1693716938 - `name: string`1693916940 maxLength: 200, minLength: 11694116942 - `cache_control: optional CacheControlEphemeral or null`1694316944 Create a cache control breakpoint at this content block.1694516946 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`1694716948 - `DirectCaller object`1694916950 Tool invocation directly from the model.1695116952 - `type: "direct"`1695316954 - `ServerToolCaller object`1695516956 Tool invocation generated by a server-side tool.1695716958 - `type: "code_execution_20250825"`1695916960 - `tool_id: string`1696116962 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1696316964 - `ServerToolCaller20260120 object`1696516966 - `type: "code_execution_20260120"`1696716968 - `tool_id: string`1696916970 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1697116972 - `toolset_name: optional string or null`1697316974 For a toolset member tool_use, the toolset family this member belongs to.1697516976 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$1697716978 - `ToolResultBlockParam object`1697916980 - `type: "tool_result"`1698116982 - `tool_use_id: string`1698316984 pattern: ^[a-zA-Z0-9_-]+$1698516986 - `cache_control: optional CacheControlEphemeral or null`1698716988 Create a cache control breakpoint at this content block.1698916990 - `content: optional string or array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 3 more`1699116992 - `string`1699316994 - `array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 3 more`1699516996 - `TextBlockParam object`1699716998 - `ImageBlockParam object`1699917000 - `SearchResultBlockParam object`1700117002 - `DocumentBlockParam object`1700317004 - `ToolReferenceBlockParam object`1700517006 Tool reference block that can be included in tool_result content.1700717008 - `type: "tool_reference"`1700917010 - `tool_name: string`1701117012 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$1701317014 - `cache_control: optional CacheControlEphemeral or null`1701517016 Create a cache control breakpoint at this content block.1701717018 - `BrowserStateBlockParam object`1701917020 The caller's browser state after a browser toolset member call —17021 the full inventory of open tabs, which tab is active, and any side17022 effects (tabs opened, download state changes) the call produced.1702317024 At most one per `tool_result`, only on a non-error result answering a17025 browser toolset member `tool_use`. The server renders the17026 model-visible text from it; the model never sees the raw fields.1702717028 - `type: "browser_state"`1702917030 - `tabs: array of BrowserStateTabEntry`1703117032 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`.1703317034 maxItems: 1001703517036 - `tab_id: string`1703717038 The caller-assigned identifier for this tab, unique within the inventory.1703917040 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1704117042 - `title: string`1704317044 The title of the page the tab is showing. May be empty.1704517046 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1704717048 - `url: string`1704917050 The URL of the page the tab is showing. May be empty.1705117052 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1705317054 - `active: optional boolean`1705517056 Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.1705717058 - `cache_control: optional CacheControlEphemeral or null`1705917060 Create a cache control breakpoint at this content block.1706117062 - `state_changes: optional array of BrowserStateChange or null`1706317064 Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list.1706517066 maxItems: 200, minItems: 11706717068 - `BrowserStateChangeTabOpened object`1706917070 A tab this call's execution opened that remains open at its end —17071 the creation delta of the `tabs` inventory, not an event log.1707217073 Carries only the `tab_id`; the tab's `title` and `url` live on its17074 `tabs` entry, which must include the same `tab_id`. A tab opened17075 during a failed call gets no deferred `tab_opened`; it simply appears17076 in the next result's `tabs` inventory.1707717078 - `type: "tab_opened"`1707917080 - `tab_id: string`1708117082 The `tab_id` of the opened tab, present in `tabs`.1708317084 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1708517086 - `BrowserStateChangeDownloadStarted object`1708717088 A file download that started during this call.1708917090 - `type: "download_started"`1709117092 - `download_id: string`1709317094 The caller-assigned identifier for this download, stable across the state changes reporting it.1709517096 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1709717098 - `url: string`1709917100 The final post-redirect URL the download was served from.1710117102 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1710317104 - `BrowserStateChangeDownloadCompleted object`1710517106 A file download that finished during this call, reported with the17107 same `download_id` as its `download_started` — or without a prior17108 `download_started`, when the download finished during the call that17109 started it (at most one state change per `download_id` per result).1711017111 - `type: "download_completed"`1711217113 - `download_id: string`1711417115 The caller-assigned identifier for this download, stable across the state changes reporting it.1711617117 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1711817119 - `url: string`1712017121 The final post-redirect URL the download was served from.1712217123 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1712417125 - `path: optional string or null`1712617127 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.1712817129 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 40961713017131 - `size_bytes: optional number or null`1713217133 The completed download's size.1713417135 minimum: 01713617137 - `BrowserStateChangeDownloadFailed object`1713817139 A file download that failed — or was cancelled — during this call.1714017141 - `type: "download_failed"`1714217143 - `download_id: string`1714417145 The caller-assigned identifier for this download, stable across the state changes reporting it.1714617147 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1714817149 - `url: string`1715017151 The final post-redirect URL the download was served from.1715217153 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$1715417155 - `error: optional string or null`1715617157 The failure or cancellation detail, when known.1715817159 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 40961716017161 - `is_error: optional boolean`1716217163 - `toolset_name: optional string or null`1716417165 For a toolset member tool_result, the toolset family of the paired tool_use.1716617167 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$1716817169 - `ServerToolUseBlockParam object`1717017171 - `type: "server_tool_use"`1717217173 - `id: string`1717417175 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1717617177 - `input: map[unknown]`1717817179 - `name: "web_search" or "web_fetch" or "code_execution" or 4 more`1718017181 - `"web_search"`1718217183 - `"web_fetch"`1718417185 - `"code_execution"`1718617187 - `"bash_code_execution"`1718817189 - `"text_editor_code_execution"`1719017191 - `"tool_search_tool_regex"`1719217193 - `"tool_search_tool_bm25"`1719417195 - `cache_control: optional CacheControlEphemeral or null`1719617197 Create a cache control breakpoint at this content block.1719817199 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`1720017201 - `DirectCaller object`1720217203 Tool invocation directly from the model.1720417205 - `ServerToolCaller object`1720617207 Tool invocation generated by a server-side tool.1720817209 - `ServerToolCaller20260120 object`1721017211 - `WebSearchToolResultBlockParam object`1721217213 - `type: "web_search_tool_result"`1721417215 - `content: WebSearchToolResultBlockParamContent`1721617217 - `WebSearchToolResultBlockItem = array of WebSearchResultBlockParam`1721817219 - `type: "web_search_result"`1722017221 - `encrypted_content: string`1722217223 - `title: string`1722417225 - `url: string`1722617227 - `page_age: optional string or null`1722817229 - `WebSearchToolRequestError object`1723017231 - `type: "web_search_tool_result_error"`1723217233 - `error_code: WebSearchToolResultErrorCode`1723417235 - `"invalid_tool_input"`1723617237 - `"unavailable"`1723817239 - `"max_uses_exceeded"`1724017241 - `"too_many_requests"`1724217243 - `"query_too_long"`1724417245 - `"request_too_large"`1724617247 - `tool_use_id: string`1724817249 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1725017251 - `cache_control: optional CacheControlEphemeral or null`1725217253 Create a cache control breakpoint at this content block.1725417255 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`1725617257 - `DirectCaller object`1725817259 Tool invocation directly from the model.1726017261 - `ServerToolCaller object`1726217263 Tool invocation generated by a server-side tool.1726417265 - `ServerToolCaller20260120 object`1726617267 - `WebFetchToolResultBlockParam object`1726817269 - `type: "web_fetch_tool_result"`1727017271 - `content: WebFetchToolResultErrorBlockParam or WebFetchBlockParam`1727217273 - `WebFetchToolResultErrorBlockParam object`1727417275 - `type: "web_fetch_tool_result_error"`1727617277 - `error_code: WebFetchToolResultErrorCode`1727817279 - `"invalid_tool_input"`1728017281 - `"url_too_long"`1728217283 - `"url_not_allowed"`1728417285 - `"url_not_in_prior_context"`1728617287 - `"url_not_accessible"`1728817289 - `"unsupported_content_type"`1729017291 - `"too_many_requests"`1729217293 - `"max_uses_exceeded"`1729417295 - `"unavailable"`1729617297 - `"content_too_large"`1729817299 - `WebFetchBlockParam object`1730017301 - `type: "web_fetch_result"`1730217303 - `content: DocumentBlockParam`1730417305 - `url: string`1730617307 Fetched content URL1730817309 - `retrieved_at: optional string or null`1731017311 ISO 8601 timestamp when the content was retrieved1731217313 - `tool_use_id: string`1731417315 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1731617317 - `cache_control: optional CacheControlEphemeral or null`1731817319 Create a cache control breakpoint at this content block.1732017321 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`1732217323 - `DirectCaller object`1732417325 Tool invocation directly from the model.1732617327 - `ServerToolCaller object`1732817329 Tool invocation generated by a server-side tool.1733017331 - `ServerToolCaller20260120 object`1733217333 - `CodeExecutionToolResultBlockParam object`1733417335 - `type: "code_execution_tool_result"`1733617337 - `content: CodeExecutionToolResultBlockParamContent`1733817339 - `CodeExecutionToolResultErrorParam object`1734017341 - `type: "code_execution_tool_result_error"`1734217343 - `error_code: CodeExecutionToolResultErrorCode`1734417345 - `"invalid_tool_input"`1734617347 - `"unavailable"`1734817349 - `"too_many_requests"`1735017351 - `"execution_time_exceeded"`1735217353 - `CodeExecutionResultBlockParam object`1735417355 - `type: "code_execution_result"`1735617357 - `content: array of CodeExecutionOutputBlockParam`1735817359 - `type: "code_execution_output"`1736017361 - `file_id: string`1736217363 - `return_code: number`1736417365 - `stderr: string`1736617367 - `stdout: string`1736817369 - `EncryptedCodeExecutionResultBlockParam object`1737017371 Code execution result with encrypted stdout for PFC + web_search results.1737217373 - `type: "encrypted_code_execution_result"`1737417375 - `content: array of CodeExecutionOutputBlockParam`1737617377 - `type: "code_execution_output"`1737817379 - `file_id: string`1738017381 - `encrypted_stdout: string`1738217383 - `return_code: number`1738417385 - `stderr: string`1738617387 - `tool_use_id: string`1738817389 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1739017391 - `cache_control: optional CacheControlEphemeral or null`1739217393 Create a cache control breakpoint at this content block.1739417395 - `BashCodeExecutionToolResultBlockParam object`1739617397 - `type: "bash_code_execution_tool_result"`1739817399 - `content: BashCodeExecutionToolResultErrorParam or BashCodeExecutionResultBlockParam`1740017401 - `BashCodeExecutionToolResultErrorParam object`1740217403 - `type: "bash_code_execution_tool_result_error"`1740417405 - `error_code: BashCodeExecutionToolResultErrorCode`1740617407 - `"invalid_tool_input"`1740817409 - `"unavailable"`1741017411 - `"too_many_requests"`1741217413 - `"execution_time_exceeded"`1741417415 - `"output_file_too_large"`1741617417 - `BashCodeExecutionResultBlockParam object`1741817419 - `type: "bash_code_execution_result"`1742017421 - `content: array of BashCodeExecutionOutputBlockParam`1742217423 - `type: "bash_code_execution_output"`1742417425 - `file_id: string`1742617427 - `return_code: number`1742817429 - `stderr: string`1743017431 - `stdout: string`1743217433 - `tool_use_id: string`1743417435 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1743617437 - `cache_control: optional CacheControlEphemeral or null`1743817439 Create a cache control breakpoint at this content block.1744017441 - `TextEditorCodeExecutionToolResultBlockParam object`1744217443 - `type: "text_editor_code_execution_tool_result"`1744417445 - `content: TextEditorCodeExecutionToolResultErrorParam or TextEditorCodeExecutionViewResultBlockParam or TextEditorCodeExecutionCreateResultBlockParam or TextEditorCodeExecutionStrReplaceResultBlockParam`1744617447 - `TextEditorCodeExecutionToolResultErrorParam object`1744817449 - `type: "text_editor_code_execution_tool_result_error"`1745017451 - `error_code: TextEditorCodeExecutionToolResultErrorCode`1745217453 - `"invalid_tool_input"`1745417455 - `"unavailable"`1745617457 - `"too_many_requests"`1745817459 - `"execution_time_exceeded"`1746017461 - `"file_not_found"`1746217463 - `error_message: optional string or null`1746417465 - `TextEditorCodeExecutionViewResultBlockParam object`1746617467 - `type: "text_editor_code_execution_view_result"`1746817469 - `content: string`1747017471 - `file_type: "text" or "image" or "pdf"`1747217473 - `"text"`1747417475 - `"image"`1747617477 - `"pdf"`1747817479 - `num_lines: optional number or null`1748017481 - `start_line: optional number or null`1748217483 - `total_lines: optional number or null`1748417485 - `TextEditorCodeExecutionCreateResultBlockParam object`1748617487 - `type: "text_editor_code_execution_create_result"`1748817489 - `is_file_update: boolean`1749017491 - `TextEditorCodeExecutionStrReplaceResultBlockParam object`1749217493 - `type: "text_editor_code_execution_str_replace_result"`1749417495 - `lines: optional array of string or null`1749617497 - `new_lines: optional number or null`1749817499 - `new_start: optional number or null`1750017501 - `old_lines: optional number or null`1750217503 - `old_start: optional number or null`1750417505 - `tool_use_id: string`1750617507 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1750817509 - `cache_control: optional CacheControlEphemeral or null`1751017511 Create a cache control breakpoint at this content block.1751217513 - `ToolSearchToolResultBlockParam object`1751417515 - `type: "tool_search_tool_result"`1751617517 - `content: ToolSearchToolResultErrorParam or ToolSearchToolSearchResultBlockParam`1751817519 - `ToolSearchToolResultErrorParam object`1752017521 - `type: "tool_search_tool_result_error"`1752217523 - `error_code: ToolSearchToolResultErrorCode`1752417525 - `"invalid_tool_input"`1752617527 - `"unavailable"`1752817529 - `"too_many_requests"`1753017531 - `"execution_time_exceeded"`1753217533 - `error_message: optional string or null`1753417535 - `ToolSearchToolSearchResultBlockParam object`1753617537 - `type: "tool_search_tool_search_result"`1753817539 - `tool_references: array of ToolReferenceBlockParam`1754017541 - `type: "tool_reference"`1754217543 - `tool_name: string`1754417545 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$1754617547 - `cache_control: optional CacheControlEphemeral or null`1754817549 Create a cache control breakpoint at this content block.1755017551 - `tool_use_id: string`1755217553 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1755417555 - `cache_control: optional CacheControlEphemeral or null`1755617557 Create a cache control breakpoint at this content block.1755817559 - `ContainerUploadBlockParam object`1756017561 A content block that represents a file to be uploaded to the container17562 Files uploaded via this block will be available in the container's input directory.1756317564 - `type: "container_upload"`1756517566 - `file_id: string`1756717568 - `cache_control: optional CacheControlEphemeral or null`1756917570 Create a cache control breakpoint at this content block.1757117572 - `role: "user" or "assistant" or "system"`1757317574 - `"user"`1757517576 - `"assistant"`1757717578 - `"system"`1757917580### Message Tokens Count1758117582- `MessageTokensCount object`1758317584 - `input_tokens: number`1758517586 The total number of tokens across the provided list of messages, system prompt, and tools.1758717588### Metadata1758917590- `Metadata object`1759117592 - `user_id: optional string or null`1759317594 An external identifier for the user who is associated with the request.1759517596 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.1759717598 maxLength: 5121759917600### Model1760117602- `Model = "claude-fable-5-1" or "claude-mythos-5-1" or "claude-sonnet-5" or 14 more or string`1760317604 The model that will complete your prompt.1760517606 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.1760717608 - `"claude-fable-5-1" or "claude-mythos-5-1" or "claude-sonnet-5" or 14 more`1760917610 The model that will complete your prompt.1761117612 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.1761317614 - `"claude-fable-5-1"`1761517616 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows1761717618 - `"claude-mythos-5-1"`1761917620 Our most capable model for cybersecurity and biology research, available through trusted access programs1762117622 - `"claude-sonnet-5"`1762317624 High-performance model for coding and agents1762517626 - `"claude-fable-5"`1762717628 Next generation of intelligence for the hardest knowledge work and coding problems1762917630 - `"claude-mythos-5"`1763117632 Most capable model for cybersecurity and biology research1763317634 - `"claude-opus-5"`1763517636 Powerful intelligence for long-running agents and coding1763717638 - `"claude-opus-4-8"`1763917640 Powerful intelligence for long-running agents and coding1764117642 - `"claude-opus-4-7"`1764317644 Powerful intelligence for long-running agents and coding1764517646 - `"claude-mythos-preview"`1764717648 New class of intelligence, strongest in coding and cybersecurity1764917650 - `"claude-opus-4-6"`1765117652 Powerful intelligence for long-running agents and coding1765317654 - `"claude-sonnet-4-6"`1765517656 Best combination of speed and intelligence1765717658 - `"claude-haiku-4-5"`1765917660 Fastest model with near-frontier intelligence1766117662 - `"claude-haiku-4-5-20251001"`1766317664 Fastest model with near-frontier intelligence1766517666 - `"claude-opus-4-5"`1766717668 Powerful intelligence for long-running agents and coding1766917670 - `"claude-opus-4-5-20251101"`1767117672 Powerful intelligence for long-running agents and coding1767317674 - `"claude-sonnet-4-5"`1767517676 High-performance model for agents and coding1767717678 - `"claude-sonnet-4-5-20250929"`1767917680 High-performance model for agents and coding1768117682 - `string`1768317684### Output Config1768517686- `OutputConfig object`1768717688 - `effort: optional "low" or "medium" or "high" or 2 more or null`1768917690 All possible effort levels.1769117692 - `"low"`1769317694 - `"medium"`1769517696 - `"high"`1769717698 - `"xhigh"`1769917700 - `"max"`1770117702 - `format: optional JSONOutputFormat or null`1770317704 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)1770517706 - `type: "json_schema"`1770717708 - `schema: map[unknown]`1770917710 The JSON schema of the format1771117712### Output Tokens Details1771317714- `OutputTokensDetails object`1771517716 - `thinking_tokens: number`1771717718 Number of output tokens the model generated as internal reasoning, including17719 the thinking-block delimiter tokens.1772017721 Reflects the raw reasoning the model produced, not the (possibly shorter)17722 summarized thinking text returned in the response body. Computed by17723 re-tokenizing the raw reasoning text, so it may differ from the model's exact17724 generation count by a small number of tokens. Always ≤ `output_tokens`;17725 `output_tokens - thinking_tokens` approximates the non-reasoning output.1772617727 default: 0, minimum: 01772817729### Plain Text Source1773017731- `PlainTextSource object`1773217733 - `type: "text"`1773417735 - `data: string`1773617737 - `media_type: "text/plain"`1773817739### Raw Content Block Delta1774017741- `RawContentBlockDelta = TextDelta or InputJSONDelta or CitationsDelta or 2 more`1774217743 - `TextDelta object`1774417745 - `type: "text_delta"`1774617747 default: text_delta1774817749 - `text: string`1775017751 - `InputJSONDelta object`1775217753 - `type: "input_json_delta"`1775417755 default: input_json_delta1775617757 - `partial_json: string`1775817759 - `CitationsDelta object`1776017761 - `type: "citations_delta"`1776217763 default: citations_delta1776417765 - `citation: CitationCharLocation or CitationPageLocation or CitationContentBlockLocation or 2 more`1776617767 - `CitationCharLocation object`1776817769 - `type: "char_location"`1777017771 default: char_location1777217773 - `cited_text: string`1777417775 - `document_index: number`1777617777 minimum: 01777817779 - `document_title: string or null`1778017781 - `end_char_index: number`1778217783 - `file_id: string or null`1778417785 - `start_char_index: number`1778617787 minimum: 01778817789 - `CitationPageLocation object`1779017791 - `type: "page_location"`1779217793 default: page_location1779417795 - `cited_text: string`1779617797 - `document_index: number`1779817799 minimum: 01780017801 - `document_title: string or null`1780217803 - `end_page_number: number`1780417805 - `file_id: string or null`1780617807 - `start_page_number: number`1780817809 minimum: 11781017811 - `CitationContentBlockLocation object`1781217813 - `type: "content_block_location"`1781417815 default: content_block_location1781617817 - `cited_text: string`1781817819 The full text of the cited block range, concatenated.1782017821 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.1782217823 - `document_index: number`1782417825 minimum: 01782617827 - `document_title: string or null`1782817829 - `end_block_index: number`1783017831 Exclusive 0-based end index of the cited block range in the source's `content` array.1783217833 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1783417835 - `file_id: string or null`1783617837 - `start_block_index: number`1783817839 0-based index of the first cited block in the source's `content` array.1784017841 minimum: 01784217843 - `CitationsWebSearchResultLocation object`1784417845 - `type: "web_search_result_location"`1784617847 default: web_search_result_location1784817849 - `cited_text: string`1785017851 - `encrypted_index: string`1785217853 - `title: string or null`1785417855 maxLength: 5121785617857 - `url: string`1785817859 - `CitationsSearchResultLocation object`1786017861 - `type: "search_result_location"`1786217863 default: search_result_location1786417865 - `cited_text: string`1786617867 The full text of the cited block range, concatenated.1786817869 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.1787017871 - `end_block_index: number`1787217873 Exclusive 0-based end index of the cited block range in the source's `content` array.1787417875 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1787617877 - `search_result_index: number`1787817879 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.1788017881 Counted separately from `document_index`; server-side web search results are not included in this count.1788217883 minimum: 01788417885 - `source: string`1788617887 - `start_block_index: number`1788817889 0-based index of the first cited block in the source's `content` array.1789017891 minimum: 01789217893 - `title: string or null`1789417895 - `ThinkingDelta object`1789617897 - `type: "thinking_delta"`1789817899 default: thinking_delta1790017901 - `thinking: string`1790217903 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.1790417905 - `SignatureDelta object`1790617907 - `type: "signature_delta"`1790817909 default: signature_delta1791017911 - `signature: string`1791217913 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.1791417915### Raw Content Block Delta Event1791617917- `RawContentBlockDeltaEvent object`1791817919 - `type: "content_block_delta"`1792017921 default: content_block_delta1792217923 - `delta: RawContentBlockDelta`1792417925 - `TextDelta object`1792617927 - `type: "text_delta"`1792817929 default: text_delta1793017931 - `text: string`1793217933 - `InputJSONDelta object`1793417935 - `type: "input_json_delta"`1793617937 default: input_json_delta1793817939 - `partial_json: string`1794017941 - `CitationsDelta object`1794217943 - `type: "citations_delta"`1794417945 default: citations_delta1794617947 - `citation: CitationCharLocation or CitationPageLocation or CitationContentBlockLocation or 2 more`1794817949 - `CitationCharLocation object`1795017951 - `type: "char_location"`1795217953 default: char_location1795417955 - `cited_text: string`1795617957 - `document_index: number`1795817959 minimum: 01796017961 - `document_title: string or null`1796217963 - `end_char_index: number`1796417965 - `file_id: string or null`1796617967 - `start_char_index: number`1796817969 minimum: 01797017971 - `CitationPageLocation object`1797217973 - `type: "page_location"`1797417975 default: page_location1797617977 - `cited_text: string`1797817979 - `document_index: number`1798017981 minimum: 01798217983 - `document_title: string or null`1798417985 - `end_page_number: number`1798617987 - `file_id: string or null`1798817989 - `start_page_number: number`1799017991 minimum: 11799217993 - `CitationContentBlockLocation object`1799417995 - `type: "content_block_location"`1799617997 default: content_block_location1799817999 - `cited_text: string`1800018001 The full text of the cited block range, concatenated.1800218003 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.1800418005 - `document_index: number`1800618007 minimum: 01800818009 - `document_title: string or null`1801018011 - `end_block_index: number`1801218013 Exclusive 0-based end index of the cited block range in the source's `content` array.1801418015 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1801618017 - `file_id: string or null`1801818019 - `start_block_index: number`1802018021 0-based index of the first cited block in the source's `content` array.1802218023 minimum: 01802418025 - `CitationsWebSearchResultLocation object`1802618027 - `type: "web_search_result_location"`1802818029 default: web_search_result_location1803018031 - `cited_text: string`1803218033 - `encrypted_index: string`1803418035 - `title: string or null`1803618037 maxLength: 5121803818039 - `url: string`1804018041 - `CitationsSearchResultLocation object`1804218043 - `type: "search_result_location"`1804418045 default: search_result_location1804618047 - `cited_text: string`1804818049 The full text of the cited block range, concatenated.1805018051 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.1805218053 - `end_block_index: number`1805418055 Exclusive 0-based end index of the cited block range in the source's `content` array.1805618057 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1805818059 - `search_result_index: number`1806018061 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.1806218063 Counted separately from `document_index`; server-side web search results are not included in this count.1806418065 minimum: 01806618067 - `source: string`1806818069 - `start_block_index: number`1807018071 0-based index of the first cited block in the source's `content` array.1807218073 minimum: 01807418075 - `title: string or null`1807618077 - `ThinkingDelta object`1807818079 - `type: "thinking_delta"`1808018081 default: thinking_delta1808218083 - `thinking: string`1808418085 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.1808618087 - `SignatureDelta object`1808818089 - `type: "signature_delta"`1809018091 default: signature_delta1809218093 - `signature: string`1809418095 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.1809618097 - `index: number`1809818099### Raw Content Block Start Event1810018101- `RawContentBlockStartEvent object`1810218103 - `type: "content_block_start"`1810418105 default: content_block_start1810618107 - `content_block: TextBlock or ThinkingBlock or RedactedThinkingBlock or 9 more`1810818109 - `TextBlock object`1811018111 - `type: "text"`1811218113 default: text1811418115 - `citations: array of TextCitation or null`1811618117 Citations supporting the text block.1811818119 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`.1812018121 - `CitationCharLocation object`1812218123 - `type: "char_location"`1812418125 default: char_location1812618127 - `cited_text: string`1812818129 - `document_index: number`1813018131 minimum: 01813218133 - `document_title: string or null`1813418135 - `end_char_index: number`1813618137 - `file_id: string or null`1813818139 - `start_char_index: number`1814018141 minimum: 01814218143 - `CitationPageLocation object`1814418145 - `type: "page_location"`1814618147 default: page_location1814818149 - `cited_text: string`1815018151 - `document_index: number`1815218153 minimum: 01815418155 - `document_title: string or null`1815618157 - `end_page_number: number`1815818159 - `file_id: string or null`1816018161 - `start_page_number: number`1816218163 minimum: 11816418165 - `CitationContentBlockLocation object`1816618167 - `type: "content_block_location"`1816818169 default: content_block_location1817018171 - `cited_text: string`1817218173 The full text of the cited block range, concatenated.1817418175 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.1817618177 - `document_index: number`1817818179 minimum: 01818018181 - `document_title: string or null`1818218183 - `end_block_index: number`1818418185 Exclusive 0-based end index of the cited block range in the source's `content` array.1818618187 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1818818189 - `file_id: string or null`1819018191 - `start_block_index: number`1819218193 0-based index of the first cited block in the source's `content` array.1819418195 minimum: 01819618197 - `CitationsWebSearchResultLocation object`1819818199 - `type: "web_search_result_location"`1820018201 default: web_search_result_location1820218203 - `cited_text: string`1820418205 - `encrypted_index: string`1820618207 - `title: string or null`1820818209 maxLength: 5121821018211 - `url: string`1821218213 - `CitationsSearchResultLocation object`1821418215 - `type: "search_result_location"`1821618217 default: search_result_location1821818219 - `cited_text: string`1822018221 The full text of the cited block range, concatenated.1822218223 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.1822418225 - `end_block_index: number`1822618227 Exclusive 0-based end index of the cited block range in the source's `content` array.1822818229 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1823018231 - `search_result_index: number`1823218233 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.1823418235 Counted separately from `document_index`; server-side web search results are not included in this count.1823618237 minimum: 01823818239 - `source: string`1824018241 - `start_block_index: number`1824218243 0-based index of the first cited block in the source's `content` array.1824418245 minimum: 01824618247 - `title: string or null`1824818249 - `text: string`1825018251 minLength: 01825218253 - `ThinkingBlock object`1825418255 - `type: "thinking"`1825618257 default: thinking1825818259 - `signature: string`1826018261 A value used to verify that this thinking block was generated by Claude when it is passed back to the API.1826218263 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.1826418265 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.1826618267 - `thinking: string`1826818269 The text of Claude's thinking process for this block.1827018271 - `RedactedThinkingBlock object`1827218273 - `type: "redacted_thinking"`1827418275 default: redacted_thinking1827618277 - `data: string`1827818279 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.1828018281 Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.1828218283 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.1828418285 - `ToolUseBlock object`1828618287 - `type: "tool_use"`1828818289 default: tool_use1829018291 - `id: string`1829218293 pattern: ^[a-zA-Z0-9_-]+$1829418295 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`1829618297 default: {"type":"direct"}1829818299 - `DirectCaller object`1830018301 Tool invocation directly from the model.1830218303 - `type: "direct"`1830418305 - `ServerToolCaller object`1830618307 Tool invocation generated by a server-side tool.1830818309 - `type: "code_execution_20250825"`1831018311 - `tool_id: string`1831218313 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1831418315 - `ServerToolCaller20260120 object`1831618317 - `type: "code_execution_20260120"`1831818319 - `tool_id: string`1832018321 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1832218323 - `input: map[unknown]`1832418325 - `name: string`1832618327 minLength: 11832818329 - `toolset_name: optional string or null`1833018331 For a toolset member tool_use, the toolset family.1833218333 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$1833418335 - `ServerToolUseBlock object`1833618337 - `type: "server_tool_use"`1833818339 default: server_tool_use1834018341 - `id: string`1834218343 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1834418345 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`1834618347 default: {"type":"direct"}1834818349 - `DirectCaller object`1835018351 Tool invocation directly from the model.1835218353 - `ServerToolCaller object`1835418355 Tool invocation generated by a server-side tool.1835618357 - `ServerToolCaller20260120 object`1835818359 - `input: map[unknown]`1836018361 - `name: "web_search" or "web_fetch" or "code_execution" or 4 more`1836218363 - `"web_search"`1836418365 - `"web_fetch"`1836618367 - `"code_execution"`1836818369 - `"bash_code_execution"`1837018371 - `"text_editor_code_execution"`1837218373 - `"tool_search_tool_regex"`1837418375 - `"tool_search_tool_bm25"`1837618377 - `WebSearchToolResultBlock object`1837818379 - `type: "web_search_tool_result"`1838018381 default: web_search_tool_result1838218383 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`1838418385 default: {"type":"direct"}1838618387 - `DirectCaller object`1838818389 Tool invocation directly from the model.1839018391 - `ServerToolCaller object`1839218393 Tool invocation generated by a server-side tool.1839418395 - `ServerToolCaller20260120 object`1839618397 - `content: WebSearchToolResultBlockContent`1839818399 - `WebSearchToolResultError object`1840018401 - `type: "web_search_tool_result_error"`1840218403 default: web_search_tool_result_error1840418405 - `error_code: WebSearchToolResultErrorCode`1840618407 - `"invalid_tool_input"`1840818409 - `"unavailable"`1841018411 - `"max_uses_exceeded"`1841218413 - `"too_many_requests"`1841418415 - `"query_too_long"`1841618417 - `"request_too_large"`1841818419 - `array of WebSearchResultBlock`1842018421 - `type: "web_search_result"`1842218423 default: web_search_result1842418425 - `encrypted_content: string`1842618427 - `page_age: string or null`1842818429 - `title: string`1843018431 - `url: string`1843218433 - `tool_use_id: string`1843418435 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1843618437 - `WebFetchToolResultBlock object`1843818439 - `type: "web_fetch_tool_result"`1844018441 default: web_fetch_tool_result1844218443 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`1844418445 default: {"type":"direct"}1844618447 - `DirectCaller object`1844818449 Tool invocation directly from the model.1845018451 - `ServerToolCaller object`1845218453 Tool invocation generated by a server-side tool.1845418455 - `ServerToolCaller20260120 object`1845618457 - `content: WebFetchToolResultErrorBlock or WebFetchBlock`1845818459 - `WebFetchToolResultErrorBlock object`1846018461 - `type: "web_fetch_tool_result_error"`1846218463 default: web_fetch_tool_result_error1846418465 - `error_code: WebFetchToolResultErrorCode`1846618467 - `"invalid_tool_input"`1846818469 - `"url_too_long"`1847018471 - `"url_not_allowed"`1847218473 - `"url_not_in_prior_context"`1847418475 - `"url_not_accessible"`1847618477 - `"unsupported_content_type"`1847818479 - `"too_many_requests"`1848018481 - `"max_uses_exceeded"`1848218483 - `"unavailable"`1848418485 - `"content_too_large"`1848618487 - `WebFetchBlock object`1848818489 - `type: "web_fetch_result"`1849018491 default: web_fetch_result1849218493 - `content: DocumentBlock`1849418495 - `type: "document"`1849618497 default: document1849818499 - `citations: CitationsConfig or null`1850018501 Citation configuration for the document1850218503 - `enabled: boolean`1850418505 default: false1850618507 - `source: Base64PDFSource or PlainTextSource`1850818509 - `Base64PDFSource object`1851018511 - `type: "base64"`1851218513 - `data: string`1851418515 format: byte1851618517 - `media_type: "application/pdf"`1851818519 - `PlainTextSource object`1852018521 - `type: "text"`1852218523 - `data: string`1852418525 - `media_type: "text/plain"`1852618527 - `title: string or null`1852818529 The title of the document1853018531 - `retrieved_at: string or null`1853218533 ISO 8601 timestamp when the content was retrieved1853418535 - `url: string`1853618537 Fetched content URL1853818539 - `tool_use_id: string`1854018541 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1854218543 - `CodeExecutionToolResultBlock object`1854418545 - `type: "code_execution_tool_result"`1854618547 default: code_execution_tool_result1854818549 - `content: CodeExecutionToolResultBlockContent`1855018551 - `CodeExecutionToolResultError object`1855218553 - `type: "code_execution_tool_result_error"`1855418555 default: code_execution_tool_result_error1855618557 - `error_code: CodeExecutionToolResultErrorCode`1855818559 - `"invalid_tool_input"`1856018561 - `"unavailable"`1856218563 - `"too_many_requests"`1856418565 - `"execution_time_exceeded"`1856618567 - `CodeExecutionResultBlock object`1856818569 - `type: "code_execution_result"`1857018571 default: code_execution_result1857218573 - `content: array of CodeExecutionOutputBlock`1857418575 - `type: "code_execution_output"`1857618577 default: code_execution_output1857818579 - `file_id: string`1858018581 - `return_code: number`1858218583 - `stderr: string`1858418585 - `stdout: string`1858618587 - `EncryptedCodeExecutionResultBlock object`1858818589 Code execution result with encrypted stdout for PFC + web_search results.1859018591 - `type: "encrypted_code_execution_result"`1859218593 default: encrypted_code_execution_result1859418595 - `content: array of CodeExecutionOutputBlock`1859618597 - `type: "code_execution_output"`1859818599 default: code_execution_output1860018601 - `file_id: string`1860218603 - `encrypted_stdout: string`1860418605 - `return_code: number`1860618607 - `stderr: string`1860818609 - `tool_use_id: string`1861018611 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1861218613 - `BashCodeExecutionToolResultBlock object`1861418615 - `type: "bash_code_execution_tool_result"`1861618617 default: bash_code_execution_tool_result1861818619 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`1862018621 - `BashCodeExecutionToolResultError object`1862218623 - `type: "bash_code_execution_tool_result_error"`1862418625 default: bash_code_execution_tool_result_error1862618627 - `error_code: BashCodeExecutionToolResultErrorCode`1862818629 - `"invalid_tool_input"`1863018631 - `"unavailable"`1863218633 - `"too_many_requests"`1863418635 - `"execution_time_exceeded"`1863618637 - `"output_file_too_large"`1863818639 - `BashCodeExecutionResultBlock object`1864018641 - `type: "bash_code_execution_result"`1864218643 default: bash_code_execution_result1864418645 - `content: array of BashCodeExecutionOutputBlock`1864618647 - `type: "bash_code_execution_output"`1864818649 default: bash_code_execution_output1865018651 - `file_id: string`1865218653 - `return_code: number`1865418655 - `stderr: string`1865618657 - `stdout: string`1865818659 - `tool_use_id: string`1866018661 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1866218663 - `TextEditorCodeExecutionToolResultBlock object`1866418665 - `type: "text_editor_code_execution_tool_result"`1866618667 default: text_editor_code_execution_tool_result1866818669 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`1867018671 - `TextEditorCodeExecutionToolResultError object`1867218673 - `type: "text_editor_code_execution_tool_result_error"`1867418675 default: text_editor_code_execution_tool_result_error1867618677 - `error_code: TextEditorCodeExecutionToolResultErrorCode`1867818679 - `"invalid_tool_input"`1868018681 - `"unavailable"`1868218683 - `"too_many_requests"`1868418685 - `"execution_time_exceeded"`1868618687 - `"file_not_found"`1868818689 - `error_message: string or null`1869018691 - `TextEditorCodeExecutionViewResultBlock object`1869218693 - `type: "text_editor_code_execution_view_result"`1869418695 default: text_editor_code_execution_view_result1869618697 - `content: string`1869818699 - `file_type: "text" or "image" or "pdf"`1870018701 - `"text"`1870218703 - `"image"`1870418705 - `"pdf"`1870618707 - `num_lines: number or null`1870818709 - `start_line: number or null`1871018711 - `total_lines: number or null`1871218713 - `TextEditorCodeExecutionCreateResultBlock object`1871418715 - `type: "text_editor_code_execution_create_result"`1871618717 default: text_editor_code_execution_create_result1871818719 - `is_file_update: boolean`1872018721 - `TextEditorCodeExecutionStrReplaceResultBlock object`1872218723 - `type: "text_editor_code_execution_str_replace_result"`1872418725 default: text_editor_code_execution_str_replace_result1872618727 - `lines: array of string or null`1872818729 - `new_lines: number or null`1873018731 - `new_start: number or null`1873218733 - `old_lines: number or null`1873418735 - `old_start: number or null`1873618737 - `tool_use_id: string`1873818739 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1874018741 - `ToolSearchToolResultBlock object`1874218743 - `type: "tool_search_tool_result"`1874418745 default: tool_search_tool_result1874618747 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`1874818749 - `ToolSearchToolResultError object`1875018751 - `type: "tool_search_tool_result_error"`1875218753 default: tool_search_tool_result_error1875418755 - `error_code: ToolSearchToolResultErrorCode`1875618757 - `"invalid_tool_input"`1875818759 - `"unavailable"`1876018761 - `"too_many_requests"`1876218763 - `"execution_time_exceeded"`1876418765 - `error_message: string or null`1876618767 - `ToolSearchToolSearchResultBlock object`1876818769 - `type: "tool_search_tool_search_result"`1877018771 default: tool_search_tool_search_result1877218773 - `tool_references: array of ToolReferenceBlock`1877418775 - `type: "tool_reference"`1877618777 default: tool_reference1877818779 - `tool_name: string`1878018781 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$1878218783 - `tool_use_id: string`1878418785 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1878618787 - `ContainerUploadBlock object`1878818789 Response model for a file uploaded to the container.1879018791 - `type: "container_upload"`1879218793 default: container_upload1879418795 - `file_id: string`1879618797 - `index: number`1879818799### Raw Content Block Stop Event1880018801- `RawContentBlockStopEvent object`1880218803 - `type: "content_block_stop"`1880418805 default: content_block_stop1880618807 - `index: number`1880818809### Raw Message Delta Event1881018811- `RawMessageDeltaEvent object`1881218813 - `type: "message_delta"`1881418815 default: message_delta1881618817 - `delta: object`1881818819 - `container: Container or null`1882018821 Information about the container used in the request (for the code execution tool)1882218823 - `id: string`1882418825 Identifier for the container used in this request1882618827 - `expires_at: string`1882818829 The time at which the container will expire.1883018831 format: date-time1883218833 - `skills: array of ContainerSkill or null`1883418835 Skills loaded in the container1883618837 - `type: "anthropic" or "custom"`1883818839 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)1884018841 - `"anthropic"`1884218843 - `"custom"`1884418845 - `skill_id: string`1884618847 Skill ID1884818849 maxLength: 64, minLength: 11885018851 - `version: string`1885218853 The resolved version: a skill version ID for custom skills.1885418855 maxLength: 64, minLength: 11885618857 - `stop_details: RefusalStopDetails or null`1885818859 Structured information about a refusal.1886018861 - `type: "refusal"`1886218863 default: refusal1886418865 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`1886618867 The policy category that triggered a refusal.1886818869 - `"cyber"`1887018871 The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category.1887218873 - `"bio"`1887418875 The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category.1887618877 - `"frontier_llm"`1887818879 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.1888018881 - `"reasoning_extraction"`1888218883 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).1888418885 - `"general_harms"`1888618887 The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category.1888818889 - `explanation: string or null`1889018891 Human-readable explanation of the refusal.1889218893 This text is not guaranteed to be stable. `null` when no explanation is available for the category.1889418895 - `stop_reason: StopReason or null`1889618897 - `"end_turn"`1889818899 - `"max_tokens"`1890018901 - `"stop_sequence"`1890218903 - `"tool_use"`1890418905 - `"pause_turn"`1890618907 - `"refusal"`1890818909 - `"model_context_window_exceeded"`1891018911 - `stop_sequence: string or null`1891218913 - `usage: MessageDeltaUsage`1891418915 Billing and rate-limit usage.1891618917 Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.1891818919 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.1892018921 For example, `output_tokens` will be non-zero, even for an empty string response from Claude.1892218923 Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`.1892418925 - `cache_creation_input_tokens: number or null`1892618927 The cumulative number of input tokens used to create the cache entry.1892818929 minimum: 01893018931 - `cache_read_input_tokens: number or null`1893218933 The cumulative number of input tokens read from the cache.1893418935 minimum: 01893618937 - `input_tokens: number or null`1893818939 The cumulative number of input tokens which were used.1894018941 minimum: 01894218943 - `output_tokens: number`1894418945 The cumulative number of output tokens which were used.1894618947 - `output_tokens_details: OutputTokensDetails or null`1894818949 Breakdown of output tokens by category.1895018951 `output_tokens` remains the inclusive, authoritative total used for billing.18952 This object provides a read-only decomposition for observability — for example,18953 how many of the billed output tokens were spent on internal reasoning that may18954 have been summarized before being returned to you.1895518956 - `thinking_tokens: number`1895718958 Number of output tokens the model generated as internal reasoning, including18959 the thinking-block delimiter tokens.1896018961 Reflects the raw reasoning the model produced, not the (possibly shorter)18962 summarized thinking text returned in the response body. Computed by18963 re-tokenizing the raw reasoning text, so it may differ from the model's exact18964 generation count by a small number of tokens. Always ≤ `output_tokens`;18965 `output_tokens - thinking_tokens` approximates the non-reasoning output.1896618967 default: 0, minimum: 01896818969 - `server_tool_use: ServerToolUsage or null`1897018971 The number of server tool requests.1897218973 - `web_fetch_requests: number`1897418975 The number of web fetch tool requests.1897618977 default: 0, minimum: 01897818979 - `web_search_requests: number`1898018981 The number of web search tool requests.1898218983 default: 0, minimum: 01898418985### Raw Message Start Event1898618987- `RawMessageStartEvent object`1898818989 - `type: "message_start"`1899018991 default: message_start1899218993 - `message: Message`1899418995 - `type: "message"`1899618997 Object type.1899818999 For Messages, this is always `"message"`.1900019001 default: message1900219003 - `id: string`1900419005 Unique object identifier.1900619007 The format and length of IDs may change over time.1900819009 - `container: Container or null`1901019011 Information about the container used in the request (for the code execution tool)1901219013 - `id: string`1901419015 Identifier for the container used in this request1901619017 - `expires_at: string`1901819019 The time at which the container will expire.1902019021 format: date-time1902219023 - `skills: array of ContainerSkill or null`1902419025 Skills loaded in the container1902619027 - `type: "anthropic" or "custom"`1902819029 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)1903019031 - `"anthropic"`1903219033 - `"custom"`1903419035 - `skill_id: string`1903619037 Skill ID1903819039 maxLength: 64, minLength: 11904019041 - `version: string`1904219043 The resolved version: a skill version ID for custom skills.1904419045 maxLength: 64, minLength: 11904619047 - `content: array of ContentBlock`1904819049 Content generated by the model.1905019051 This is an array of content blocks, each of which has a `type` that determines its shape.1905219053 Example:1905419055 ```json19056 [{"type": "text", "text": "Hi, I'm Claude."}]19057 ```1905819059 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.1906019061 For example, if the input `messages` were:1906219063 ```json19064 [19065 {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},19066 {"role": "assistant", "content": "The best answer is ("}19067 ]19068 ```1906919070 Then the response `content` might be:1907119072 ```json19073 [{"type": "text", "text": "B)"}]19074 ```1907519076 - `TextBlock object`1907719078 - `type: "text"`1907919080 default: text1908119082 - `citations: array of TextCitation or null`1908319084 Citations supporting the text block.1908519086 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`.1908719088 - `CitationCharLocation object`1908919090 - `type: "char_location"`1909119092 default: char_location1909319094 - `cited_text: string`1909519096 - `document_index: number`1909719098 minimum: 01909919100 - `document_title: string or null`1910119102 - `end_char_index: number`1910319104 - `file_id: string or null`1910519106 - `start_char_index: number`1910719108 minimum: 01910919110 - `CitationPageLocation object`1911119112 - `type: "page_location"`1911319114 default: page_location1911519116 - `cited_text: string`1911719118 - `document_index: number`1911919120 minimum: 01912119122 - `document_title: string or null`1912319124 - `end_page_number: number`1912519126 - `file_id: string or null`1912719128 - `start_page_number: number`1912919130 minimum: 11913119132 - `CitationContentBlockLocation object`1913319134 - `type: "content_block_location"`1913519136 default: content_block_location1913719138 - `cited_text: string`1913919140 The full text of the cited block range, concatenated.1914119142 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.1914319144 - `document_index: number`1914519146 minimum: 01914719148 - `document_title: string or null`1914919150 - `end_block_index: number`1915119152 Exclusive 0-based end index of the cited block range in the source's `content` array.1915319154 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1915519156 - `file_id: string or null`1915719158 - `start_block_index: number`1915919160 0-based index of the first cited block in the source's `content` array.1916119162 minimum: 01916319164 - `CitationsWebSearchResultLocation object`1916519166 - `type: "web_search_result_location"`1916719168 default: web_search_result_location1916919170 - `cited_text: string`1917119172 - `encrypted_index: string`1917319174 - `title: string or null`1917519176 maxLength: 5121917719178 - `url: string`1917919180 - `CitationsSearchResultLocation object`1918119182 - `type: "search_result_location"`1918319184 default: search_result_location1918519186 - `cited_text: string`1918719188 The full text of the cited block range, concatenated.1918919190 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.1919119192 - `end_block_index: number`1919319194 Exclusive 0-based end index of the cited block range in the source's `content` array.1919519196 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.1919719198 - `search_result_index: number`1919919200 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.1920119202 Counted separately from `document_index`; server-side web search results are not included in this count.1920319204 minimum: 01920519206 - `source: string`1920719208 - `start_block_index: number`1920919210 0-based index of the first cited block in the source's `content` array.1921119212 minimum: 01921319214 - `title: string or null`1921519216 - `text: string`1921719218 minLength: 01921919220 - `ThinkingBlock object`1922119222 - `type: "thinking"`1922319224 default: thinking1922519226 - `signature: string`1922719228 A value used to verify that this thinking block was generated by Claude when it is passed back to the API.1922919230 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.1923119232 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.1923319234 - `thinking: string`1923519236 The text of Claude's thinking process for this block.1923719238 - `RedactedThinkingBlock object`1923919240 - `type: "redacted_thinking"`1924119242 default: redacted_thinking1924319244 - `data: string`1924519246 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.1924719248 Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.1924919250 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.1925119252 - `ToolUseBlock object`1925319254 - `type: "tool_use"`1925519256 default: tool_use1925719258 - `id: string`1925919260 pattern: ^[a-zA-Z0-9_-]+$1926119262 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`1926319264 default: {"type":"direct"}1926519266 - `DirectCaller object`1926719268 Tool invocation directly from the model.1926919270 - `type: "direct"`1927119272 - `ServerToolCaller object`1927319274 Tool invocation generated by a server-side tool.1927519276 - `type: "code_execution_20250825"`1927719278 - `tool_id: string`1927919280 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1928119282 - `ServerToolCaller20260120 object`1928319284 - `type: "code_execution_20260120"`1928519286 - `tool_id: string`1928719288 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1928919290 - `input: map[unknown]`1929119292 - `name: string`1929319294 minLength: 11929519296 - `toolset_name: optional string or null`1929719298 For a toolset member tool_use, the toolset family.1929919300 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$1930119302 - `ServerToolUseBlock object`1930319304 - `type: "server_tool_use"`1930519306 default: server_tool_use1930719308 - `id: string`1930919310 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1931119312 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`1931319314 default: {"type":"direct"}1931519316 - `DirectCaller object`1931719318 Tool invocation directly from the model.1931919320 - `ServerToolCaller object`1932119322 Tool invocation generated by a server-side tool.1932319324 - `ServerToolCaller20260120 object`1932519326 - `input: map[unknown]`1932719328 - `name: "web_search" or "web_fetch" or "code_execution" or 4 more`1932919330 - `"web_search"`1933119332 - `"web_fetch"`1933319334 - `"code_execution"`1933519336 - `"bash_code_execution"`1933719338 - `"text_editor_code_execution"`1933919340 - `"tool_search_tool_regex"`1934119342 - `"tool_search_tool_bm25"`1934319344 - `WebSearchToolResultBlock object`1934519346 - `type: "web_search_tool_result"`1934719348 default: web_search_tool_result1934919350 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`1935119352 default: {"type":"direct"}1935319354 - `DirectCaller object`1935519356 Tool invocation directly from the model.1935719358 - `ServerToolCaller object`1935919360 Tool invocation generated by a server-side tool.1936119362 - `ServerToolCaller20260120 object`1936319364 - `content: WebSearchToolResultBlockContent`1936519366 - `WebSearchToolResultError object`1936719368 - `type: "web_search_tool_result_error"`1936919370 default: web_search_tool_result_error1937119372 - `error_code: WebSearchToolResultErrorCode`1937319374 - `"invalid_tool_input"`1937519376 - `"unavailable"`1937719378 - `"max_uses_exceeded"`1937919380 - `"too_many_requests"`1938119382 - `"query_too_long"`1938319384 - `"request_too_large"`1938519386 - `array of WebSearchResultBlock`1938719388 - `type: "web_search_result"`1938919390 default: web_search_result1939119392 - `encrypted_content: string`1939319394 - `page_age: string or null`1939519396 - `title: string`1939719398 - `url: string`1939919400 - `tool_use_id: string`1940119402 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1940319404 - `WebFetchToolResultBlock object`1940519406 - `type: "web_fetch_tool_result"`1940719408 default: web_fetch_tool_result1940919410 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`1941119412 default: {"type":"direct"}1941319414 - `DirectCaller object`1941519416 Tool invocation directly from the model.1941719418 - `ServerToolCaller object`1941919420 Tool invocation generated by a server-side tool.1942119422 - `ServerToolCaller20260120 object`1942319424 - `content: WebFetchToolResultErrorBlock or WebFetchBlock`1942519426 - `WebFetchToolResultErrorBlock object`1942719428 - `type: "web_fetch_tool_result_error"`1942919430 default: web_fetch_tool_result_error1943119432 - `error_code: WebFetchToolResultErrorCode`1943319434 - `"invalid_tool_input"`1943519436 - `"url_too_long"`1943719438 - `"url_not_allowed"`1943919440 - `"url_not_in_prior_context"`1944119442 - `"url_not_accessible"`1944319444 - `"unsupported_content_type"`1944519446 - `"too_many_requests"`1944719448 - `"max_uses_exceeded"`1944919450 - `"unavailable"`1945119452 - `"content_too_large"`1945319454 - `WebFetchBlock object`1945519456 - `type: "web_fetch_result"`1945719458 default: web_fetch_result1945919460 - `content: DocumentBlock`1946119462 - `type: "document"`1946319464 default: document1946519466 - `citations: CitationsConfig or null`1946719468 Citation configuration for the document1946919470 - `enabled: boolean`1947119472 default: false1947319474 - `source: Base64PDFSource or PlainTextSource`1947519476 - `Base64PDFSource object`1947719478 - `type: "base64"`1947919480 - `data: string`1948119482 format: byte1948319484 - `media_type: "application/pdf"`1948519486 - `PlainTextSource object`1948719488 - `type: "text"`1948919490 - `data: string`1949119492 - `media_type: "text/plain"`1949319494 - `title: string or null`1949519496 The title of the document1949719498 - `retrieved_at: string or null`1949919500 ISO 8601 timestamp when the content was retrieved1950119502 - `url: string`1950319504 Fetched content URL1950519506 - `tool_use_id: string`1950719508 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1950919510 - `CodeExecutionToolResultBlock object`1951119512 - `type: "code_execution_tool_result"`1951319514 default: code_execution_tool_result1951519516 - `content: CodeExecutionToolResultBlockContent`1951719518 - `CodeExecutionToolResultError object`1951919520 - `type: "code_execution_tool_result_error"`1952119522 default: code_execution_tool_result_error1952319524 - `error_code: CodeExecutionToolResultErrorCode`1952519526 - `"invalid_tool_input"`1952719528 - `"unavailable"`1952919530 - `"too_many_requests"`1953119532 - `"execution_time_exceeded"`1953319534 - `CodeExecutionResultBlock object`1953519536 - `type: "code_execution_result"`1953719538 default: code_execution_result1953919540 - `content: array of CodeExecutionOutputBlock`1954119542 - `type: "code_execution_output"`1954319544 default: code_execution_output1954519546 - `file_id: string`1954719548 - `return_code: number`1954919550 - `stderr: string`1955119552 - `stdout: string`1955319554 - `EncryptedCodeExecutionResultBlock object`1955519556 Code execution result with encrypted stdout for PFC + web_search results.1955719558 - `type: "encrypted_code_execution_result"`1955919560 default: encrypted_code_execution_result1956119562 - `content: array of CodeExecutionOutputBlock`1956319564 - `type: "code_execution_output"`1956519566 default: code_execution_output1956719568 - `file_id: string`1956919570 - `encrypted_stdout: string`1957119572 - `return_code: number`1957319574 - `stderr: string`1957519576 - `tool_use_id: string`1957719578 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1957919580 - `BashCodeExecutionToolResultBlock object`1958119582 - `type: "bash_code_execution_tool_result"`1958319584 default: bash_code_execution_tool_result1958519586 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`1958719588 - `BashCodeExecutionToolResultError object`1958919590 - `type: "bash_code_execution_tool_result_error"`1959119592 default: bash_code_execution_tool_result_error1959319594 - `error_code: BashCodeExecutionToolResultErrorCode`1959519596 - `"invalid_tool_input"`1959719598 - `"unavailable"`1959919600 - `"too_many_requests"`1960119602 - `"execution_time_exceeded"`1960319604 - `"output_file_too_large"`1960519606 - `BashCodeExecutionResultBlock object`1960719608 - `type: "bash_code_execution_result"`1960919610 default: bash_code_execution_result1961119612 - `content: array of BashCodeExecutionOutputBlock`1961319614 - `type: "bash_code_execution_output"`1961519616 default: bash_code_execution_output1961719618 - `file_id: string`1961919620 - `return_code: number`1962119622 - `stderr: string`1962319624 - `stdout: string`1962519626 - `tool_use_id: string`1962719628 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1962919630 - `TextEditorCodeExecutionToolResultBlock object`1963119632 - `type: "text_editor_code_execution_tool_result"`1963319634 default: text_editor_code_execution_tool_result1963519636 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`1963719638 - `TextEditorCodeExecutionToolResultError object`1963919640 - `type: "text_editor_code_execution_tool_result_error"`1964119642 default: text_editor_code_execution_tool_result_error1964319644 - `error_code: TextEditorCodeExecutionToolResultErrorCode`1964519646 - `"invalid_tool_input"`1964719648 - `"unavailable"`1964919650 - `"too_many_requests"`1965119652 - `"execution_time_exceeded"`1965319654 - `"file_not_found"`1965519656 - `error_message: string or null`1965719658 - `TextEditorCodeExecutionViewResultBlock object`1965919660 - `type: "text_editor_code_execution_view_result"`1966119662 default: text_editor_code_execution_view_result1966319664 - `content: string`1966519666 - `file_type: "text" or "image" or "pdf"`1966719668 - `"text"`1966919670 - `"image"`1967119672 - `"pdf"`1967319674 - `num_lines: number or null`1967519676 - `start_line: number or null`1967719678 - `total_lines: number or null`1967919680 - `TextEditorCodeExecutionCreateResultBlock object`1968119682 - `type: "text_editor_code_execution_create_result"`1968319684 default: text_editor_code_execution_create_result1968519686 - `is_file_update: boolean`1968719688 - `TextEditorCodeExecutionStrReplaceResultBlock object`1968919690 - `type: "text_editor_code_execution_str_replace_result"`1969119692 default: text_editor_code_execution_str_replace_result1969319694 - `lines: array of string or null`1969519696 - `new_lines: number or null`1969719698 - `new_start: number or null`1969919700 - `old_lines: number or null`1970119702 - `old_start: number or null`1970319704 - `tool_use_id: string`1970519706 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1970719708 - `ToolSearchToolResultBlock object`1970919710 - `type: "tool_search_tool_result"`1971119712 default: tool_search_tool_result1971319714 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`1971519716 - `ToolSearchToolResultError object`1971719718 - `type: "tool_search_tool_result_error"`1971919720 default: tool_search_tool_result_error1972119722 - `error_code: ToolSearchToolResultErrorCode`1972319724 - `"invalid_tool_input"`1972519726 - `"unavailable"`1972719728 - `"too_many_requests"`1972919730 - `"execution_time_exceeded"`1973119732 - `error_message: string or null`1973319734 - `ToolSearchToolSearchResultBlock object`1973519736 - `type: "tool_search_tool_search_result"`1973719738 default: tool_search_tool_search_result1973919740 - `tool_references: array of ToolReferenceBlock`1974119742 - `type: "tool_reference"`1974319744 default: tool_reference1974519746 - `tool_name: string`1974719748 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$1974919750 - `tool_use_id: string`1975119752 pattern: ^srvtoolu_[a-zA-Z0-9_]+$1975319754 - `ContainerUploadBlock object`1975519756 Response model for a file uploaded to the container.1975719758 - `type: "container_upload"`1975919760 default: container_upload1976119762 - `file_id: string`1976319764 - `model: Model`1976519766 The model that will complete your prompt.1976719768 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.1976919770 - `"claude-fable-5-1" or "claude-mythos-5-1" or "claude-sonnet-5" or 14 more`1977119772 The model that will complete your prompt.1977319774 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.1977519776 - `"claude-fable-5-1"`1977719778 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows1977919780 - `"claude-mythos-5-1"`1978119782 Our most capable model for cybersecurity and biology research, available through trusted access programs1978319784 - `"claude-sonnet-5"`1978519786 High-performance model for coding and agents1978719788 - `"claude-fable-5"`1978919790 Next generation of intelligence for the hardest knowledge work and coding problems1979119792 - `"claude-mythos-5"`1979319794 Most capable model for cybersecurity and biology research1979519796 - `"claude-opus-5"`1979719798 Powerful intelligence for long-running agents and coding1979919800 - `"claude-opus-4-8"`1980119802 Powerful intelligence for long-running agents and coding1980319804 - `"claude-opus-4-7"`1980519806 Powerful intelligence for long-running agents and coding1980719808 - `"claude-mythos-preview"`1980919810 New class of intelligence, strongest in coding and cybersecurity1981119812 - `"claude-opus-4-6"`1981319814 Powerful intelligence for long-running agents and coding1981519816 - `"claude-sonnet-4-6"`1981719818 Best combination of speed and intelligence1981919820 - `"claude-haiku-4-5"`1982119822 Fastest model with near-frontier intelligence1982319824 - `"claude-haiku-4-5-20251001"`1982519826 Fastest model with near-frontier intelligence1982719828 - `"claude-opus-4-5"`1982919830 Powerful intelligence for long-running agents and coding1983119832 - `"claude-opus-4-5-20251101"`1983319834 Powerful intelligence for long-running agents and coding1983519836 - `"claude-sonnet-4-5"`1983719838 High-performance model for agents and coding1983919840 - `"claude-sonnet-4-5-20250929"`1984119842 High-performance model for agents and coding1984319844 - `string`1984519846 - `role: "assistant"`1984719848 Conversational role of the generated message.1984919850 This will always be `"assistant"`.1985119852 default: assistant1985319854 - `stop_details: RefusalStopDetails or null`1985519856 Structured information about a refusal.1985719858 - `type: "refusal"`1985919860 default: refusal1986119862 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`1986319864 The policy category that triggered a refusal.1986519866 - `"cyber"`1986719868 The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category.1986919870 - `"bio"`1987119872 The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category.1987319874 - `"frontier_llm"`1987519876 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.1987719878 - `"reasoning_extraction"`1987919880 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).1988119882 - `"general_harms"`1988319884 The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category.1988519886 - `explanation: string or null`1988719888 Human-readable explanation of the refusal.1988919890 This text is not guaranteed to be stable. `null` when no explanation is available for the category.1989119892 - `stop_reason: StopReason or null`1989319894 The reason that we stopped.1989519896 This may be one the following values:1989719898 * `"end_turn"`: the model reached a natural stopping point19899 * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum19900 * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated19901 * `"tool_use"`: the model invoked one or more tools19902 * `"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.19903 * `"refusal"`: when streaming classifiers intervene to handle potential policy violations19904 * `"model_context_window_exceeded"`: we exceeded the model's context window1990519906 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.1990719908 - `"end_turn"`1990919910 - `"max_tokens"`1991119912 - `"stop_sequence"`1991319914 - `"tool_use"`1991519916 - `"pause_turn"`1991719918 - `"refusal"`1991919920 - `"model_context_window_exceeded"`1992119922 - `stop_sequence: string or null`1992319924 Which custom stop sequence was generated, if any.1992519926 This value will be a non-null string if one of your custom stop sequences was generated.1992719928 - `usage: Usage`1992919930 Billing and rate-limit usage.1993119932 Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.1993319934 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.1993519936 For example, `output_tokens` will be non-zero, even for an empty string response from Claude.1993719938 Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`.1993919940 - `cache_creation: CacheCreation or null`1994119942 Breakdown of cached tokens by TTL1994319944 - `ephemeral_1h_input_tokens: number`1994519946 The number of input tokens used to create the 1 hour cache entry.1994719948 default: 0, minimum: 01994919950 - `ephemeral_5m_input_tokens: number`1995119952 The number of input tokens used to create the 5 minute cache entry.1995319954 default: 0, minimum: 01995519956 - `cache_creation_input_tokens: number or null`1995719958 The number of input tokens used to create the cache entry.1995919960 minimum: 01996119962 - `cache_read_input_tokens: number or null`1996319964 The number of input tokens read from the cache.1996519966 minimum: 01996719968 - `inference_geo: string or null`1996919970 The geographic region where inference was performed for this request.1997119972 - `input_tokens: number`1997319974 The number of input tokens which were used.1997519976 minimum: 01997719978 - `output_tokens: number`1997919980 The number of output tokens which were used.1998119982 minimum: 01998319984 - `output_tokens_details: OutputTokensDetails or null`1998519986 Breakdown of output tokens by category.1998719988 `output_tokens` remains the inclusive, authoritative total used for billing.19989 This object provides a read-only decomposition for observability — for example,19990 how many of the billed output tokens were spent on internal reasoning that may19991 have been summarized before being returned to you.1999219993 - `thinking_tokens: number`1999419995 Number of output tokens the model generated as internal reasoning, including19996 the thinking-block delimiter tokens.1999719998 Reflects the raw reasoning the model produced, not the (possibly shorter)19999 summarized thinking text returned in the response body. Computed by20000 re-tokenizing the raw reasoning text, so it may differ from the model's exact20001 generation count by a small number of tokens. Always ≤ `output_tokens`;20002 `output_tokens - thinking_tokens` approximates the non-reasoning output.2000320004 default: 0, minimum: 02000520006 - `server_tool_use: ServerToolUsage or null`2000720008 The number of server tool requests.2000920010 - `web_fetch_requests: number`2001120012 The number of web fetch tool requests.2001320014 default: 0, minimum: 02001520016 - `web_search_requests: number`2001720018 The number of web search tool requests.2001920020 default: 0, minimum: 02002120022 - `service_tier: "standard" or "priority" or "batch" or null`2002320024 If the request used the priority, standard, or batch tier.2002520026 - `"standard"`2002720028 - `"priority"`2002920030 - `"batch"`2003120032### Raw Message Stop Event2003320034- `RawMessageStopEvent object`2003520036 - `type: "message_stop"`2003720038 default: message_stop2003920040### Raw Message Stream Event2004120042- `RawMessageStreamEvent = RawMessageStartEvent or RawMessageDeltaEvent or RawMessageStopEvent or 3 more`2004320044 - `RawMessageStartEvent object`2004520046 - `type: "message_start"`2004720048 default: message_start2004920050 - `message: Message`2005120052 - `type: "message"`2005320054 Object type.2005520056 For Messages, this is always `"message"`.2005720058 default: message2005920060 - `id: string`2006120062 Unique object identifier.2006320064 The format and length of IDs may change over time.2006520066 - `container: Container or null`2006720068 Information about the container used in the request (for the code execution tool)2006920070 - `id: string`2007120072 Identifier for the container used in this request2007320074 - `expires_at: string`2007520076 The time at which the container will expire.2007720078 format: date-time2007920080 - `skills: array of ContainerSkill or null`2008120082 Skills loaded in the container2008320084 - `type: "anthropic" or "custom"`2008520086 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)2008720088 - `"anthropic"`2008920090 - `"custom"`2009120092 - `skill_id: string`2009320094 Skill ID2009520096 maxLength: 64, minLength: 12009720098 - `version: string`2009920100 The resolved version: a skill version ID for custom skills.2010120102 maxLength: 64, minLength: 12010320104 - `content: array of ContentBlock`2010520106 Content generated by the model.2010720108 This is an array of content blocks, each of which has a `type` that determines its shape.2010920110 Example:2011120112 ```json20113 [{"type": "text", "text": "Hi, I'm Claude."}]20114 ```2011520116 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.2011720118 For example, if the input `messages` were:2011920120 ```json20121 [20122 {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},20123 {"role": "assistant", "content": "The best answer is ("}20124 ]20125 ```2012620127 Then the response `content` might be:2012820129 ```json20130 [{"type": "text", "text": "B)"}]20131 ```2013220133 - `TextBlock object`2013420135 - `type: "text"`2013620137 default: text2013820139 - `citations: array of TextCitation or null`2014020141 Citations supporting the text block.2014220143 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`.2014420145 - `CitationCharLocation object`2014620147 - `type: "char_location"`2014820149 default: char_location2015020151 - `cited_text: string`2015220153 - `document_index: number`2015420155 minimum: 02015620157 - `document_title: string or null`2015820159 - `end_char_index: number`2016020161 - `file_id: string or null`2016220163 - `start_char_index: number`2016420165 minimum: 02016620167 - `CitationPageLocation object`2016820169 - `type: "page_location"`2017020171 default: page_location2017220173 - `cited_text: string`2017420175 - `document_index: number`2017620177 minimum: 02017820179 - `document_title: string or null`2018020181 - `end_page_number: number`2018220183 - `file_id: string or null`2018420185 - `start_page_number: number`2018620187 minimum: 12018820189 - `CitationContentBlockLocation object`2019020191 - `type: "content_block_location"`2019220193 default: content_block_location2019420195 - `cited_text: string`2019620197 The full text of the cited block range, concatenated.2019820199 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.2020020201 - `document_index: number`2020220203 minimum: 02020420205 - `document_title: string or null`2020620207 - `end_block_index: number`2020820209 Exclusive 0-based end index of the cited block range in the source's `content` array.2021020211 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2021220213 - `file_id: string or null`2021420215 - `start_block_index: number`2021620217 0-based index of the first cited block in the source's `content` array.2021820219 minimum: 02022020221 - `CitationsWebSearchResultLocation object`2022220223 - `type: "web_search_result_location"`2022420225 default: web_search_result_location2022620227 - `cited_text: string`2022820229 - `encrypted_index: string`2023020231 - `title: string or null`2023220233 maxLength: 5122023420235 - `url: string`2023620237 - `CitationsSearchResultLocation object`2023820239 - `type: "search_result_location"`2024020241 default: search_result_location2024220243 - `cited_text: string`2024420245 The full text of the cited block range, concatenated.2024620247 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.2024820249 - `end_block_index: number`2025020251 Exclusive 0-based end index of the cited block range in the source's `content` array.2025220253 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2025420255 - `search_result_index: number`2025620257 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.2025820259 Counted separately from `document_index`; server-side web search results are not included in this count.2026020261 minimum: 02026220263 - `source: string`2026420265 - `start_block_index: number`2026620267 0-based index of the first cited block in the source's `content` array.2026820269 minimum: 02027020271 - `title: string or null`2027220273 - `text: string`2027420275 minLength: 02027620277 - `ThinkingBlock object`2027820279 - `type: "thinking"`2028020281 default: thinking2028220283 - `signature: string`2028420285 A value used to verify that this thinking block was generated by Claude when it is passed back to the API.2028620287 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.2028820289 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.2029020291 - `thinking: string`2029220293 The text of Claude's thinking process for this block.2029420295 - `RedactedThinkingBlock object`2029620297 - `type: "redacted_thinking"`2029820299 default: redacted_thinking2030020301 - `data: string`2030220303 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.2030420305 Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.2030620307 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.2030820309 - `ToolUseBlock object`2031020311 - `type: "tool_use"`2031220313 default: tool_use2031420315 - `id: string`2031620317 pattern: ^[a-zA-Z0-9_-]+$2031820319 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`2032020321 default: {"type":"direct"}2032220323 - `DirectCaller object`2032420325 Tool invocation directly from the model.2032620327 - `type: "direct"`2032820329 - `ServerToolCaller object`2033020331 Tool invocation generated by a server-side tool.2033220333 - `type: "code_execution_20250825"`2033420335 - `tool_id: string`2033620337 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2033820339 - `ServerToolCaller20260120 object`2034020341 - `type: "code_execution_20260120"`2034220343 - `tool_id: string`2034420345 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2034620347 - `input: map[unknown]`2034820349 - `name: string`2035020351 minLength: 12035220353 - `toolset_name: optional string or null`2035420355 For a toolset member tool_use, the toolset family.2035620357 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$2035820359 - `ServerToolUseBlock object`2036020361 - `type: "server_tool_use"`2036220363 default: server_tool_use2036420365 - `id: string`2036620367 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2036820369 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`2037020371 default: {"type":"direct"}2037220373 - `DirectCaller object`2037420375 Tool invocation directly from the model.2037620377 - `ServerToolCaller object`2037820379 Tool invocation generated by a server-side tool.2038020381 - `ServerToolCaller20260120 object`2038220383 - `input: map[unknown]`2038420385 - `name: "web_search" or "web_fetch" or "code_execution" or 4 more`2038620387 - `"web_search"`2038820389 - `"web_fetch"`2039020391 - `"code_execution"`2039220393 - `"bash_code_execution"`2039420395 - `"text_editor_code_execution"`2039620397 - `"tool_search_tool_regex"`2039820399 - `"tool_search_tool_bm25"`2040020401 - `WebSearchToolResultBlock object`2040220403 - `type: "web_search_tool_result"`2040420405 default: web_search_tool_result2040620407 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`2040820409 default: {"type":"direct"}2041020411 - `DirectCaller object`2041220413 Tool invocation directly from the model.2041420415 - `ServerToolCaller object`2041620417 Tool invocation generated by a server-side tool.2041820419 - `ServerToolCaller20260120 object`2042020421 - `content: WebSearchToolResultBlockContent`2042220423 - `WebSearchToolResultError object`2042420425 - `type: "web_search_tool_result_error"`2042620427 default: web_search_tool_result_error2042820429 - `error_code: WebSearchToolResultErrorCode`2043020431 - `"invalid_tool_input"`2043220433 - `"unavailable"`2043420435 - `"max_uses_exceeded"`2043620437 - `"too_many_requests"`2043820439 - `"query_too_long"`2044020441 - `"request_too_large"`2044220443 - `array of WebSearchResultBlock`2044420445 - `type: "web_search_result"`2044620447 default: web_search_result2044820449 - `encrypted_content: string`2045020451 - `page_age: string or null`2045220453 - `title: string`2045420455 - `url: string`2045620457 - `tool_use_id: string`2045820459 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2046020461 - `WebFetchToolResultBlock object`2046220463 - `type: "web_fetch_tool_result"`2046420465 default: web_fetch_tool_result2046620467 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`2046820469 default: {"type":"direct"}2047020471 - `DirectCaller object`2047220473 Tool invocation directly from the model.2047420475 - `ServerToolCaller object`2047620477 Tool invocation generated by a server-side tool.2047820479 - `ServerToolCaller20260120 object`2048020481 - `content: WebFetchToolResultErrorBlock or WebFetchBlock`2048220483 - `WebFetchToolResultErrorBlock object`2048420485 - `type: "web_fetch_tool_result_error"`2048620487 default: web_fetch_tool_result_error2048820489 - `error_code: WebFetchToolResultErrorCode`2049020491 - `"invalid_tool_input"`2049220493 - `"url_too_long"`2049420495 - `"url_not_allowed"`2049620497 - `"url_not_in_prior_context"`2049820499 - `"url_not_accessible"`2050020501 - `"unsupported_content_type"`2050220503 - `"too_many_requests"`2050420505 - `"max_uses_exceeded"`2050620507 - `"unavailable"`2050820509 - `"content_too_large"`2051020511 - `WebFetchBlock object`2051220513 - `type: "web_fetch_result"`2051420515 default: web_fetch_result2051620517 - `content: DocumentBlock`2051820519 - `type: "document"`2052020521 default: document2052220523 - `citations: CitationsConfig or null`2052420525 Citation configuration for the document2052620527 - `enabled: boolean`2052820529 default: false2053020531 - `source: Base64PDFSource or PlainTextSource`2053220533 - `Base64PDFSource object`2053420535 - `type: "base64"`2053620537 - `data: string`2053820539 format: byte2054020541 - `media_type: "application/pdf"`2054220543 - `PlainTextSource object`2054420545 - `type: "text"`2054620547 - `data: string`2054820549 - `media_type: "text/plain"`2055020551 - `title: string or null`2055220553 The title of the document2055420555 - `retrieved_at: string or null`2055620557 ISO 8601 timestamp when the content was retrieved2055820559 - `url: string`2056020561 Fetched content URL2056220563 - `tool_use_id: string`2056420565 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2056620567 - `CodeExecutionToolResultBlock object`2056820569 - `type: "code_execution_tool_result"`2057020571 default: code_execution_tool_result2057220573 - `content: CodeExecutionToolResultBlockContent`2057420575 - `CodeExecutionToolResultError object`2057620577 - `type: "code_execution_tool_result_error"`2057820579 default: code_execution_tool_result_error2058020581 - `error_code: CodeExecutionToolResultErrorCode`2058220583 - `"invalid_tool_input"`2058420585 - `"unavailable"`2058620587 - `"too_many_requests"`2058820589 - `"execution_time_exceeded"`2059020591 - `CodeExecutionResultBlock object`2059220593 - `type: "code_execution_result"`2059420595 default: code_execution_result2059620597 - `content: array of CodeExecutionOutputBlock`2059820599 - `type: "code_execution_output"`2060020601 default: code_execution_output2060220603 - `file_id: string`2060420605 - `return_code: number`2060620607 - `stderr: string`2060820609 - `stdout: string`2061020611 - `EncryptedCodeExecutionResultBlock object`2061220613 Code execution result with encrypted stdout for PFC + web_search results.2061420615 - `type: "encrypted_code_execution_result"`2061620617 default: encrypted_code_execution_result2061820619 - `content: array of CodeExecutionOutputBlock`2062020621 - `type: "code_execution_output"`2062220623 default: code_execution_output2062420625 - `file_id: string`2062620627 - `encrypted_stdout: string`2062820629 - `return_code: number`2063020631 - `stderr: string`2063220633 - `tool_use_id: string`2063420635 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2063620637 - `BashCodeExecutionToolResultBlock object`2063820639 - `type: "bash_code_execution_tool_result"`2064020641 default: bash_code_execution_tool_result2064220643 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`2064420645 - `BashCodeExecutionToolResultError object`2064620647 - `type: "bash_code_execution_tool_result_error"`2064820649 default: bash_code_execution_tool_result_error2065020651 - `error_code: BashCodeExecutionToolResultErrorCode`2065220653 - `"invalid_tool_input"`2065420655 - `"unavailable"`2065620657 - `"too_many_requests"`2065820659 - `"execution_time_exceeded"`2066020661 - `"output_file_too_large"`2066220663 - `BashCodeExecutionResultBlock object`2066420665 - `type: "bash_code_execution_result"`2066620667 default: bash_code_execution_result2066820669 - `content: array of BashCodeExecutionOutputBlock`2067020671 - `type: "bash_code_execution_output"`2067220673 default: bash_code_execution_output2067420675 - `file_id: string`2067620677 - `return_code: number`2067820679 - `stderr: string`2068020681 - `stdout: string`2068220683 - `tool_use_id: string`2068420685 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2068620687 - `TextEditorCodeExecutionToolResultBlock object`2068820689 - `type: "text_editor_code_execution_tool_result"`2069020691 default: text_editor_code_execution_tool_result2069220693 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`2069420695 - `TextEditorCodeExecutionToolResultError object`2069620697 - `type: "text_editor_code_execution_tool_result_error"`2069820699 default: text_editor_code_execution_tool_result_error2070020701 - `error_code: TextEditorCodeExecutionToolResultErrorCode`2070220703 - `"invalid_tool_input"`2070420705 - `"unavailable"`2070620707 - `"too_many_requests"`2070820709 - `"execution_time_exceeded"`2071020711 - `"file_not_found"`2071220713 - `error_message: string or null`2071420715 - `TextEditorCodeExecutionViewResultBlock object`2071620717 - `type: "text_editor_code_execution_view_result"`2071820719 default: text_editor_code_execution_view_result2072020721 - `content: string`2072220723 - `file_type: "text" or "image" or "pdf"`2072420725 - `"text"`2072620727 - `"image"`2072820729 - `"pdf"`2073020731 - `num_lines: number or null`2073220733 - `start_line: number or null`2073420735 - `total_lines: number or null`2073620737 - `TextEditorCodeExecutionCreateResultBlock object`2073820739 - `type: "text_editor_code_execution_create_result"`2074020741 default: text_editor_code_execution_create_result2074220743 - `is_file_update: boolean`2074420745 - `TextEditorCodeExecutionStrReplaceResultBlock object`2074620747 - `type: "text_editor_code_execution_str_replace_result"`2074820749 default: text_editor_code_execution_str_replace_result2075020751 - `lines: array of string or null`2075220753 - `new_lines: number or null`2075420755 - `new_start: number or null`2075620757 - `old_lines: number or null`2075820759 - `old_start: number or null`2076020761 - `tool_use_id: string`2076220763 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2076420765 - `ToolSearchToolResultBlock object`2076620767 - `type: "tool_search_tool_result"`2076820769 default: tool_search_tool_result2077020771 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`2077220773 - `ToolSearchToolResultError object`2077420775 - `type: "tool_search_tool_result_error"`2077620777 default: tool_search_tool_result_error2077820779 - `error_code: ToolSearchToolResultErrorCode`2078020781 - `"invalid_tool_input"`2078220783 - `"unavailable"`2078420785 - `"too_many_requests"`2078620787 - `"execution_time_exceeded"`2078820789 - `error_message: string or null`2079020791 - `ToolSearchToolSearchResultBlock object`2079220793 - `type: "tool_search_tool_search_result"`2079420795 default: tool_search_tool_search_result2079620797 - `tool_references: array of ToolReferenceBlock`2079820799 - `type: "tool_reference"`2080020801 default: tool_reference2080220803 - `tool_name: string`2080420805 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$2080620807 - `tool_use_id: string`2080820809 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2081020811 - `ContainerUploadBlock object`2081220813 Response model for a file uploaded to the container.2081420815 - `type: "container_upload"`2081620817 default: container_upload2081820819 - `file_id: string`2082020821 - `model: Model`2082220823 The model that will complete your prompt.2082420825 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.2082620827 - `"claude-fable-5-1" or "claude-mythos-5-1" or "claude-sonnet-5" or 14 more`2082820829 The model that will complete your prompt.2083020831 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.2083220833 - `"claude-fable-5-1"`2083420835 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows2083620837 - `"claude-mythos-5-1"`2083820839 Our most capable model for cybersecurity and biology research, available through trusted access programs2084020841 - `"claude-sonnet-5"`2084220843 High-performance model for coding and agents2084420845 - `"claude-fable-5"`2084620847 Next generation of intelligence for the hardest knowledge work and coding problems2084820849 - `"claude-mythos-5"`2085020851 Most capable model for cybersecurity and biology research2085220853 - `"claude-opus-5"`2085420855 Powerful intelligence for long-running agents and coding2085620857 - `"claude-opus-4-8"`2085820859 Powerful intelligence for long-running agents and coding2086020861 - `"claude-opus-4-7"`2086220863 Powerful intelligence for long-running agents and coding2086420865 - `"claude-mythos-preview"`2086620867 New class of intelligence, strongest in coding and cybersecurity2086820869 - `"claude-opus-4-6"`2087020871 Powerful intelligence for long-running agents and coding2087220873 - `"claude-sonnet-4-6"`2087420875 Best combination of speed and intelligence2087620877 - `"claude-haiku-4-5"`2087820879 Fastest model with near-frontier intelligence2088020881 - `"claude-haiku-4-5-20251001"`2088220883 Fastest model with near-frontier intelligence2088420885 - `"claude-opus-4-5"`2088620887 Powerful intelligence for long-running agents and coding2088820889 - `"claude-opus-4-5-20251101"`2089020891 Powerful intelligence for long-running agents and coding2089220893 - `"claude-sonnet-4-5"`2089420895 High-performance model for agents and coding2089620897 - `"claude-sonnet-4-5-20250929"`2089820899 High-performance model for agents and coding2090020901 - `string`2090220903 - `role: "assistant"`2090420905 Conversational role of the generated message.2090620907 This will always be `"assistant"`.2090820909 default: assistant2091020911 - `stop_details: RefusalStopDetails or null`2091220913 Structured information about a refusal.2091420915 - `type: "refusal"`2091620917 default: refusal2091820919 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`2092020921 The policy category that triggered a refusal.2092220923 - `"cyber"`2092420925 The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category.2092620927 - `"bio"`2092820929 The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category.2093020931 - `"frontier_llm"`2093220933 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.2093420935 - `"reasoning_extraction"`2093620937 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).2093820939 - `"general_harms"`2094020941 The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category.2094220943 - `explanation: string or null`2094420945 Human-readable explanation of the refusal.2094620947 This text is not guaranteed to be stable. `null` when no explanation is available for the category.2094820949 - `stop_reason: StopReason or null`2095020951 The reason that we stopped.2095220953 This may be one the following values:2095420955 * `"end_turn"`: the model reached a natural stopping point20956 * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum20957 * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated20958 * `"tool_use"`: the model invoked one or more tools20959 * `"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.20960 * `"refusal"`: when streaming classifiers intervene to handle potential policy violations20961 * `"model_context_window_exceeded"`: we exceeded the model's context window2096220963 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.2096420965 - `"end_turn"`2096620967 - `"max_tokens"`2096820969 - `"stop_sequence"`2097020971 - `"tool_use"`2097220973 - `"pause_turn"`2097420975 - `"refusal"`2097620977 - `"model_context_window_exceeded"`2097820979 - `stop_sequence: string or null`2098020981 Which custom stop sequence was generated, if any.2098220983 This value will be a non-null string if one of your custom stop sequences was generated.2098420985 - `usage: Usage`2098620987 Billing and rate-limit usage.2098820989 Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.2099020991 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.2099220993 For example, `output_tokens` will be non-zero, even for an empty string response from Claude.2099420995 Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`.2099620997 - `cache_creation: CacheCreation or null`2099820999 Breakdown of cached tokens by TTL2100021001 - `ephemeral_1h_input_tokens: number`2100221003 The number of input tokens used to create the 1 hour cache entry.2100421005 default: 0, minimum: 02100621007 - `ephemeral_5m_input_tokens: number`2100821009 The number of input tokens used to create the 5 minute cache entry.2101021011 default: 0, minimum: 02101221013 - `cache_creation_input_tokens: number or null`2101421015 The number of input tokens used to create the cache entry.2101621017 minimum: 02101821019 - `cache_read_input_tokens: number or null`2102021021 The number of input tokens read from the cache.2102221023 minimum: 02102421025 - `inference_geo: string or null`2102621027 The geographic region where inference was performed for this request.2102821029 - `input_tokens: number`2103021031 The number of input tokens which were used.2103221033 minimum: 02103421035 - `output_tokens: number`2103621037 The number of output tokens which were used.2103821039 minimum: 02104021041 - `output_tokens_details: OutputTokensDetails or null`2104221043 Breakdown of output tokens by category.2104421045 `output_tokens` remains the inclusive, authoritative total used for billing.21046 This object provides a read-only decomposition for observability — for example,21047 how many of the billed output tokens were spent on internal reasoning that may21048 have been summarized before being returned to you.2104921050 - `thinking_tokens: number`2105121052 Number of output tokens the model generated as internal reasoning, including21053 the thinking-block delimiter tokens.2105421055 Reflects the raw reasoning the model produced, not the (possibly shorter)21056 summarized thinking text returned in the response body. Computed by21057 re-tokenizing the raw reasoning text, so it may differ from the model's exact21058 generation count by a small number of tokens. Always ≤ `output_tokens`;21059 `output_tokens - thinking_tokens` approximates the non-reasoning output.2106021061 default: 0, minimum: 02106221063 - `server_tool_use: ServerToolUsage or null`2106421065 The number of server tool requests.2106621067 - `web_fetch_requests: number`2106821069 The number of web fetch tool requests.2107021071 default: 0, minimum: 02107221073 - `web_search_requests: number`2107421075 The number of web search tool requests.2107621077 default: 0, minimum: 02107821079 - `service_tier: "standard" or "priority" or "batch" or null`2108021081 If the request used the priority, standard, or batch tier.2108221083 - `"standard"`2108421085 - `"priority"`2108621087 - `"batch"`2108821089 - `RawMessageDeltaEvent object`2109021091 - `type: "message_delta"`2109221093 default: message_delta2109421095 - `delta: object`2109621097 - `container: Container or null`2109821099 Information about the container used in the request (for the code execution tool)2110021101 - `stop_details: RefusalStopDetails or null`2110221103 Structured information about a refusal.2110421105 - `stop_reason: StopReason or null`2110621107 - `stop_sequence: string or null`2110821109 - `usage: MessageDeltaUsage`2111021111 Billing and rate-limit usage.2111221113 Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.2111421115 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.2111621117 For example, `output_tokens` will be non-zero, even for an empty string response from Claude.2111821119 Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`.2112021121 - `cache_creation_input_tokens: number or null`2112221123 The cumulative number of input tokens used to create the cache entry.2112421125 minimum: 02112621127 - `cache_read_input_tokens: number or null`2112821129 The cumulative number of input tokens read from the cache.2113021131 minimum: 02113221133 - `input_tokens: number or null`2113421135 The cumulative number of input tokens which were used.2113621137 minimum: 02113821139 - `output_tokens: number`2114021141 The cumulative number of output tokens which were used.2114221143 - `output_tokens_details: OutputTokensDetails or null`2114421145 Breakdown of output tokens by category.2114621147 `output_tokens` remains the inclusive, authoritative total used for billing.21148 This object provides a read-only decomposition for observability — for example,21149 how many of the billed output tokens were spent on internal reasoning that may21150 have been summarized before being returned to you.2115121152 - `server_tool_use: ServerToolUsage or null`2115321154 The number of server tool requests.2115521156 - `RawMessageStopEvent object`2115721158 - `type: "message_stop"`2115921160 default: message_stop2116121162 - `RawContentBlockStartEvent object`2116321164 - `type: "content_block_start"`2116521166 default: content_block_start2116721168 - `content_block: TextBlock or ThinkingBlock or RedactedThinkingBlock or 9 more`2116921170 - `TextBlock object`2117121172 - `ThinkingBlock object`2117321174 - `RedactedThinkingBlock object`2117521176 - `ToolUseBlock object`2117721178 - `ServerToolUseBlock object`2117921180 - `WebSearchToolResultBlock object`2118121182 - `WebFetchToolResultBlock object`2118321184 - `CodeExecutionToolResultBlock object`2118521186 - `BashCodeExecutionToolResultBlock object`2118721188 - `TextEditorCodeExecutionToolResultBlock object`2118921190 - `ToolSearchToolResultBlock object`2119121192 - `ContainerUploadBlock object`2119321194 Response model for a file uploaded to the container.2119521196 - `index: number`2119721198 - `RawContentBlockDeltaEvent object`2119921200 - `type: "content_block_delta"`2120121202 default: content_block_delta2120321204 - `delta: RawContentBlockDelta`2120521206 - `TextDelta object`2120721208 - `type: "text_delta"`2120921210 default: text_delta2121121212 - `text: string`2121321214 - `InputJSONDelta object`2121521216 - `type: "input_json_delta"`2121721218 default: input_json_delta2121921220 - `partial_json: string`2122121222 - `CitationsDelta object`2122321224 - `type: "citations_delta"`2122521226 default: citations_delta2122721228 - `citation: CitationCharLocation or CitationPageLocation or CitationContentBlockLocation or 2 more`2122921230 - `CitationCharLocation object`2123121232 - `CitationPageLocation object`2123321234 - `CitationContentBlockLocation object`2123521236 - `CitationsWebSearchResultLocation object`2123721238 - `CitationsSearchResultLocation object`2123921240 - `ThinkingDelta object`2124121242 - `type: "thinking_delta"`2124321244 default: thinking_delta2124521246 - `thinking: string`2124721248 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.2124921250 - `SignatureDelta object`2125121252 - `type: "signature_delta"`2125321254 default: signature_delta2125521256 - `signature: string`2125721258 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.2125921260 - `index: number`2126121262 - `RawContentBlockStopEvent object`2126321264 - `type: "content_block_stop"`2126521266 default: content_block_stop2126721268 - `index: number`2126921270### Redacted Thinking Block2127121272- `RedactedThinkingBlock object`2127321274 - `type: "redacted_thinking"`2127521276 default: redacted_thinking2127721278 - `data: string`2127921280 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.2128121282 Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.2128321284 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.2128521286### Redacted Thinking Block Param2128721288- `RedactedThinkingBlockParam object`2128921290 - `type: "redacted_thinking"`2129121292 - `data: string`2129321294 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.2129521296### Refusal Stop Details2129721298- `RefusalStopDetails object`2129921300 Structured information about a refusal.2130121302 - `type: "refusal"`2130321304 default: refusal2130521306 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`2130721308 The policy category that triggered a refusal.2130921310 - `"cyber"`2131121312 The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category.2131321314 - `"bio"`2131521316 The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category.2131721318 - `"frontier_llm"`2131921320 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.2132121322 - `"reasoning_extraction"`2132321324 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).2132521326 - `"general_harms"`2132721328 The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category.2132921330 - `explanation: string or null`2133121332 Human-readable explanation of the refusal.2133321334 This text is not guaranteed to be stable. `null` when no explanation is available for the category.2133521336### Search Result Block Param2133721338- `SearchResultBlockParam object`2133921340 - `type: "search_result"`2134121342 - `content: array of TextBlockParam`2134321344 - `type: "text"`2134521346 - `text: string`2134721348 minLength: 12134921350 - `cache_control: optional CacheControlEphemeral or null`2135121352 Create a cache control breakpoint at this content block.2135321354 - `type: "ephemeral"`2135521356 - `ttl: optional "5m" or "1h"`2135721358 The time-to-live for the cache control breakpoint.2135921360 This may be one the following values:2136121362 - `5m`: 5 minutes21363 - `1h`: 1 hour2136421365 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2136621367 - `"5m"`2136821369 - `"1h"`2137021371 - `citations: optional array of TextCitationParam or null`2137221373 - `CitationCharLocationParam object`2137421375 - `type: "char_location"`2137621377 - `cited_text: string`2137821379 - `document_index: number`2138021381 minimum: 02138221383 - `document_title: string or null`2138421385 maxLength: 500, minLength: 12138621387 - `end_char_index: number`2138821389 - `start_char_index: number`2139021391 minimum: 02139221393 - `CitationPageLocationParam object`2139421395 - `type: "page_location"`2139621397 - `cited_text: string`2139821399 - `document_index: number`2140021401 minimum: 02140221403 - `document_title: string or null`2140421405 maxLength: 500, minLength: 12140621407 - `end_page_number: number`2140821409 - `start_page_number: number`2141021411 minimum: 12141221413 - `CitationContentBlockLocationParam object`2141421415 - `type: "content_block_location"`2141621417 - `cited_text: string`2141821419 The full text of the cited block range, concatenated.2142021421 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.2142221423 - `document_index: number`2142421425 minimum: 02142621427 - `document_title: string or null`2142821429 maxLength: 500, minLength: 12143021431 - `end_block_index: number`2143221433 Exclusive 0-based end index of the cited block range in the source's `content` array.2143421435 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2143621437 - `start_block_index: number`2143821439 0-based index of the first cited block in the source's `content` array.2144021441 minimum: 02144221443 - `CitationWebSearchResultLocationParam object`2144421445 - `type: "web_search_result_location"`2144621447 - `cited_text: string`2144821449 - `encrypted_index: string`2145021451 - `title: string or null`2145221453 maxLength: 512, minLength: 12145421455 - `url: string`2145621457 minLength: 12145821459 - `CitationSearchResultLocationParam object`2146021461 - `type: "search_result_location"`2146221463 - `cited_text: string`2146421465 The full text of the cited block range, concatenated.2146621467 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.2146821469 - `end_block_index: number`2147021471 Exclusive 0-based end index of the cited block range in the source's `content` array.2147221473 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2147421475 - `search_result_index: number`2147621477 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.2147821479 Counted separately from `document_index`; server-side web search results are not included in this count.2148021481 minimum: 02148221483 - `source: string`2148421485 - `start_block_index: number`2148621487 0-based index of the first cited block in the source's `content` array.2148821489 minimum: 02149021491 - `title: string or null`2149221493 - `source: string`2149421495 - `title: string`2149621497 - `cache_control: optional CacheControlEphemeral or null`2149821499 Create a cache control breakpoint at this content block.2150021501 - `citations: optional CitationsConfigParam`2150221503 - `enabled: optional boolean`2150421505### Server Tool Caller2150621507- `ServerToolCaller object`2150821509 Tool invocation generated by a server-side tool.2151021511 - `type: "code_execution_20250825"`2151221513 - `tool_id: string`2151421515 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2151621517### Server Tool Caller 202601202151821519- `ServerToolCaller20260120 object`2152021521 - `type: "code_execution_20260120"`2152221523 - `tool_id: string`2152421525 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2152621527### Server Tool Usage2152821529- `ServerToolUsage object`2153021531 - `web_fetch_requests: number`2153221533 The number of web fetch tool requests.2153421535 default: 0, minimum: 02153621537 - `web_search_requests: number`2153821539 The number of web search tool requests.2154021541 default: 0, minimum: 02154221543### Server Tool Use Block2154421545- `ServerToolUseBlock object`2154621547 - `type: "server_tool_use"`2154821549 default: server_tool_use2155021551 - `id: string`2155221553 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2155421555 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`2155621557 default: {"type":"direct"}2155821559 - `DirectCaller object`2156021561 Tool invocation directly from the model.2156221563 - `type: "direct"`2156421565 - `ServerToolCaller object`2156621567 Tool invocation generated by a server-side tool.2156821569 - `type: "code_execution_20250825"`2157021571 - `tool_id: string`2157221573 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2157421575 - `ServerToolCaller20260120 object`2157621577 - `type: "code_execution_20260120"`2157821579 - `tool_id: string`2158021581 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2158221583 - `input: map[unknown]`2158421585 - `name: "web_search" or "web_fetch" or "code_execution" or 4 more`2158621587 - `"web_search"`2158821589 - `"web_fetch"`2159021591 - `"code_execution"`2159221593 - `"bash_code_execution"`2159421595 - `"text_editor_code_execution"`2159621597 - `"tool_search_tool_regex"`2159821599 - `"tool_search_tool_bm25"`2160021601### Server Tool Use Block Param2160221603- `ServerToolUseBlockParam object`2160421605 - `type: "server_tool_use"`2160621607 - `id: string`2160821609 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2161021611 - `input: map[unknown]`2161221613 - `name: "web_search" or "web_fetch" or "code_execution" or 4 more`2161421615 - `"web_search"`2161621617 - `"web_fetch"`2161821619 - `"code_execution"`2162021621 - `"bash_code_execution"`2162221623 - `"text_editor_code_execution"`2162421625 - `"tool_search_tool_regex"`2162621627 - `"tool_search_tool_bm25"`2162821629 - `cache_control: optional CacheControlEphemeral or null`2163021631 Create a cache control breakpoint at this content block.2163221633 - `type: "ephemeral"`2163421635 - `ttl: optional "5m" or "1h"`2163621637 The time-to-live for the cache control breakpoint.2163821639 This may be one the following values:2164021641 - `5m`: 5 minutes21642 - `1h`: 1 hour2164321644 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2164521646 - `"5m"`2164721648 - `"1h"`2164921650 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`2165121652 - `DirectCaller object`2165321654 Tool invocation directly from the model.2165521656 - `type: "direct"`2165721658 - `ServerToolCaller object`2165921660 Tool invocation generated by a server-side tool.2166121662 - `type: "code_execution_20250825"`2166321664 - `tool_id: string`2166521666 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2166721668 - `ServerToolCaller20260120 object`2166921670 - `type: "code_execution_20260120"`2167121672 - `tool_id: string`2167321674 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2167521676### Signature Delta2167721678- `SignatureDelta object`2167921680 - `type: "signature_delta"`2168121682 default: signature_delta2168321684 - `signature: string`2168521686 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.2168721688### Skill Params2168921690- `SkillParams object`2169121692 Specification for a skill to be loaded in a container (request model).2169321694 - `type: "anthropic" or "custom"`2169521696 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)2169721698 - `"anthropic"`2169921700 - `"custom"`2170121702 - `skill_id: string`2170321704 Skill ID2170521706 maxLength: 64, minLength: 12170721708 - `version: optional string`2170921710 Skill version or 'latest' for most recent version2171121712 maxLength: 64, minLength: 12171321714### Stop Reason2171521716- `StopReason = "end_turn" or "max_tokens" or "stop_sequence" or 4 more`2171721718 - `"end_turn"`2171921720 - `"max_tokens"`2172121722 - `"stop_sequence"`2172321724 - `"tool_use"`2172521726 - `"pause_turn"`2172721728 - `"refusal"`2172921730 - `"model_context_window_exceeded"`2173121732### Text Block2173321734- `TextBlock object`2173521736 - `type: "text"`2173721738 default: text2173921740 - `citations: array of TextCitation or null`2174121742 Citations supporting the text block.2174321744 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`.2174521746 - `CitationCharLocation object`2174721748 - `type: "char_location"`2174921750 default: char_location2175121752 - `cited_text: string`2175321754 - `document_index: number`2175521756 minimum: 02175721758 - `document_title: string or null`2175921760 - `end_char_index: number`2176121762 - `file_id: string or null`2176321764 - `start_char_index: number`2176521766 minimum: 02176721768 - `CitationPageLocation object`2176921770 - `type: "page_location"`2177121772 default: page_location2177321774 - `cited_text: string`2177521776 - `document_index: number`2177721778 minimum: 02177921780 - `document_title: string or null`2178121782 - `end_page_number: number`2178321784 - `file_id: string or null`2178521786 - `start_page_number: number`2178721788 minimum: 12178921790 - `CitationContentBlockLocation object`2179121792 - `type: "content_block_location"`2179321794 default: content_block_location2179521796 - `cited_text: string`2179721798 The full text of the cited block range, concatenated.2179921800 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.2180121802 - `document_index: number`2180321804 minimum: 02180521806 - `document_title: string or null`2180721808 - `end_block_index: number`2180921810 Exclusive 0-based end index of the cited block range in the source's `content` array.2181121812 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2181321814 - `file_id: string or null`2181521816 - `start_block_index: number`2181721818 0-based index of the first cited block in the source's `content` array.2181921820 minimum: 02182121822 - `CitationsWebSearchResultLocation object`2182321824 - `type: "web_search_result_location"`2182521826 default: web_search_result_location2182721828 - `cited_text: string`2182921830 - `encrypted_index: string`2183121832 - `title: string or null`2183321834 maxLength: 5122183521836 - `url: string`2183721838 - `CitationsSearchResultLocation object`2183921840 - `type: "search_result_location"`2184121842 default: search_result_location2184321844 - `cited_text: string`2184521846 The full text of the cited block range, concatenated.2184721848 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.2184921850 - `end_block_index: number`2185121852 Exclusive 0-based end index of the cited block range in the source's `content` array.2185321854 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2185521856 - `search_result_index: number`2185721858 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.2185921860 Counted separately from `document_index`; server-side web search results are not included in this count.2186121862 minimum: 02186321864 - `source: string`2186521866 - `start_block_index: number`2186721868 0-based index of the first cited block in the source's `content` array.2186921870 minimum: 02187121872 - `title: string or null`2187321874 - `text: string`2187521876 minLength: 02187721878### Text Block Param2187921880- `TextBlockParam object`2188121882 - `type: "text"`2188321884 - `text: string`2188521886 minLength: 12188721888 - `cache_control: optional CacheControlEphemeral or null`2188921890 Create a cache control breakpoint at this content block.2189121892 - `type: "ephemeral"`2189321894 - `ttl: optional "5m" or "1h"`2189521896 The time-to-live for the cache control breakpoint.2189721898 This may be one the following values:2189921900 - `5m`: 5 minutes21901 - `1h`: 1 hour2190221903 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2190421905 - `"5m"`2190621907 - `"1h"`2190821909 - `citations: optional array of TextCitationParam or null`2191021911 - `CitationCharLocationParam object`2191221913 - `type: "char_location"`2191421915 - `cited_text: string`2191621917 - `document_index: number`2191821919 minimum: 02192021921 - `document_title: string or null`2192221923 maxLength: 500, minLength: 12192421925 - `end_char_index: number`2192621927 - `start_char_index: number`2192821929 minimum: 02193021931 - `CitationPageLocationParam object`2193221933 - `type: "page_location"`2193421935 - `cited_text: string`2193621937 - `document_index: number`2193821939 minimum: 02194021941 - `document_title: string or null`2194221943 maxLength: 500, minLength: 12194421945 - `end_page_number: number`2194621947 - `start_page_number: number`2194821949 minimum: 12195021951 - `CitationContentBlockLocationParam object`2195221953 - `type: "content_block_location"`2195421955 - `cited_text: string`2195621957 The full text of the cited block range, concatenated.2195821959 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.2196021961 - `document_index: number`2196221963 minimum: 02196421965 - `document_title: string or null`2196621967 maxLength: 500, minLength: 12196821969 - `end_block_index: number`2197021971 Exclusive 0-based end index of the cited block range in the source's `content` array.2197221973 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2197421975 - `start_block_index: number`2197621977 0-based index of the first cited block in the source's `content` array.2197821979 minimum: 02198021981 - `CitationWebSearchResultLocationParam object`2198221983 - `type: "web_search_result_location"`2198421985 - `cited_text: string`2198621987 - `encrypted_index: string`2198821989 - `title: string or null`2199021991 maxLength: 512, minLength: 12199221993 - `url: string`2199421995 minLength: 12199621997 - `CitationSearchResultLocationParam object`2199821999 - `type: "search_result_location"`2200022001 - `cited_text: string`2200222003 The full text of the cited block range, concatenated.2200422005 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.2200622007 - `end_block_index: number`2200822009 Exclusive 0-based end index of the cited block range in the source's `content` array.2201022011 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2201222013 - `search_result_index: number`2201422015 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.2201622017 Counted separately from `document_index`; server-side web search results are not included in this count.2201822019 minimum: 02202022021 - `source: string`2202222023 - `start_block_index: number`2202422025 0-based index of the first cited block in the source's `content` array.2202622027 minimum: 02202822029 - `title: string or null`2203022031### Text Citation2203222033- `TextCitation = CitationCharLocation or CitationPageLocation or CitationContentBlockLocation or 2 more`2203422035 - `CitationCharLocation object`2203622037 - `type: "char_location"`2203822039 default: char_location2204022041 - `cited_text: string`2204222043 - `document_index: number`2204422045 minimum: 02204622047 - `document_title: string or null`2204822049 - `end_char_index: number`2205022051 - `file_id: string or null`2205222053 - `start_char_index: number`2205422055 minimum: 02205622057 - `CitationPageLocation object`2205822059 - `type: "page_location"`2206022061 default: page_location2206222063 - `cited_text: string`2206422065 - `document_index: number`2206622067 minimum: 02206822069 - `document_title: string or null`2207022071 - `end_page_number: number`2207222073 - `file_id: string or null`2207422075 - `start_page_number: number`2207622077 minimum: 12207822079 - `CitationContentBlockLocation object`2208022081 - `type: "content_block_location"`2208222083 default: content_block_location2208422085 - `cited_text: string`2208622087 The full text of the cited block range, concatenated.2208822089 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.2209022091 - `document_index: number`2209222093 minimum: 02209422095 - `document_title: string or null`2209622097 - `end_block_index: number`2209822099 Exclusive 0-based end index of the cited block range in the source's `content` array.2210022101 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2210222103 - `file_id: string or null`2210422105 - `start_block_index: number`2210622107 0-based index of the first cited block in the source's `content` array.2210822109 minimum: 02211022111 - `CitationsWebSearchResultLocation object`2211222113 - `type: "web_search_result_location"`2211422115 default: web_search_result_location2211622117 - `cited_text: string`2211822119 - `encrypted_index: string`2212022121 - `title: string or null`2212222123 maxLength: 5122212422125 - `url: string`2212622127 - `CitationsSearchResultLocation object`2212822129 - `type: "search_result_location"`2213022131 default: search_result_location2213222133 - `cited_text: string`2213422135 The full text of the cited block range, concatenated.2213622137 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.2213822139 - `end_block_index: number`2214022141 Exclusive 0-based end index of the cited block range in the source's `content` array.2214222143 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2214422145 - `search_result_index: number`2214622147 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.2214822149 Counted separately from `document_index`; server-side web search results are not included in this count.2215022151 minimum: 02215222153 - `source: string`2215422155 - `start_block_index: number`2215622157 0-based index of the first cited block in the source's `content` array.2215822159 minimum: 02216022161 - `title: string or null`2216222163### Text Citation Param2216422165- `TextCitationParam = CitationCharLocationParam or CitationPageLocationParam or CitationContentBlockLocationParam or 2 more`2216622167 - `CitationCharLocationParam object`2216822169 - `type: "char_location"`2217022171 - `cited_text: string`2217222173 - `document_index: number`2217422175 minimum: 02217622177 - `document_title: string or null`2217822179 maxLength: 500, minLength: 12218022181 - `end_char_index: number`2218222183 - `start_char_index: number`2218422185 minimum: 02218622187 - `CitationPageLocationParam object`2218822189 - `type: "page_location"`2219022191 - `cited_text: string`2219222193 - `document_index: number`2219422195 minimum: 02219622197 - `document_title: string or null`2219822199 maxLength: 500, minLength: 12220022201 - `end_page_number: number`2220222203 - `start_page_number: number`2220422205 minimum: 12220622207 - `CitationContentBlockLocationParam object`2220822209 - `type: "content_block_location"`2221022211 - `cited_text: string`2221222213 The full text of the cited block range, concatenated.2221422215 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.2221622217 - `document_index: number`2221822219 minimum: 02222022221 - `document_title: string or null`2222222223 maxLength: 500, minLength: 12222422225 - `end_block_index: number`2222622227 Exclusive 0-based end index of the cited block range in the source's `content` array.2222822229 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2223022231 - `start_block_index: number`2223222233 0-based index of the first cited block in the source's `content` array.2223422235 minimum: 02223622237 - `CitationWebSearchResultLocationParam object`2223822239 - `type: "web_search_result_location"`2224022241 - `cited_text: string`2224222243 - `encrypted_index: string`2224422245 - `title: string or null`2224622247 maxLength: 512, minLength: 12224822249 - `url: string`2225022251 minLength: 12225222253 - `CitationSearchResultLocationParam object`2225422255 - `type: "search_result_location"`2225622257 - `cited_text: string`2225822259 The full text of the cited block range, concatenated.2226022261 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.2226222263 - `end_block_index: number`2226422265 Exclusive 0-based end index of the cited block range in the source's `content` array.2226622267 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2226822269 - `search_result_index: number`2227022271 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.2227222273 Counted separately from `document_index`; server-side web search results are not included in this count.2227422275 minimum: 02227622277 - `source: string`2227822279 - `start_block_index: number`2228022281 0-based index of the first cited block in the source's `content` array.2228222283 minimum: 02228422285 - `title: string or null`2228622287### Text Delta2228822289- `TextDelta object`2229022291 - `type: "text_delta"`2229222293 default: text_delta2229422295 - `text: string`2229622297### Text Editor Code Execution Create Result Block2229822299- `TextEditorCodeExecutionCreateResultBlock object`2230022301 - `type: "text_editor_code_execution_create_result"`2230222303 default: text_editor_code_execution_create_result2230422305 - `is_file_update: boolean`2230622307### Text Editor Code Execution Create Result Block Param2230822309- `TextEditorCodeExecutionCreateResultBlockParam object`2231022311 - `type: "text_editor_code_execution_create_result"`2231222313 - `is_file_update: boolean`2231422315### Text Editor Code Execution Str Replace Result Block2231622317- `TextEditorCodeExecutionStrReplaceResultBlock object`2231822319 - `type: "text_editor_code_execution_str_replace_result"`2232022321 default: text_editor_code_execution_str_replace_result2232222323 - `lines: array of string or null`2232422325 - `new_lines: number or null`2232622327 - `new_start: number or null`2232822329 - `old_lines: number or null`2233022331 - `old_start: number or null`2233222333### Text Editor Code Execution Str Replace Result Block Param2233422335- `TextEditorCodeExecutionStrReplaceResultBlockParam object`2233622337 - `type: "text_editor_code_execution_str_replace_result"`2233822339 - `lines: optional array of string or null`2234022341 - `new_lines: optional number or null`2234222343 - `new_start: optional number or null`2234422345 - `old_lines: optional number or null`2234622347 - `old_start: optional number or null`2234822349### Text Editor Code Execution Tool Result Block2235022351- `TextEditorCodeExecutionToolResultBlock object`2235222353 - `type: "text_editor_code_execution_tool_result"`2235422355 default: text_editor_code_execution_tool_result2235622357 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`2235822359 - `TextEditorCodeExecutionToolResultError object`2236022361 - `type: "text_editor_code_execution_tool_result_error"`2236222363 default: text_editor_code_execution_tool_result_error2236422365 - `error_code: TextEditorCodeExecutionToolResultErrorCode`2236622367 - `"invalid_tool_input"`2236822369 - `"unavailable"`2237022371 - `"too_many_requests"`2237222373 - `"execution_time_exceeded"`2237422375 - `"file_not_found"`2237622377 - `error_message: string or null`2237822379 - `TextEditorCodeExecutionViewResultBlock object`2238022381 - `type: "text_editor_code_execution_view_result"`2238222383 default: text_editor_code_execution_view_result2238422385 - `content: string`2238622387 - `file_type: "text" or "image" or "pdf"`2238822389 - `"text"`2239022391 - `"image"`2239222393 - `"pdf"`2239422395 - `num_lines: number or null`2239622397 - `start_line: number or null`2239822399 - `total_lines: number or null`2240022401 - `TextEditorCodeExecutionCreateResultBlock object`2240222403 - `type: "text_editor_code_execution_create_result"`2240422405 default: text_editor_code_execution_create_result2240622407 - `is_file_update: boolean`2240822409 - `TextEditorCodeExecutionStrReplaceResultBlock object`2241022411 - `type: "text_editor_code_execution_str_replace_result"`2241222413 default: text_editor_code_execution_str_replace_result2241422415 - `lines: array of string or null`2241622417 - `new_lines: number or null`2241822419 - `new_start: number or null`2242022421 - `old_lines: number or null`2242222423 - `old_start: number or null`2242422425 - `tool_use_id: string`2242622427 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2242822429### Text Editor Code Execution Tool Result Block Param2243022431- `TextEditorCodeExecutionToolResultBlockParam object`2243222433 - `type: "text_editor_code_execution_tool_result"`2243422435 - `content: TextEditorCodeExecutionToolResultErrorParam or TextEditorCodeExecutionViewResultBlockParam or TextEditorCodeExecutionCreateResultBlockParam or TextEditorCodeExecutionStrReplaceResultBlockParam`2243622437 - `TextEditorCodeExecutionToolResultErrorParam object`2243822439 - `type: "text_editor_code_execution_tool_result_error"`2244022441 - `error_code: TextEditorCodeExecutionToolResultErrorCode`2244222443 - `"invalid_tool_input"`2244422445 - `"unavailable"`2244622447 - `"too_many_requests"`2244822449 - `"execution_time_exceeded"`2245022451 - `"file_not_found"`2245222453 - `error_message: optional string or null`2245422455 - `TextEditorCodeExecutionViewResultBlockParam object`2245622457 - `type: "text_editor_code_execution_view_result"`2245822459 - `content: string`2246022461 - `file_type: "text" or "image" or "pdf"`2246222463 - `"text"`2246422465 - `"image"`2246622467 - `"pdf"`2246822469 - `num_lines: optional number or null`2247022471 - `start_line: optional number or null`2247222473 - `total_lines: optional number or null`2247422475 - `TextEditorCodeExecutionCreateResultBlockParam object`2247622477 - `type: "text_editor_code_execution_create_result"`2247822479 - `is_file_update: boolean`2248022481 - `TextEditorCodeExecutionStrReplaceResultBlockParam object`2248222483 - `type: "text_editor_code_execution_str_replace_result"`2248422485 - `lines: optional array of string or null`2248622487 - `new_lines: optional number or null`2248822489 - `new_start: optional number or null`2249022491 - `old_lines: optional number or null`2249222493 - `old_start: optional number or null`2249422495 - `tool_use_id: string`2249622497 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2249822499 - `cache_control: optional CacheControlEphemeral or null`2250022501 Create a cache control breakpoint at this content block.2250222503 - `type: "ephemeral"`2250422505 - `ttl: optional "5m" or "1h"`2250622507 The time-to-live for the cache control breakpoint.2250822509 This may be one the following values:2251022511 - `5m`: 5 minutes22512 - `1h`: 1 hour2251322514 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2251522516 - `"5m"`2251722518 - `"1h"`2251922520### Text Editor Code Execution Tool Result Error2252122522- `TextEditorCodeExecutionToolResultError object`2252322524 - `type: "text_editor_code_execution_tool_result_error"`2252522526 default: text_editor_code_execution_tool_result_error2252722528 - `error_code: TextEditorCodeExecutionToolResultErrorCode`2252922530 - `"invalid_tool_input"`2253122532 - `"unavailable"`2253322534 - `"too_many_requests"`2253522536 - `"execution_time_exceeded"`2253722538 - `"file_not_found"`2253922540 - `error_message: string or null`2254122542### Text Editor Code Execution Tool Result Error Code2254322544- `TextEditorCodeExecutionToolResultErrorCode = "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more`2254522546 - `"invalid_tool_input"`2254722548 - `"unavailable"`2254922550 - `"too_many_requests"`2255122552 - `"execution_time_exceeded"`2255322554 - `"file_not_found"`2255522556### Text Editor Code Execution Tool Result Error Param2255722558- `TextEditorCodeExecutionToolResultErrorParam object`2255922560 - `type: "text_editor_code_execution_tool_result_error"`2256122562 - `error_code: TextEditorCodeExecutionToolResultErrorCode`2256322564 - `"invalid_tool_input"`2256522566 - `"unavailable"`2256722568 - `"too_many_requests"`2256922570 - `"execution_time_exceeded"`2257122572 - `"file_not_found"`2257322574 - `error_message: optional string or null`2257522576### Text Editor Code Execution View Result Block2257722578- `TextEditorCodeExecutionViewResultBlock object`2257922580 - `type: "text_editor_code_execution_view_result"`2258122582 default: text_editor_code_execution_view_result2258322584 - `content: string`2258522586 - `file_type: "text" or "image" or "pdf"`2258722588 - `"text"`2258922590 - `"image"`2259122592 - `"pdf"`2259322594 - `num_lines: number or null`2259522596 - `start_line: number or null`2259722598 - `total_lines: number or null`2259922600### Text Editor Code Execution View Result Block Param2260122602- `TextEditorCodeExecutionViewResultBlockParam object`2260322604 - `type: "text_editor_code_execution_view_result"`2260522606 - `content: string`2260722608 - `file_type: "text" or "image" or "pdf"`2260922610 - `"text"`2261122612 - `"image"`2261322614 - `"pdf"`2261522616 - `num_lines: optional number or null`2261722618 - `start_line: optional number or null`2261922620 - `total_lines: optional number or null`2262122622### Thinking Block2262322624- `ThinkingBlock object`2262522626 - `type: "thinking"`2262722628 default: thinking2262922630 - `signature: string`2263122632 A value used to verify that this thinking block was generated by Claude when it is passed back to the API.2263322634 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.2263522636 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.2263722638 - `thinking: string`2263922640 The text of Claude's thinking process for this block.2264122642### Thinking Block Param2264322644- `ThinkingBlockParam object`2264522646 - `type: "thinking"`2264722648 - `signature: string`2264922650 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.2265122652 Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`.2265322654 - `thinking: string`2265522656 The `thinking` text of this block as returned by the API.2265722658### Thinking Config Adaptive2265922660- `ThinkingConfigAdaptive object`2266122662 - `type: "adaptive"`2266322664 - `display: optional "summarized" or "omitted" or null`2266522666 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`.2266722668 - `"summarized"`2266922670 - `"omitted"`2267122672### Thinking Config Disabled2267322674- `ThinkingConfigDisabled object`2267522676 - `type: "disabled"`2267722678### Thinking Config Enabled2267922680- `ThinkingConfigEnabled object`2268122682 - `type: "enabled"`2268322684 - `budget_tokens: number`2268522686 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.2268722688 Must be ≥1024 and less than `max_tokens`.2268922690 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.2269122692 minimum: 10242269322694 - `display: optional "summarized" or "omitted" or null`2269522696 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`.2269722698 - `"summarized"`2269922700 - `"omitted"`2270122702### Thinking Config Param2270322704- `ThinkingConfigParam = ThinkingConfigEnabled or ThinkingConfigDisabled or ThinkingConfigAdaptive`2270522706 Configuration for enabling Claude's extended thinking.2270722708 When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit.2270922710 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.2271122712 - `ThinkingConfigEnabled object`2271322714 - `type: "enabled"`2271522716 - `budget_tokens: number`2271722718 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.2271922720 Must be ≥1024 and less than `max_tokens`.2272122722 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.2272322724 minimum: 10242272522726 - `display: optional "summarized" or "omitted" or null`2272722728 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`.2272922730 - `"summarized"`2273122732 - `"omitted"`2273322734 - `ThinkingConfigDisabled object`2273522736 - `type: "disabled"`2273722738 - `ThinkingConfigAdaptive object`2273922740 - `type: "adaptive"`2274122742 - `display: optional "summarized" or "omitted" or null`2274322744 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`.2274522746 - `"summarized"`2274722748 - `"omitted"`2274922750### Thinking Delta2275122752- `ThinkingDelta object`2275322754 - `type: "thinking_delta"`2275522756 default: thinking_delta2275722758 - `thinking: string`2275922760 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.2276122762### Tool2276322764- `Tool object`2276522766 - `type: optional "custom" or null`2276722768 - `input_schema: object`2276922770 [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.2277122772 This defines the shape of the `input` that your tool accepts and that the model will produce.2277322774 - `type: "object"`2277522776 - `properties: optional map[unknown] or null`2277722778 - `required: optional array of string or null`2277922780 - `name: string`2278122782 Name of the tool.2278322784 This is how the tool will be called by the model and in `tool_use` blocks.2278522786 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$2278722788 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2278922790 - `"direct"`2279122792 - `"code_execution_20250825"`2279322794 - `"code_execution_20260120"`2279522796 - `"code_execution_20260521"`2279722798 - `cache_control: optional CacheControlEphemeral or null`2279922800 Create a cache control breakpoint at this content block.2280122802 - `type: "ephemeral"`2280322804 - `ttl: optional "5m" or "1h"`2280522806 The time-to-live for the cache control breakpoint.2280722808 This may be one the following values:2280922810 - `5m`: 5 minutes22811 - `1h`: 1 hour2281222813 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2281422815 - `"5m"`2281622817 - `"1h"`2281822819 - `defer_loading: optional boolean`2282022821 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2282222823 - `description: optional string`2282422825 Description of what this tool does.2282622827 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.2282822829 - `eager_input_streaming: optional boolean or null`2283022831 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.2283222833 - `input_examples: optional array of map[unknown]`2283422835 - `strict: optional boolean`2283622837 When true, guarantees schema validation on tool names and inputs2283822839### Tool Bash 202501242284022841- `ToolBash20250124 object`2284222843 - `type: "bash_20250124"`2284422845 - `name: "bash"`2284622847 Name of the tool.2284822849 This is how the tool will be called by the model and in `tool_use` blocks.2285022851 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2285222853 - `"direct"`2285422855 - `"code_execution_20250825"`2285622857 - `"code_execution_20260120"`2285822859 - `"code_execution_20260521"`2286022861 - `cache_control: optional CacheControlEphemeral or null`2286222863 Create a cache control breakpoint at this content block.2286422865 - `type: "ephemeral"`2286622867 - `ttl: optional "5m" or "1h"`2286822869 The time-to-live for the cache control breakpoint.2287022871 This may be one the following values:2287222873 - `5m`: 5 minutes22874 - `1h`: 1 hour2287522876 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2287722878 - `"5m"`2287922880 - `"1h"`2288122882 - `defer_loading: optional boolean`2288322884 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2288522886 - `input_examples: optional array of map[unknown]`2288722888 - `strict: optional boolean`2288922890 When true, guarantees schema validation on tool names and inputs2289122892### Tool Choice2289322894- `ToolChoice = ToolChoiceAuto or ToolChoiceAny or ToolChoiceTool or ToolChoiceNone`2289522896 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.2289722898 - `ToolChoiceAuto object`2289922900 The model will automatically decide whether to use tools.2290122902 - `type: "auto"`2290322904 - `disable_parallel_tool_use: optional boolean`2290522906 Whether to disable parallel tool use.2290722908 Defaults to `false`. If set to `true`, the model will output at most one tool use.2290922910 - `ToolChoiceAny object`2291122912 The model will use any available tools.2291322914 - `type: "any"`2291522916 - `disable_parallel_tool_use: optional boolean`2291722918 Whether to disable parallel tool use.2291922920 Defaults to `false`. If set to `true`, the model will output exactly one tool use.2292122922 - `ToolChoiceTool object`2292322924 The model will use the specified tool with `tool_choice.name`.2292522926 - `type: "tool"`2292722928 - `name: string`2292922930 The name of the tool to use.2293122932 - `disable_parallel_tool_use: optional boolean`2293322934 Whether to disable parallel tool use.2293522936 Defaults to `false`. If set to `true`, the model will output exactly one tool use.2293722938 - `ToolChoiceNone object`2293922940 The model will not be allowed to use tools.2294122942 - `type: "none"`2294322944### Tool Choice Any2294522946- `ToolChoiceAny object`2294722948 The model will use any available tools.2294922950 - `type: "any"`2295122952 - `disable_parallel_tool_use: optional boolean`2295322954 Whether to disable parallel tool use.2295522956 Defaults to `false`. If set to `true`, the model will output exactly one tool use.2295722958### Tool Choice Auto2295922960- `ToolChoiceAuto object`2296122962 The model will automatically decide whether to use tools.2296322964 - `type: "auto"`2296522966 - `disable_parallel_tool_use: optional boolean`2296722968 Whether to disable parallel tool use.2296922970 Defaults to `false`. If set to `true`, the model will output at most one tool use.2297122972### Tool Choice None2297322974- `ToolChoiceNone object`2297522976 The model will not be allowed to use tools.2297722978 - `type: "none"`2297922980### Tool Choice Tool2298122982- `ToolChoiceTool object`2298322984 The model will use the specified tool with `tool_choice.name`.2298522986 - `type: "tool"`2298722988 - `name: string`2298922990 The name of the tool to use.2299122992 - `disable_parallel_tool_use: optional boolean`2299322994 Whether to disable parallel tool use.2299522996 Defaults to `false`. If set to `true`, the model will output exactly one tool use.2299722998### Tool Reference Block2299923000- `ToolReferenceBlock object`2300123002 - `type: "tool_reference"`2300323004 default: tool_reference2300523006 - `tool_name: string`2300723008 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$2300923010### Tool Reference Block Param2301123012- `ToolReferenceBlockParam object`2301323014 Tool reference block that can be included in tool_result content.2301523016 - `type: "tool_reference"`2301723018 - `tool_name: string`2301923020 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$2302123022 - `cache_control: optional CacheControlEphemeral or null`2302323024 Create a cache control breakpoint at this content block.2302523026 - `type: "ephemeral"`2302723028 - `ttl: optional "5m" or "1h"`2302923030 The time-to-live for the cache control breakpoint.2303123032 This may be one the following values:2303323034 - `5m`: 5 minutes23035 - `1h`: 1 hour2303623037 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2303823039 - `"5m"`2304023041 - `"1h"`2304223043### Tool Result Block Param2304423045- `ToolResultBlockParam object`2304623047 - `type: "tool_result"`2304823049 - `tool_use_id: string`2305023051 pattern: ^[a-zA-Z0-9_-]+$2305223053 - `cache_control: optional CacheControlEphemeral or null`2305423055 Create a cache control breakpoint at this content block.2305623057 - `type: "ephemeral"`2305823059 - `ttl: optional "5m" or "1h"`2306023061 The time-to-live for the cache control breakpoint.2306223063 This may be one the following values:2306423065 - `5m`: 5 minutes23066 - `1h`: 1 hour2306723068 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2306923070 - `"5m"`2307123072 - `"1h"`2307323074 - `content: optional string or array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 3 more`2307523076 - `string`2307723078 - `array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 3 more`2307923080 - `TextBlockParam object`2308123082 - `type: "text"`2308323084 - `text: string`2308523086 minLength: 12308723088 - `cache_control: optional CacheControlEphemeral or null`2308923090 Create a cache control breakpoint at this content block.2309123092 - `citations: optional array of TextCitationParam or null`2309323094 - `CitationCharLocationParam object`2309523096 - `type: "char_location"`2309723098 - `cited_text: string`2309923100 - `document_index: number`2310123102 minimum: 02310323104 - `document_title: string or null`2310523106 maxLength: 500, minLength: 12310723108 - `end_char_index: number`2310923110 - `start_char_index: number`2311123112 minimum: 02311323114 - `CitationPageLocationParam object`2311523116 - `type: "page_location"`2311723118 - `cited_text: string`2311923120 - `document_index: number`2312123122 minimum: 02312323124 - `document_title: string or null`2312523126 maxLength: 500, minLength: 12312723128 - `end_page_number: number`2312923130 - `start_page_number: number`2313123132 minimum: 12313323134 - `CitationContentBlockLocationParam object`2313523136 - `type: "content_block_location"`2313723138 - `cited_text: string`2313923140 The full text of the cited block range, concatenated.2314123142 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.2314323144 - `document_index: number`2314523146 minimum: 02314723148 - `document_title: string or null`2314923150 maxLength: 500, minLength: 12315123152 - `end_block_index: number`2315323154 Exclusive 0-based end index of the cited block range in the source's `content` array.2315523156 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2315723158 - `start_block_index: number`2315923160 0-based index of the first cited block in the source's `content` array.2316123162 minimum: 02316323164 - `CitationWebSearchResultLocationParam object`2316523166 - `type: "web_search_result_location"`2316723168 - `cited_text: string`2316923170 - `encrypted_index: string`2317123172 - `title: string or null`2317323174 maxLength: 512, minLength: 12317523176 - `url: string`2317723178 minLength: 12317923180 - `CitationSearchResultLocationParam object`2318123182 - `type: "search_result_location"`2318323184 - `cited_text: string`2318523186 The full text of the cited block range, concatenated.2318723188 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.2318923190 - `end_block_index: number`2319123192 Exclusive 0-based end index of the cited block range in the source's `content` array.2319323194 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2319523196 - `search_result_index: number`2319723198 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.2319923200 Counted separately from `document_index`; server-side web search results are not included in this count.2320123202 minimum: 02320323204 - `source: string`2320523206 - `start_block_index: number`2320723208 0-based index of the first cited block in the source's `content` array.2320923210 minimum: 02321123212 - `title: string or null`2321323214 - `ImageBlockParam object`2321523216 - `type: "image"`2321723218 - `source: Base64ImageSource or URLImageSource or FileImageSource`2321923220 - `Base64ImageSource object`2322123222 - `type: "base64"`2322323224 - `data: string`2322523226 format: byte2322723228 - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"`2322923230 - `"image/jpeg"`2323123232 - `"image/png"`2323323234 - `"image/gif"`2323523236 - `"image/webp"`2323723238 - `URLImageSource object`2323923240 - `type: "url"`2324123242 - `url: string`2324323244 - `FileImageSource object`2324523246 - `type: "file"`2324723248 - `file_id: string`2324923250 - `cache_control: optional CacheControlEphemeral or null`2325123252 Create a cache control breakpoint at this content block.2325323254 - `transformations: optional ImageTransformationsParam or null`2325523256 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.2325723258 - `oversized_image: optional "downsize" or "error"`2325923260 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.2326123262 - `"downsize"`2326323264 - `"error"`2326523266 - `SearchResultBlockParam object`2326723268 - `type: "search_result"`2326923270 - `content: array of TextBlockParam`2327123272 - `type: "text"`2327323274 - `text: string`2327523276 minLength: 12327723278 - `cache_control: optional CacheControlEphemeral or null`2327923280 Create a cache control breakpoint at this content block.2328123282 - `citations: optional array of TextCitationParam or null`2328323284 - `source: string`2328523286 - `title: string`2328723288 - `cache_control: optional CacheControlEphemeral or null`2328923290 Create a cache control breakpoint at this content block.2329123292 - `citations: optional CitationsConfigParam`2329323294 - `enabled: optional boolean`2329523296 - `DocumentBlockParam object`2329723298 - `type: "document"`2329923300 - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more`2330123302 - `Base64PDFSource object`2330323304 - `type: "base64"`2330523306 - `data: string`2330723308 format: byte2330923310 - `media_type: "application/pdf"`2331123312 - `PlainTextSource object`2331323314 - `type: "text"`2331523316 - `data: string`2331723318 - `media_type: "text/plain"`2331923320 - `ContentBlockSource object`2332123322 - `type: "content"`2332323324 - `content: string or array of ContentBlockSourceContent`2332523326 - `string`2332723328 - `ContentBlockSourceContent = array of ContentBlockSourceContent`2332923330 - `TextBlockParam object`2333123332 - `ImageBlockParam object`2333323334 - `URLPDFSource object`2333523336 - `type: "url"`2333723338 - `url: string`2333923340 - `FileDocumentSource object`2334123342 - `type: "file"`2334323344 - `file_id: string`2334523346 - `cache_control: optional CacheControlEphemeral or null`2334723348 Create a cache control breakpoint at this content block.2334923350 - `citations: optional CitationsConfigParam or null`2335123352 - `context: optional string or null`2335323354 minLength: 12335523356 - `title: optional string or null`2335723358 maxLength: 500, minLength: 12335923360 - `ToolReferenceBlockParam object`2336123362 Tool reference block that can be included in tool_result content.2336323364 - `type: "tool_reference"`2336523366 - `tool_name: string`2336723368 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$2336923370 - `cache_control: optional CacheControlEphemeral or null`2337123372 Create a cache control breakpoint at this content block.2337323374 - `BrowserStateBlockParam object`2337523376 The caller's browser state after a browser toolset member call —23377 the full inventory of open tabs, which tab is active, and any side23378 effects (tabs opened, download state changes) the call produced.2337923380 At most one per `tool_result`, only on a non-error result answering a23381 browser toolset member `tool_use`. The server renders the23382 model-visible text from it; the model never sees the raw fields.2338323384 - `type: "browser_state"`2338523386 - `tabs: array of BrowserStateTabEntry`2338723388 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`.2338923390 maxItems: 1002339123392 - `tab_id: string`2339323394 The caller-assigned identifier for this tab, unique within the inventory.2339523396 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2339723398 - `title: string`2339923400 The title of the page the tab is showing. May be empty.2340123402 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2340323404 - `url: string`2340523406 The URL of the page the tab is showing. May be empty.2340723408 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2340923410 - `active: optional boolean`2341123412 Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.2341323414 - `cache_control: optional CacheControlEphemeral or null`2341523416 Create a cache control breakpoint at this content block.2341723418 - `state_changes: optional array of BrowserStateChange or null`2341923420 Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list.2342123422 maxItems: 200, minItems: 12342323424 - `BrowserStateChangeTabOpened object`2342523426 A tab this call's execution opened that remains open at its end —23427 the creation delta of the `tabs` inventory, not an event log.2342823429 Carries only the `tab_id`; the tab's `title` and `url` live on its23430 `tabs` entry, which must include the same `tab_id`. A tab opened23431 during a failed call gets no deferred `tab_opened`; it simply appears23432 in the next result's `tabs` inventory.2343323434 - `type: "tab_opened"`2343523436 - `tab_id: string`2343723438 The `tab_id` of the opened tab, present in `tabs`.2343923440 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2344123442 - `BrowserStateChangeDownloadStarted object`2344323444 A file download that started during this call.2344523446 - `type: "download_started"`2344723448 - `download_id: string`2344923450 The caller-assigned identifier for this download, stable across the state changes reporting it.2345123452 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2345323454 - `url: string`2345523456 The final post-redirect URL the download was served from.2345723458 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2345923460 - `BrowserStateChangeDownloadCompleted object`2346123462 A file download that finished during this call, reported with the23463 same `download_id` as its `download_started` — or without a prior23464 `download_started`, when the download finished during the call that23465 started it (at most one state change per `download_id` per result).2346623467 - `type: "download_completed"`2346823469 - `download_id: string`2347023471 The caller-assigned identifier for this download, stable across the state changes reporting it.2347223473 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2347423475 - `url: string`2347623477 The final post-redirect URL the download was served from.2347823479 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2348023481 - `path: optional string or null`2348223483 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.2348423485 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 40962348623487 - `size_bytes: optional number or null`2348823489 The completed download's size.2349023491 minimum: 02349223493 - `BrowserStateChangeDownloadFailed object`2349423495 A file download that failed — or was cancelled — during this call.2349623497 - `type: "download_failed"`2349823499 - `download_id: string`2350023501 The caller-assigned identifier for this download, stable across the state changes reporting it.2350223503 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2350423505 - `url: string`2350623507 The final post-redirect URL the download was served from.2350823509 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2351023511 - `error: optional string or null`2351223513 The failure or cancellation detail, when known.2351423515 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 40962351623517 - `is_error: optional boolean`2351823519 - `toolset_name: optional string or null`2352023521 For a toolset member tool_result, the toolset family of the paired tool_use.2352223523 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$2352423525### Tool Search Tool Bm25 202511192352623527- `ToolSearchToolBm25_20251119 object`2352823529 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`2353023531 - `"tool_search_tool_bm25_20251119"`2353223533 - `"tool_search_tool_bm25"`2353423535 - `name: "tool_search_tool_bm25"`2353623537 Name of the tool.2353823539 This is how the tool will be called by the model and in `tool_use` blocks.2354023541 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2354223543 - `"direct"`2354423545 - `"code_execution_20250825"`2354623547 - `"code_execution_20260120"`2354823549 - `"code_execution_20260521"`2355023551 - `cache_control: optional CacheControlEphemeral or null`2355223553 Create a cache control breakpoint at this content block.2355423555 - `type: "ephemeral"`2355623557 - `ttl: optional "5m" or "1h"`2355823559 The time-to-live for the cache control breakpoint.2356023561 This may be one the following values:2356223563 - `5m`: 5 minutes23564 - `1h`: 1 hour2356523566 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2356723568 - `"5m"`2356923570 - `"1h"`2357123572 - `defer_loading: optional boolean`2357323574 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2357523576 - `strict: optional boolean`2357723578 When true, guarantees schema validation on tool names and inputs2357923580### Tool Search Tool Regex 202511192358123582- `ToolSearchToolRegex20251119 object`2358323584 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`2358523586 - `"tool_search_tool_regex_20251119"`2358723588 - `"tool_search_tool_regex"`2358923590 - `name: "tool_search_tool_regex"`2359123592 Name of the tool.2359323594 This is how the tool will be called by the model and in `tool_use` blocks.2359523596 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2359723598 - `"direct"`2359923600 - `"code_execution_20250825"`2360123602 - `"code_execution_20260120"`2360323604 - `"code_execution_20260521"`2360523606 - `cache_control: optional CacheControlEphemeral or null`2360723608 Create a cache control breakpoint at this content block.2360923610 - `type: "ephemeral"`2361123612 - `ttl: optional "5m" or "1h"`2361323614 The time-to-live for the cache control breakpoint.2361523616 This may be one the following values:2361723618 - `5m`: 5 minutes23619 - `1h`: 1 hour2362023621 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2362223623 - `"5m"`2362423625 - `"1h"`2362623627 - `defer_loading: optional boolean`2362823629 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2363023631 - `strict: optional boolean`2363223633 When true, guarantees schema validation on tool names and inputs2363423635### Tool Search Tool Result Block2363623637- `ToolSearchToolResultBlock object`2363823639 - `type: "tool_search_tool_result"`2364023641 default: tool_search_tool_result2364223643 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`2364423645 - `ToolSearchToolResultError object`2364623647 - `type: "tool_search_tool_result_error"`2364823649 default: tool_search_tool_result_error2365023651 - `error_code: ToolSearchToolResultErrorCode`2365223653 - `"invalid_tool_input"`2365423655 - `"unavailable"`2365623657 - `"too_many_requests"`2365823659 - `"execution_time_exceeded"`2366023661 - `error_message: string or null`2366223663 - `ToolSearchToolSearchResultBlock object`2366423665 - `type: "tool_search_tool_search_result"`2366623667 default: tool_search_tool_search_result2366823669 - `tool_references: array of ToolReferenceBlock`2367023671 - `type: "tool_reference"`2367223673 default: tool_reference2367423675 - `tool_name: string`2367623677 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$2367823679 - `tool_use_id: string`2368023681 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2368223683### Tool Search Tool Result Block Param2368423685- `ToolSearchToolResultBlockParam object`2368623687 - `type: "tool_search_tool_result"`2368823689 - `content: ToolSearchToolResultErrorParam or ToolSearchToolSearchResultBlockParam`2369023691 - `ToolSearchToolResultErrorParam object`2369223693 - `type: "tool_search_tool_result_error"`2369423695 - `error_code: ToolSearchToolResultErrorCode`2369623697 - `"invalid_tool_input"`2369823699 - `"unavailable"`2370023701 - `"too_many_requests"`2370223703 - `"execution_time_exceeded"`2370423705 - `error_message: optional string or null`2370623707 - `ToolSearchToolSearchResultBlockParam object`2370823709 - `type: "tool_search_tool_search_result"`2371023711 - `tool_references: array of ToolReferenceBlockParam`2371223713 - `type: "tool_reference"`2371423715 - `tool_name: string`2371623717 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$2371823719 - `cache_control: optional CacheControlEphemeral or null`2372023721 Create a cache control breakpoint at this content block.2372223723 - `type: "ephemeral"`2372423725 - `ttl: optional "5m" or "1h"`2372623727 The time-to-live for the cache control breakpoint.2372823729 This may be one the following values:2373023731 - `5m`: 5 minutes23732 - `1h`: 1 hour2373323734 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2373523736 - `"5m"`2373723738 - `"1h"`2373923740 - `tool_use_id: string`2374123742 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2374323744 - `cache_control: optional CacheControlEphemeral or null`2374523746 Create a cache control breakpoint at this content block.2374723748### Tool Search Tool Result Error2374923750- `ToolSearchToolResultError object`2375123752 - `type: "tool_search_tool_result_error"`2375323754 default: tool_search_tool_result_error2375523756 - `error_code: ToolSearchToolResultErrorCode`2375723758 - `"invalid_tool_input"`2375923760 - `"unavailable"`2376123762 - `"too_many_requests"`2376323764 - `"execution_time_exceeded"`2376523766 - `error_message: string or null`2376723768### Tool Search Tool Result Error Code2376923770- `ToolSearchToolResultErrorCode = "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"`2377123772 - `"invalid_tool_input"`2377323774 - `"unavailable"`2377523776 - `"too_many_requests"`2377723778 - `"execution_time_exceeded"`2377923780### Tool Search Tool Result Error Param2378123782- `ToolSearchToolResultErrorParam object`2378323784 - `type: "tool_search_tool_result_error"`2378523786 - `error_code: ToolSearchToolResultErrorCode`2378723788 - `"invalid_tool_input"`2378923790 - `"unavailable"`2379123792 - `"too_many_requests"`2379323794 - `"execution_time_exceeded"`2379523796 - `error_message: optional string or null`2379723798### Tool Search Tool Search Result Block2379923800- `ToolSearchToolSearchResultBlock object`2380123802 - `type: "tool_search_tool_search_result"`2380323804 default: tool_search_tool_search_result2380523806 - `tool_references: array of ToolReferenceBlock`2380723808 - `type: "tool_reference"`2380923810 default: tool_reference2381123812 - `tool_name: string`2381323814 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$2381523816### Tool Search Tool Search Result Block Param2381723818- `ToolSearchToolSearchResultBlockParam object`2381923820 - `type: "tool_search_tool_search_result"`2382123822 - `tool_references: array of ToolReferenceBlockParam`2382323824 - `type: "tool_reference"`2382523826 - `tool_name: string`2382723828 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$2382923830 - `cache_control: optional CacheControlEphemeral or null`2383123832 Create a cache control breakpoint at this content block.2383323834 - `type: "ephemeral"`2383523836 - `ttl: optional "5m" or "1h"`2383723838 The time-to-live for the cache control breakpoint.2383923840 This may be one the following values:2384123842 - `5m`: 5 minutes23843 - `1h`: 1 hour2384423845 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2384623847 - `"5m"`2384823849 - `"1h"`2385023851### Tool Text Editor 202501242385223853- `ToolTextEditor20250124 object`2385423855 - `type: "text_editor_20250124"`2385623857 - `name: "str_replace_editor"`2385823859 Name of the tool.2386023861 This is how the tool will be called by the model and in `tool_use` blocks.2386223863 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2386423865 - `"direct"`2386623867 - `"code_execution_20250825"`2386823869 - `"code_execution_20260120"`2387023871 - `"code_execution_20260521"`2387223873 - `cache_control: optional CacheControlEphemeral or null`2387423875 Create a cache control breakpoint at this content block.2387623877 - `type: "ephemeral"`2387823879 - `ttl: optional "5m" or "1h"`2388023881 The time-to-live for the cache control breakpoint.2388223883 This may be one the following values:2388423885 - `5m`: 5 minutes23886 - `1h`: 1 hour2388723888 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2388923890 - `"5m"`2389123892 - `"1h"`2389323894 - `defer_loading: optional boolean`2389523896 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2389723898 - `input_examples: optional array of map[unknown]`2389923900 - `strict: optional boolean`2390123902 When true, guarantees schema validation on tool names and inputs2390323904### Tool Text Editor 202504292390523906- `ToolTextEditor20250429 object`2390723908 - `type: "text_editor_20250429"`2390923910 - `name: "str_replace_based_edit_tool"`2391123912 Name of the tool.2391323914 This is how the tool will be called by the model and in `tool_use` blocks.2391523916 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2391723918 - `"direct"`2391923920 - `"code_execution_20250825"`2392123922 - `"code_execution_20260120"`2392323924 - `"code_execution_20260521"`2392523926 - `cache_control: optional CacheControlEphemeral or null`2392723928 Create a cache control breakpoint at this content block.2392923930 - `type: "ephemeral"`2393123932 - `ttl: optional "5m" or "1h"`2393323934 The time-to-live for the cache control breakpoint.2393523936 This may be one the following values:2393723938 - `5m`: 5 minutes23939 - `1h`: 1 hour2394023941 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2394223943 - `"5m"`2394423945 - `"1h"`2394623947 - `defer_loading: optional boolean`2394823949 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2395023951 - `input_examples: optional array of map[unknown]`2395223953 - `strict: optional boolean`2395423955 When true, guarantees schema validation on tool names and inputs2395623957### Tool Text Editor 202507282395823959- `ToolTextEditor20250728 object`2396023961 - `type: "text_editor_20250728"`2396223963 - `name: "str_replace_based_edit_tool"`2396423965 Name of the tool.2396623967 This is how the tool will be called by the model and in `tool_use` blocks.2396823969 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2397023971 - `"direct"`2397223973 - `"code_execution_20250825"`2397423975 - `"code_execution_20260120"`2397623977 - `"code_execution_20260521"`2397823979 - `cache_control: optional CacheControlEphemeral or null`2398023981 Create a cache control breakpoint at this content block.2398223983 - `type: "ephemeral"`2398423985 - `ttl: optional "5m" or "1h"`2398623987 The time-to-live for the cache control breakpoint.2398823989 This may be one the following values:2399023991 - `5m`: 5 minutes23992 - `1h`: 1 hour2399323994 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2399523996 - `"5m"`2399723998 - `"1h"`2399924000 - `defer_loading: optional boolean`2400124002 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2400324004 - `input_examples: optional array of map[unknown]`2400524006 - `max_characters: optional number or null`2400724008 Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.2400924010 minimum: 12401124012 - `strict: optional boolean`2401324014 When true, guarantees schema validation on tool names and inputs2401524016### Tool Union2401724018- `ToolUnion = Tool or ToolBash20250124 or CodeExecutionTool20250522 or 18 more`2401924020 - `Tool object`2402124022 - `type: optional "custom" or null`2402324024 - `input_schema: object`2402524026 [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.2402724028 This defines the shape of the `input` that your tool accepts and that the model will produce.2402924030 - `type: "object"`2403124032 - `properties: optional map[unknown] or null`2403324034 - `required: optional array of string or null`2403524036 - `name: string`2403724038 Name of the tool.2403924040 This is how the tool will be called by the model and in `tool_use` blocks.2404124042 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$2404324044 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2404524046 - `"direct"`2404724048 - `"code_execution_20250825"`2404924050 - `"code_execution_20260120"`2405124052 - `"code_execution_20260521"`2405324054 - `cache_control: optional CacheControlEphemeral or null`2405524056 Create a cache control breakpoint at this content block.2405724058 - `type: "ephemeral"`2405924060 - `ttl: optional "5m" or "1h"`2406124062 The time-to-live for the cache control breakpoint.2406324064 This may be one the following values:2406524066 - `5m`: 5 minutes24067 - `1h`: 1 hour2406824069 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2407024071 - `"5m"`2407224073 - `"1h"`2407424075 - `defer_loading: optional boolean`2407624077 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2407824079 - `description: optional string`2408024081 Description of what this tool does.2408224083 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.2408424085 - `eager_input_streaming: optional boolean or null`2408624087 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.2408824089 - `input_examples: optional array of map[unknown]`2409024091 - `strict: optional boolean`2409224093 When true, guarantees schema validation on tool names and inputs2409424095 - `ToolBash20250124 object`2409624097 - `type: "bash_20250124"`2409824099 - `name: "bash"`2410024101 Name of the tool.2410224103 This is how the tool will be called by the model and in `tool_use` blocks.2410424105 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2410624107 - `"direct"`2410824109 - `"code_execution_20250825"`2411024111 - `"code_execution_20260120"`2411224113 - `"code_execution_20260521"`2411424115 - `cache_control: optional CacheControlEphemeral or null`2411624117 Create a cache control breakpoint at this content block.2411824119 - `defer_loading: optional boolean`2412024121 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2412224123 - `input_examples: optional array of map[unknown]`2412424125 - `strict: optional boolean`2412624127 When true, guarantees schema validation on tool names and inputs2412824129 - `CodeExecutionTool20250522 object`2413024131 - `type: "code_execution_20250522"`2413224133 - `name: "code_execution"`2413424135 Name of the tool.2413624137 This is how the tool will be called by the model and in `tool_use` blocks.2413824139 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2414024141 - `"direct"`2414224143 - `"code_execution_20250825"`2414424145 - `"code_execution_20260120"`2414624147 - `"code_execution_20260521"`2414824149 - `cache_control: optional CacheControlEphemeral or null`2415024151 Create a cache control breakpoint at this content block.2415224153 - `defer_loading: optional boolean`2415424155 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2415624157 - `strict: optional boolean`2415824159 When true, guarantees schema validation on tool names and inputs2416024161 - `CodeExecutionTool20250825 object`2416224163 - `type: "code_execution_20250825"`2416424165 - `name: "code_execution"`2416624167 Name of the tool.2416824169 This is how the tool will be called by the model and in `tool_use` blocks.2417024171 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2417224173 - `"direct"`2417424175 - `"code_execution_20250825"`2417624177 - `"code_execution_20260120"`2417824179 - `"code_execution_20260521"`2418024181 - `cache_control: optional CacheControlEphemeral or null`2418224183 Create a cache control breakpoint at this content block.2418424185 - `defer_loading: optional boolean`2418624187 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2418824189 - `strict: optional boolean`2419024191 When true, guarantees schema validation on tool names and inputs2419224193 - `CodeExecutionTool20260120 object`2419424195 Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).2419624197 - `type: "code_execution_20260120"`2419824199 - `name: "code_execution"`2420024201 Name of the tool.2420224203 This is how the tool will be called by the model and in `tool_use` blocks.2420424205 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2420624207 - `"direct"`2420824209 - `"code_execution_20250825"`2421024211 - `"code_execution_20260120"`2421224213 - `"code_execution_20260521"`2421424215 - `cache_control: optional CacheControlEphemeral or null`2421624217 Create a cache control breakpoint at this content block.2421824219 - `defer_loading: optional boolean`2422024221 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2422224223 - `strict: optional boolean`2422424225 When true, guarantees schema validation on tool names and inputs2422624227 - `CodeExecutionTool20260521 object`2422824229 Code execution tool with REPL state persistence.2423024231 - `type: "code_execution_20260521"`2423224233 - `name: "code_execution"`2423424235 Name of the tool.2423624237 This is how the tool will be called by the model and in `tool_use` blocks.2423824239 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2424024241 - `"direct"`2424224243 - `"code_execution_20250825"`2424424245 - `"code_execution_20260120"`2424624247 - `"code_execution_20260521"`2424824249 - `cache_control: optional CacheControlEphemeral or null`2425024251 Create a cache control breakpoint at this content block.2425224253 - `defer_loading: optional boolean`2425424255 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2425624257 - `strict: optional boolean`2425824259 When true, guarantees schema validation on tool names and inputs2426024261 - `BrowserToolset20260801 object`2426224263 The browser toolset: a single `tools[]` entry (carrying no24264 `name`) that declares the browser tool family. The model is served24265 the family's tool with any members disabled via `configs` removed24266 from its schema.2426724268 - `type: "browser_toolset_20260801"`2426924270 - `cache_control: optional CacheControlEphemeral or null`2427124272 Create a cache control breakpoint at this content block.2427324274 - `configs: optional BrowserToolsetConfigs or null`2427524276 Per-member configuration for `browser_toolset_20260801`: one24277 optional field per member tool, keyed by the member name — the same24278 name the member's `tool_use` blocks carry. Every member is an24279 accepted key, and a member's defaults apply wherever its key is24280 absent. Unknown keys are rejected: the field set is this toolset24281 version's complete member set.2428224283 - `type: optional BrowserTypeConfig or null`2428424285 `type`'s config overrides.2428624287 - `defer_loading: optional boolean or null`2428824289 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2429024291 - `enabled: optional boolean or null`2429224293 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2429424295 - `close_tab: optional BrowserCloseTabConfig or null`2429624297 `close_tab`'s config overrides.2429824299 - `defer_loading: optional boolean or null`2430024301 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2430224303 - `enabled: optional boolean or null`2430424305 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2430624307 - `double_click: optional BrowserDoubleClickConfig or null`2430824309 `double_click`'s config overrides.2431024311 - `defer_loading: optional boolean or null`2431224313 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2431424315 - `enabled: optional boolean or null`2431624317 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2431824319 - `file_upload: optional BrowserFileUploadConfig or null`2432024321 `file_upload`'s config overrides.2432224323 - `defer_loading: optional boolean or null`2432424325 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2432624327 - `enabled: optional boolean or null`2432824329 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2433024331 - `find: optional BrowserFindConfig or null`2433224333 `find`'s config overrides.2433424335 - `defer_loading: optional boolean or null`2433624337 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2433824339 - `enabled: optional boolean or null`2434024341 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2434224343 - `form_input: optional BrowserFormInputConfig or null`2434424345 `form_input`'s config overrides.2434624347 - `defer_loading: optional boolean or null`2434824349 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2435024351 - `enabled: optional boolean or null`2435224353 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2435424355 - `get_page_text: optional BrowserGetPageTextConfig or null`2435624357 `get_page_text`'s config overrides.2435824359 - `defer_loading: optional boolean or null`2436024361 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2436224363 - `enabled: optional boolean or null`2436424365 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2436624367 - `hold_key: optional BrowserHoldKeyConfig or null`2436824369 `hold_key`'s config overrides.2437024371 - `defer_loading: optional boolean or null`2437224373 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2437424375 - `enabled: optional boolean or null`2437624377 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2437824379 - `hover: optional BrowserHoverConfig or null`2438024381 `hover`'s config overrides.2438224383 - `defer_loading: optional boolean or null`2438424385 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2438624387 - `enabled: optional boolean or null`2438824389 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2439024391 - `javascript_exec: optional BrowserJavascriptExecConfig or null`2439224393 `javascript_exec`'s config overrides.2439424395 - `defer_loading: optional boolean or null`2439624397 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2439824399 - `enabled: optional boolean or null`2440024401 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2440224403 - `key: optional BrowserKeyConfig or null`2440424405 `key`'s config overrides.2440624407 - `defer_loading: optional boolean or null`2440824409 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2441024411 - `enabled: optional boolean or null`2441224413 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2441424415 - `left_click: optional BrowserLeftClickConfig or null`2441624417 `left_click`'s config overrides.2441824419 - `defer_loading: optional boolean or null`2442024421 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2442224423 - `enabled: optional boolean or null`2442424425 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2442624427 - `left_click_drag: optional BrowserLeftClickDragConfig or null`2442824429 `left_click_drag`'s config overrides.2443024431 - `defer_loading: optional boolean or null`2443224433 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2443424435 - `enabled: optional boolean or null`2443624437 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2443824439 - `left_mouse_down: optional BrowserLeftMouseDownConfig or null`2444024441 `left_mouse_down`'s config overrides.2444224443 - `defer_loading: optional boolean or null`2444424445 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2444624447 - `enabled: optional boolean or null`2444824449 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2445024451 - `left_mouse_up: optional BrowserLeftMouseUpConfig or null`2445224453 `left_mouse_up`'s config overrides.2445424455 - `defer_loading: optional boolean or null`2445624457 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2445824459 - `enabled: optional boolean or null`2446024461 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2446224463 - `list_tabs: optional BrowserListTabsConfig or null`2446424465 `list_tabs`'s config overrides.2446624467 - `defer_loading: optional boolean or null`2446824469 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2447024471 - `enabled: optional boolean or null`2447224473 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2447424475 - `middle_click: optional BrowserMiddleClickConfig or null`2447624477 `middle_click`'s config overrides.2447824479 - `defer_loading: optional boolean or null`2448024481 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2448224483 - `enabled: optional boolean or null`2448424485 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2448624487 - `mouse_move: optional BrowserMouseMoveConfig or null`2448824489 `mouse_move`'s config overrides.2449024491 - `defer_loading: optional boolean or null`2449224493 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2449424495 - `enabled: optional boolean or null`2449624497 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2449824499 - `navigate: optional BrowserNavigateConfig or null`2450024501 `navigate`'s config overrides.2450224503 - `defer_loading: optional boolean or null`2450424505 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2450624507 - `enabled: optional boolean or null`2450824509 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2451024511 - `new_tab: optional BrowserNewTabConfig or null`2451224513 `new_tab`'s config overrides.2451424515 - `defer_loading: optional boolean or null`2451624517 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2451824519 - `enabled: optional boolean or null`2452024521 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2452224523 - `read_console: optional BrowserReadConsoleConfig or null`2452424525 `read_console`'s config overrides.2452624527 - `defer_loading: optional boolean or null`2452824529 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2453024531 - `enabled: optional boolean or null`2453224533 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2453424535 - `read_network: optional BrowserReadNetworkConfig or null`2453624537 `read_network`'s config overrides.2453824539 - `defer_loading: optional boolean or null`2454024541 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2454224543 - `enabled: optional boolean or null`2454424545 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2454624547 - `read_page: optional BrowserReadPageConfig or null`2454824549 `read_page`'s config overrides.2455024551 - `defer_loading: optional boolean or null`2455224553 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2455424555 - `enabled: optional boolean or null`2455624557 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2455824559 - `right_click: optional BrowserRightClickConfig or null`2456024561 `right_click`'s config overrides.2456224563 - `defer_loading: optional boolean or null`2456424565 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2456624567 - `enabled: optional boolean or null`2456824569 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2457024571 - `screenshot: optional BrowserScreenshotConfig or null`2457224573 `screenshot`'s config overrides.2457424575 - `defer_loading: optional boolean or null`2457624577 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2457824579 - `enabled: optional boolean or null`2458024581 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2458224583 - `scroll: optional BrowserScrollConfig or null`2458424585 `scroll`'s config overrides.2458624587 - `defer_loading: optional boolean or null`2458824589 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2459024591 - `enabled: optional boolean or null`2459224593 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2459424595 - `scroll_to: optional BrowserScrollToConfig or null`2459624597 `scroll_to`'s config overrides.2459824599 - `defer_loading: optional boolean or null`2460024601 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2460224603 - `enabled: optional boolean or null`2460424605 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2460624607 - `switch_tab: optional BrowserSwitchTabConfig or null`2460824609 `switch_tab`'s config overrides.2461024611 - `defer_loading: optional boolean or null`2461224613 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2461424615 - `enabled: optional boolean or null`2461624617 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2461824619 - `triple_click: optional BrowserTripleClickConfig or null`2462024621 `triple_click`'s config overrides.2462224623 - `defer_loading: optional boolean or null`2462424625 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2462624627 - `enabled: optional boolean or null`2462824629 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2463024631 - `wait: optional BrowserWaitConfig or null`2463224633 `wait`'s config overrides.2463424635 - `defer_loading: optional boolean or null`2463624637 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2463824639 - `enabled: optional boolean or null`2464024641 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2464224643 - `zoom: optional BrowserZoomConfig or null`2464424645 `zoom`'s config overrides.2464624647 - `defer_loading: optional boolean or null`2464824649 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2465024651 - `enabled: optional boolean or null`2465224653 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2465424655 - `MemoryTool20250818 object`2465624657 - `type: "memory_20250818"`2465824659 - `name: "memory"`2466024661 Name of the tool.2466224663 This is how the tool will be called by the model and in `tool_use` blocks.2466424665 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2466624667 - `"direct"`2466824669 - `"code_execution_20250825"`2467024671 - `"code_execution_20260120"`2467224673 - `"code_execution_20260521"`2467424675 - `cache_control: optional CacheControlEphemeral or null`2467624677 Create a cache control breakpoint at this content block.2467824679 - `defer_loading: optional boolean`2468024681 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2468224683 - `input_examples: optional array of map[unknown]`2468424685 - `strict: optional boolean`2468624687 When true, guarantees schema validation on tool names and inputs2468824689 - `ComputerToolset20260801 object`2469024691 The computer toolset: a single `tools[]` entry (carrying no24692 `name`) that declares the computer tool family. The model is24693 served the family's tool with any members disabled via `configs`24694 removed from its schema. Every member is enabled by default, zoom24695 included. The single-tool options `display_number` and24696 `enable_zoom` are not fields of a toolset entry — it carries only24697 `type`, `configs`, and `cache_control`; zoom is controlled24698 via `configs.zoom.enabled`.2469924700 - `type: "computer_toolset_20260801"`2470124702 - `cache_control: optional CacheControlEphemeral or null`2470324704 Create a cache control breakpoint at this content block.2470524706 - `configs: optional ComputerToolsetConfigs or null`2470724708 Per-member configuration for `computer_toolset_20260801`: one24709 optional field per member tool, keyed by the member name — the same24710 name the member's `tool_use` blocks carry. Every member is an24711 accepted key, and a member's defaults apply wherever its key is24712 absent. Unknown keys are rejected: the field set is this toolset24713 version's complete member set.2471424715 - `type: optional ComputerTypeConfig or null`2471624717 `type`'s config overrides.2471824719 - `defer_loading: optional boolean or null`2472024721 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2472224723 - `enabled: optional boolean or null`2472424725 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2472624727 - `cursor_position: optional ComputerCursorPositionConfig or null`2472824729 `cursor_position`'s config overrides.2473024731 - `defer_loading: optional boolean or null`2473224733 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2473424735 - `enabled: optional boolean or null`2473624737 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2473824739 - `double_click: optional ComputerDoubleClickConfig or null`2474024741 `double_click`'s config overrides.2474224743 - `defer_loading: optional boolean or null`2474424745 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2474624747 - `enabled: optional boolean or null`2474824749 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2475024751 - `hold_key: optional ComputerHoldKeyConfig or null`2475224753 `hold_key`'s config overrides.2475424755 - `defer_loading: optional boolean or null`2475624757 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2475824759 - `enabled: optional boolean or null`2476024761 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2476224763 - `key: optional ComputerKeyConfig or null`2476424765 `key`'s config overrides.2476624767 - `defer_loading: optional boolean or null`2476824769 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2477024771 - `enabled: optional boolean or null`2477224773 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2477424775 - `left_click: optional ComputerLeftClickConfig or null`2477624777 `left_click`'s config overrides.2477824779 - `defer_loading: optional boolean or null`2478024781 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2478224783 - `enabled: optional boolean or null`2478424785 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2478624787 - `left_click_drag: optional ComputerLeftClickDragConfig or null`2478824789 `left_click_drag`'s config overrides.2479024791 - `defer_loading: optional boolean or null`2479224793 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2479424795 - `enabled: optional boolean or null`2479624797 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2479824799 - `left_mouse_down: optional ComputerLeftMouseDownConfig or null`2480024801 `left_mouse_down`'s config overrides.2480224803 - `defer_loading: optional boolean or null`2480424805 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2480624807 - `enabled: optional boolean or null`2480824809 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2481024811 - `left_mouse_up: optional ComputerLeftMouseUpConfig or null`2481224813 `left_mouse_up`'s config overrides.2481424815 - `defer_loading: optional boolean or null`2481624817 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2481824819 - `enabled: optional boolean or null`2482024821 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2482224823 - `middle_click: optional ComputerMiddleClickConfig or null`2482424825 `middle_click`'s config overrides.2482624827 - `defer_loading: optional boolean or null`2482824829 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2483024831 - `enabled: optional boolean or null`2483224833 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2483424835 - `mouse_move: optional ComputerMouseMoveConfig or null`2483624837 `mouse_move`'s config overrides.2483824839 - `defer_loading: optional boolean or null`2484024841 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2484224843 - `enabled: optional boolean or null`2484424845 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2484624847 - `right_click: optional ComputerRightClickConfig or null`2484824849 `right_click`'s config overrides.2485024851 - `defer_loading: optional boolean or null`2485224853 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2485424855 - `enabled: optional boolean or null`2485624857 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2485824859 - `screenshot: optional ComputerScreenshotConfig or null`2486024861 `screenshot`'s config overrides.2486224863 - `defer_loading: optional boolean or null`2486424865 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2486624867 - `enabled: optional boolean or null`2486824869 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2487024871 - `scroll: optional ComputerScrollConfig or null`2487224873 `scroll`'s config overrides.2487424875 - `defer_loading: optional boolean or null`2487624877 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2487824879 - `enabled: optional boolean or null`2488024881 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2488224883 - `triple_click: optional ComputerTripleClickConfig or null`2488424885 `triple_click`'s config overrides.2488624887 - `defer_loading: optional boolean or null`2488824889 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2489024891 - `enabled: optional boolean or null`2489224893 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2489424895 - `wait: optional ComputerWaitConfig or null`2489624897 `wait`'s config overrides.2489824899 - `defer_loading: optional boolean or null`2490024901 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2490224903 - `enabled: optional boolean or null`2490424905 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2490624907 - `zoom: optional ComputerZoomConfig or null`2490824909 `zoom`'s config overrides.2491024911 - `defer_loading: optional boolean or null`2491224913 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2491424915 - `enabled: optional boolean or null`2491624917 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2491824919 - `ToolTextEditor20250124 object`2492024921 - `type: "text_editor_20250124"`2492224923 - `name: "str_replace_editor"`2492424925 Name of the tool.2492624927 This is how the tool will be called by the model and in `tool_use` blocks.2492824929 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2493024931 - `"direct"`2493224933 - `"code_execution_20250825"`2493424935 - `"code_execution_20260120"`2493624937 - `"code_execution_20260521"`2493824939 - `cache_control: optional CacheControlEphemeral or null`2494024941 Create a cache control breakpoint at this content block.2494224943 - `defer_loading: optional boolean`2494424945 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2494624947 - `input_examples: optional array of map[unknown]`2494824949 - `strict: optional boolean`2495024951 When true, guarantees schema validation on tool names and inputs2495224953 - `ToolTextEditor20250429 object`2495424955 - `type: "text_editor_20250429"`2495624957 - `name: "str_replace_based_edit_tool"`2495824959 Name of the tool.2496024961 This is how the tool will be called by the model and in `tool_use` blocks.2496224963 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2496424965 - `"direct"`2496624967 - `"code_execution_20250825"`2496824969 - `"code_execution_20260120"`2497024971 - `"code_execution_20260521"`2497224973 - `cache_control: optional CacheControlEphemeral or null`2497424975 Create a cache control breakpoint at this content block.2497624977 - `defer_loading: optional boolean`2497824979 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2498024981 - `input_examples: optional array of map[unknown]`2498224983 - `strict: optional boolean`2498424985 When true, guarantees schema validation on tool names and inputs2498624987 - `ToolTextEditor20250728 object`2498824989 - `type: "text_editor_20250728"`2499024991 - `name: "str_replace_based_edit_tool"`2499224993 Name of the tool.2499424995 This is how the tool will be called by the model and in `tool_use` blocks.2499624997 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2499824999 - `"direct"`2500025001 - `"code_execution_20250825"`2500225003 - `"code_execution_20260120"`2500425005 - `"code_execution_20260521"`2500625007 - `cache_control: optional CacheControlEphemeral or null`2500825009 Create a cache control breakpoint at this content block.2501025011 - `defer_loading: optional boolean`2501225013 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2501425015 - `input_examples: optional array of map[unknown]`2501625017 - `max_characters: optional number or null`2501825019 Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.2502025021 minimum: 12502225023 - `strict: optional boolean`2502425025 When true, guarantees schema validation on tool names and inputs2502625027 - `WebSearchTool20250305 object`2502825029 - `type: "web_search_20250305"`2503025031 - `name: "web_search"`2503225033 Name of the tool.2503425035 This is how the tool will be called by the model and in `tool_use` blocks.2503625037 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2503825039 - `"direct"`2504025041 - `"code_execution_20250825"`2504225043 - `"code_execution_20260120"`2504425045 - `"code_execution_20260521"`2504625047 - `allowed_domains: optional array of string or null`2504825049 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.2505025051 - `blocked_domains: optional array of string or null`2505225053 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.2505425055 - `cache_control: optional CacheControlEphemeral or null`2505625057 Create a cache control breakpoint at this content block.2505825059 - `defer_loading: optional boolean`2506025061 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2506225063 - `max_uses: optional number or null`2506425065 Maximum number of times the tool can be used in the API request.2506625067 exclusiveMinimum: 02506825069 - `strict: optional boolean`2507025071 When true, guarantees schema validation on tool names and inputs2507225073 - `user_location: optional UserLocation or null`2507425075 Parameters for the user's location. Used to provide more relevant search results.2507625077 - `type: "approximate"`2507825079 - `city: optional string or null`2508025081 The city of the user.2508225083 maxLength: 255, minLength: 12508425085 - `country: optional string or null`2508625087 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.2508825089 maxLength: 2, minLength: 22509025091 - `region: optional string or null`2509225093 The region of the user.2509425095 maxLength: 255, minLength: 12509625097 - `timezone: optional string or null`2509825099 The [IANA timezone](https://nodatime.org/TimeZones) of the user.2510025101 maxLength: 255, minLength: 12510225103 - `WebFetchTool20250910 object`2510425105 - `type: "web_fetch_20250910"`2510625107 - `name: "web_fetch"`2510825109 Name of the tool.2511025111 This is how the tool will be called by the model and in `tool_use` blocks.2511225113 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2511425115 - `"direct"`2511625117 - `"code_execution_20250825"`2511825119 - `"code_execution_20260120"`2512025121 - `"code_execution_20260521"`2512225123 - `allowed_domains: optional array of string or null`2512425125 List of domains to allow fetching from2512625127 - `blocked_domains: optional array of string or null`2512825129 List of domains to block fetching from2513025131 - `cache_control: optional CacheControlEphemeral or null`2513225133 Create a cache control breakpoint at this content block.2513425135 - `citations: optional CitationsConfigParam or null`2513625137 Citations configuration for fetched documents. Citations are disabled by default.2513825139 - `enabled: optional boolean`2514025141 - `defer_loading: optional boolean`2514225143 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2514425145 - `max_content_tokens: optional number or null`2514625147 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.2514825149 exclusiveMinimum: 02515025151 - `max_uses: optional number or null`2515225153 Maximum number of times the tool can be used in the API request.2515425155 exclusiveMinimum: 02515625157 - `strict: optional boolean`2515825159 When true, guarantees schema validation on tool names and inputs2516025161 - `url_sources: optional WebFetchURLSources or null`2516225163 Which sources contribute to the set of URLs web fetch may fetch.2516425165 Each key is a tagged variant: `user_input` is `all` or `none`; the25166 two tool filters are `all`, `none`, `only` (only the named tools'25167 results) or `except` (every result but the named tools'). A named tool25168 must be declared in this request's `tools[]`.2516925170 - `client_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`2517125172 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].2517325174 - `WebFetchURLSourceAll object`2517525176 The `url_sources` variant under which a source contributes in25177 full: every result of the tool filter's source, or all user input.2517825179 - `type: "all"`2518025181 - `WebFetchURLSourceNone object`2518225183 The `url_sources` variant under which a source contributes nothing:25184 no result of the tool filter's source, or no user input.2518525186 - `type: "none"`2518725188 - `WebFetchURLSourceOnly object`2518925190 The tool filter variant under which only the named tools' results25191 contribute.2519225193 - `type: "only"`2519425195 - `tools: array of WebFetchURLSourceToolReference`2519625197 - `type: "tool_reference"`2519825199 - `name: string`2520025201 - `WebFetchURLSourceExcept object`2520225203 The tool filter variant under which every result but the named25204 tools' contributes.2520525206 - `type: "except"`2520725208 - `tools: array of WebFetchURLSourceToolReference`2520925210 - `type: "tool_reference"`2521125212 - `name: string`2521325214 - `server_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`2521525216 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.2521725218 - `WebFetchURLSourceAll object`2521925220 The `url_sources` variant under which a source contributes in25221 full: every result of the tool filter's source, or all user input.2522225223 - `WebFetchURLSourceNone object`2522425225 The `url_sources` variant under which a source contributes nothing:25226 no result of the tool filter's source, or no user input.2522725228 - `WebFetchURLSourceOnly object`2522925230 The tool filter variant under which only the named tools' results25231 contribute.2523225233 - `WebFetchURLSourceExcept object`2523425235 The tool filter variant under which every result but the named25236 tools' contributes.2523725238 - `user_input: optional WebFetchURLSourceAll or WebFetchURLSourceNone`2523925240 Whether URLs in user messages are fetchable: "all" or "none".2524125242 - `WebFetchURLSourceAll object`2524325244 The `url_sources` variant under which a source contributes in25245 full: every result of the tool filter's source, or all user input.2524625247 - `WebFetchURLSourceNone object`2524825249 The `url_sources` variant under which a source contributes nothing:25250 no result of the tool filter's source, or no user input.2525125252 - `WebSearchTool20260209 object`2525325254 - `type: "web_search_20260209"`2525525256 - `name: "web_search"`2525725258 Name of the tool.2525925260 This is how the tool will be called by the model and in `tool_use` blocks.2526125262 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2526325264 - `"direct"`2526525266 - `"code_execution_20250825"`2526725268 - `"code_execution_20260120"`2526925270 - `"code_execution_20260521"`2527125272 - `allowed_domains: optional array of string or null`2527325274 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.2527525276 - `blocked_domains: optional array of string or null`2527725278 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.2527925280 - `cache_control: optional CacheControlEphemeral or null`2528125282 Create a cache control breakpoint at this content block.2528325284 - `defer_loading: optional boolean`2528525286 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2528725288 - `max_uses: optional number or null`2528925290 Maximum number of times the tool can be used in the API request.2529125292 exclusiveMinimum: 02529325294 - `strict: optional boolean`2529525296 When true, guarantees schema validation on tool names and inputs2529725298 - `user_location: optional UserLocation or null`2529925300 Parameters for the user's location. Used to provide more relevant search results.2530125302 - `WebFetchTool20260209 object`2530325304 - `type: "web_fetch_20260209"`2530525306 - `name: "web_fetch"`2530725308 Name of the tool.2530925310 This is how the tool will be called by the model and in `tool_use` blocks.2531125312 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2531325314 - `"direct"`2531525316 - `"code_execution_20250825"`2531725318 - `"code_execution_20260120"`2531925320 - `"code_execution_20260521"`2532125322 - `allowed_domains: optional array of string or null`2532325324 List of domains to allow fetching from2532525326 - `blocked_domains: optional array of string or null`2532725328 List of domains to block fetching from2532925330 - `cache_control: optional CacheControlEphemeral or null`2533125332 Create a cache control breakpoint at this content block.2533325334 - `citations: optional CitationsConfigParam or null`2533525336 Citations configuration for fetched documents. Citations are disabled by default.2533725338 - `defer_loading: optional boolean`2533925340 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2534125342 - `max_content_tokens: optional number or null`2534325344 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.2534525346 exclusiveMinimum: 02534725348 - `max_uses: optional number or null`2534925350 Maximum number of times the tool can be used in the API request.2535125352 exclusiveMinimum: 02535325354 - `strict: optional boolean`2535525356 When true, guarantees schema validation on tool names and inputs2535725358 - `url_sources: optional WebFetchURLSources or null`2535925360 Which sources contribute to the set of URLs web fetch may fetch.2536125362 Each key is a tagged variant: `user_input` is `all` or `none`; the25363 two tool filters are `all`, `none`, `only` (only the named tools'25364 results) or `except` (every result but the named tools'). A named tool25365 must be declared in this request's `tools[]`.2536625367 - `WebFetchTool20260309 object`2536825369 Web fetch tool with use_cache parameter for bypassing cached content.2537025371 - `type: "web_fetch_20260309"`2537225373 - `name: "web_fetch"`2537425375 Name of the tool.2537625377 This is how the tool will be called by the model and in `tool_use` blocks.2537825379 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2538025381 - `"direct"`2538225383 - `"code_execution_20250825"`2538425385 - `"code_execution_20260120"`2538625387 - `"code_execution_20260521"`2538825389 - `allowed_domains: optional array of string or null`2539025391 List of domains to allow fetching from2539225393 - `blocked_domains: optional array of string or null`2539425395 List of domains to block fetching from2539625397 - `cache_control: optional CacheControlEphemeral or null`2539825399 Create a cache control breakpoint at this content block.2540025401 - `citations: optional CitationsConfigParam or null`2540225403 Citations configuration for fetched documents. Citations are disabled by default.2540425405 - `defer_loading: optional boolean`2540625407 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2540825409 - `max_content_tokens: optional number or null`2541025411 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.2541225413 exclusiveMinimum: 02541425415 - `max_uses: optional number or null`2541625417 Maximum number of times the tool can be used in the API request.2541825419 exclusiveMinimum: 02542025421 - `strict: optional boolean`2542225423 When true, guarantees schema validation on tool names and inputs2542425425 - `url_sources: optional WebFetchURLSources or null`2542625427 Which sources contribute to the set of URLs web fetch may fetch.2542825429 Each key is a tagged variant: `user_input` is `all` or `none`; the25430 two tool filters are `all`, `none`, `only` (only the named tools'25431 results) or `except` (every result but the named tools'). A named tool25432 must be declared in this request's `tools[]`.2543325434 - `use_cache: optional boolean`2543525436 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.2543725438 - `WebSearchTool20260318 object`2543925440 - `type: "web_search_20260318"`2544125442 - `name: "web_search"`2544325444 Name of the tool.2544525446 This is how the tool will be called by the model and in `tool_use` blocks.2544725448 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2544925450 - `"direct"`2545125452 - `"code_execution_20250825"`2545325454 - `"code_execution_20260120"`2545525456 - `"code_execution_20260521"`2545725458 - `allowed_domains: optional array of string or null`2545925460 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.2546125462 - `blocked_domains: optional array of string or null`2546325464 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.2546525466 - `cache_control: optional CacheControlEphemeral or null`2546725468 Create a cache control breakpoint at this content block.2546925470 - `defer_loading: optional boolean`2547125472 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2547325474 - `max_uses: optional number or null`2547525476 Maximum number of times the tool can be used in the API request.2547725478 exclusiveMinimum: 02547925480 - `response_inclusion: optional "full" or "excluded"`2548125482 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.2548325484 - `"full"`2548525486 - `"excluded"`2548725488 - `strict: optional boolean`2548925490 When true, guarantees schema validation on tool names and inputs2549125492 - `user_location: optional UserLocation or null`2549325494 Parameters for the user's location. Used to provide more relevant search results.2549525496 - `WebFetchTool20260318 object`2549725498 - `type: "web_fetch_20260318"`2549925500 - `name: "web_fetch"`2550125502 Name of the tool.2550325504 This is how the tool will be called by the model and in `tool_use` blocks.2550525506 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2550725508 - `"direct"`2550925510 - `"code_execution_20250825"`2551125512 - `"code_execution_20260120"`2551325514 - `"code_execution_20260521"`2551525516 - `allowed_domains: optional array of string or null`2551725518 List of domains to allow fetching from2551925520 - `blocked_domains: optional array of string or null`2552125522 List of domains to block fetching from2552325524 - `cache_control: optional CacheControlEphemeral or null`2552525526 Create a cache control breakpoint at this content block.2552725528 - `citations: optional CitationsConfigParam or null`2552925530 Citations configuration for fetched documents. Citations are disabled by default.2553125532 - `defer_loading: optional boolean`2553325534 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2553525536 - `max_content_tokens: optional number or null`2553725538 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.2553925540 exclusiveMinimum: 02554125542 - `max_uses: optional number or null`2554325544 Maximum number of times the tool can be used in the API request.2554525546 exclusiveMinimum: 02554725548 - `response_inclusion: optional "full" or "excluded"`2554925550 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.2555125552 - `"full"`2555325554 - `"excluded"`2555525556 - `strict: optional boolean`2555725558 When true, guarantees schema validation on tool names and inputs2555925560 - `url_sources: optional WebFetchURLSources or null`2556125562 Which sources contribute to the set of URLs web fetch may fetch.2556325564 Each key is a tagged variant: `user_input` is `all` or `none`; the25565 two tool filters are `all`, `none`, `only` (only the named tools'25566 results) or `except` (every result but the named tools'). A named tool25567 must be declared in this request's `tools[]`.2556825569 - `use_cache: optional boolean`2557025571 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.2557225573 - `ToolSearchToolBm25_20251119 object`2557425575 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`2557625577 - `"tool_search_tool_bm25_20251119"`2557825579 - `"tool_search_tool_bm25"`2558025581 - `name: "tool_search_tool_bm25"`2558225583 Name of the tool.2558425585 This is how the tool will be called by the model and in `tool_use` blocks.2558625587 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2558825589 - `"direct"`2559025591 - `"code_execution_20250825"`2559225593 - `"code_execution_20260120"`2559425595 - `"code_execution_20260521"`2559625597 - `cache_control: optional CacheControlEphemeral or null`2559825599 Create a cache control breakpoint at this content block.2560025601 - `defer_loading: optional boolean`2560225603 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2560425605 - `strict: optional boolean`2560625607 When true, guarantees schema validation on tool names and inputs2560825609 - `ToolSearchToolRegex20251119 object`2561025611 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`2561225613 - `"tool_search_tool_regex_20251119"`2561425615 - `"tool_search_tool_regex"`2561625617 - `name: "tool_search_tool_regex"`2561825619 Name of the tool.2562025621 This is how the tool will be called by the model and in `tool_use` blocks.2562225623 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2562425625 - `"direct"`2562625627 - `"code_execution_20250825"`2562825629 - `"code_execution_20260120"`2563025631 - `"code_execution_20260521"`2563225633 - `cache_control: optional CacheControlEphemeral or null`2563425635 Create a cache control breakpoint at this content block.2563625637 - `defer_loading: optional boolean`2563825639 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2564025641 - `strict: optional boolean`2564225643 When true, guarantees schema validation on tool names and inputs2564425645### Tool Use Block2564625647- `ToolUseBlock object`2564825649 - `type: "tool_use"`2565025651 default: tool_use2565225653 - `id: string`2565425655 pattern: ^[a-zA-Z0-9_-]+$2565625657 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`2565825659 default: {"type":"direct"}2566025661 - `DirectCaller object`2566225663 Tool invocation directly from the model.2566425665 - `type: "direct"`2566625667 - `ServerToolCaller object`2566825669 Tool invocation generated by a server-side tool.2567025671 - `type: "code_execution_20250825"`2567225673 - `tool_id: string`2567425675 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2567625677 - `ServerToolCaller20260120 object`2567825679 - `type: "code_execution_20260120"`2568025681 - `tool_id: string`2568225683 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2568425685 - `input: map[unknown]`2568625687 - `name: string`2568825689 minLength: 12569025691 - `toolset_name: optional string or null`2569225693 For a toolset member tool_use, the toolset family.2569425695 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$2569625697### Tool Use Block Param2569825699- `ToolUseBlockParam object`2570025701 - `type: "tool_use"`2570225703 - `id: string`2570425705 pattern: ^[a-zA-Z0-9_-]+$2570625707 - `input: map[unknown]`2570825709 - `name: string`2571025711 maxLength: 200, minLength: 12571225713 - `cache_control: optional CacheControlEphemeral or null`2571425715 Create a cache control breakpoint at this content block.2571625717 - `type: "ephemeral"`2571825719 - `ttl: optional "5m" or "1h"`2572025721 The time-to-live for the cache control breakpoint.2572225723 This may be one the following values:2572425725 - `5m`: 5 minutes25726 - `1h`: 1 hour2572725728 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2572925730 - `"5m"`2573125732 - `"1h"`2573325734 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`2573525736 - `DirectCaller object`2573725738 Tool invocation directly from the model.2573925740 - `type: "direct"`2574125742 - `ServerToolCaller object`2574325744 Tool invocation generated by a server-side tool.2574525746 - `type: "code_execution_20250825"`2574725748 - `tool_id: string`2574925750 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2575125752 - `ServerToolCaller20260120 object`2575325754 - `type: "code_execution_20260120"`2575525756 - `tool_id: string`2575725758 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2575925760 - `toolset_name: optional string or null`2576125762 For a toolset member tool_use, the toolset family this member belongs to.2576325764 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$2576525766### URL Image Source2576725768- `URLImageSource object`2576925770 - `type: "url"`2577125772 - `url: string`2577325774### URL PDF Source2577525776- `URLPDFSource object`2577725778 - `type: "url"`2577925780 - `url: string`2578125782### Usage2578325784- `Usage object`2578525786 - `cache_creation: CacheCreation or null`2578725788 Breakdown of cached tokens by TTL2578925790 - `ephemeral_1h_input_tokens: number`2579125792 The number of input tokens used to create the 1 hour cache entry.2579325794 default: 0, minimum: 02579525796 - `ephemeral_5m_input_tokens: number`2579725798 The number of input tokens used to create the 5 minute cache entry.2579925800 default: 0, minimum: 02580125802 - `cache_creation_input_tokens: number or null`2580325804 The number of input tokens used to create the cache entry.2580525806 minimum: 02580725808 - `cache_read_input_tokens: number or null`2580925810 The number of input tokens read from the cache.2581125812 minimum: 02581325814 - `inference_geo: string or null`2581525816 The geographic region where inference was performed for this request.2581725818 - `input_tokens: number`2581925820 The number of input tokens which were used.2582125822 minimum: 02582325824 - `output_tokens: number`2582525826 The number of output tokens which were used.2582725828 minimum: 02582925830 - `output_tokens_details: OutputTokensDetails or null`2583125832 Breakdown of output tokens by category.2583325834 `output_tokens` remains the inclusive, authoritative total used for billing.25835 This object provides a read-only decomposition for observability — for example,25836 how many of the billed output tokens were spent on internal reasoning that may25837 have been summarized before being returned to you.2583825839 - `thinking_tokens: number`2584025841 Number of output tokens the model generated as internal reasoning, including25842 the thinking-block delimiter tokens.2584325844 Reflects the raw reasoning the model produced, not the (possibly shorter)25845 summarized thinking text returned in the response body. Computed by25846 re-tokenizing the raw reasoning text, so it may differ from the model's exact25847 generation count by a small number of tokens. Always ≤ `output_tokens`;25848 `output_tokens - thinking_tokens` approximates the non-reasoning output.2584925850 default: 0, minimum: 02585125852 - `server_tool_use: ServerToolUsage or null`2585325854 The number of server tool requests.2585525856 - `web_fetch_requests: number`2585725858 The number of web fetch tool requests.2585925860 default: 0, minimum: 02586125862 - `web_search_requests: number`2586325864 The number of web search tool requests.2586525866 default: 0, minimum: 02586725868 - `service_tier: "standard" or "priority" or "batch" or null`2586925870 If the request used the priority, standard, or batch tier.2587125872 - `"standard"`2587325874 - `"priority"`2587525876 - `"batch"`2587725878### User Location2587925880- `UserLocation object`2588125882 - `type: "approximate"`2588325884 - `city: optional string or null`2588525886 The city of the user.2588725888 maxLength: 255, minLength: 12588925890 - `country: optional string or null`2589125892 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.2589325894 maxLength: 2, minLength: 22589525896 - `region: optional string or null`2589725898 The region of the user.2589925900 maxLength: 255, minLength: 12590125902 - `timezone: optional string or null`2590325904 The [IANA timezone](https://nodatime.org/TimeZones) of the user.2590525906 maxLength: 255, minLength: 12590725908### Web Fetch Block2590925910- `WebFetchBlock object`2591125912 - `type: "web_fetch_result"`2591325914 default: web_fetch_result2591525916 - `content: DocumentBlock`2591725918 - `type: "document"`2591925920 default: document2592125922 - `citations: CitationsConfig or null`2592325924 Citation configuration for the document2592525926 - `enabled: boolean`2592725928 default: false2592925930 - `source: Base64PDFSource or PlainTextSource`2593125932 - `Base64PDFSource object`2593325934 - `type: "base64"`2593525936 - `data: string`2593725938 format: byte2593925940 - `media_type: "application/pdf"`2594125942 - `PlainTextSource object`2594325944 - `type: "text"`2594525946 - `data: string`2594725948 - `media_type: "text/plain"`2594925950 - `title: string or null`2595125952 The title of the document2595325954 - `retrieved_at: string or null`2595525956 ISO 8601 timestamp when the content was retrieved2595725958 - `url: string`2595925960 Fetched content URL2596125962### Web Fetch Block Param2596325964- `WebFetchBlockParam object`2596525966 - `type: "web_fetch_result"`2596725968 - `content: DocumentBlockParam`2596925970 - `type: "document"`2597125972 - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more`2597325974 - `Base64PDFSource object`2597525976 - `type: "base64"`2597725978 - `data: string`2597925980 format: byte2598125982 - `media_type: "application/pdf"`2598325984 - `PlainTextSource object`2598525986 - `type: "text"`2598725988 - `data: string`2598925990 - `media_type: "text/plain"`2599125992 - `ContentBlockSource object`2599325994 - `type: "content"`2599525996 - `content: string or array of ContentBlockSourceContent`2599725998 - `string`2599926000 - `ContentBlockSourceContent = array of ContentBlockSourceContent`2600126002 - `TextBlockParam object`2600326004 - `type: "text"`2600526006 - `text: string`2600726008 minLength: 12600926010 - `cache_control: optional CacheControlEphemeral or null`2601126012 Create a cache control breakpoint at this content block.2601326014 - `type: "ephemeral"`2601526016 - `ttl: optional "5m" or "1h"`2601726018 The time-to-live for the cache control breakpoint.2601926020 This may be one the following values:2602126022 - `5m`: 5 minutes26023 - `1h`: 1 hour2602426025 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2602626027 - `"5m"`2602826029 - `"1h"`2603026031 - `citations: optional array of TextCitationParam or null`2603226033 - `CitationCharLocationParam object`2603426035 - `type: "char_location"`2603626037 - `cited_text: string`2603826039 - `document_index: number`2604026041 minimum: 02604226043 - `document_title: string or null`2604426045 maxLength: 500, minLength: 12604626047 - `end_char_index: number`2604826049 - `start_char_index: number`2605026051 minimum: 02605226053 - `CitationPageLocationParam object`2605426055 - `type: "page_location"`2605626057 - `cited_text: string`2605826059 - `document_index: number`2606026061 minimum: 02606226063 - `document_title: string or null`2606426065 maxLength: 500, minLength: 12606626067 - `end_page_number: number`2606826069 - `start_page_number: number`2607026071 minimum: 12607226073 - `CitationContentBlockLocationParam object`2607426075 - `type: "content_block_location"`2607626077 - `cited_text: string`2607826079 The full text of the cited block range, concatenated.2608026081 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.2608226083 - `document_index: number`2608426085 minimum: 02608626087 - `document_title: string or null`2608826089 maxLength: 500, minLength: 12609026091 - `end_block_index: number`2609226093 Exclusive 0-based end index of the cited block range in the source's `content` array.2609426095 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2609626097 - `start_block_index: number`2609826099 0-based index of the first cited block in the source's `content` array.2610026101 minimum: 02610226103 - `CitationWebSearchResultLocationParam object`2610426105 - `type: "web_search_result_location"`2610626107 - `cited_text: string`2610826109 - `encrypted_index: string`2611026111 - `title: string or null`2611226113 maxLength: 512, minLength: 12611426115 - `url: string`2611626117 minLength: 12611826119 - `CitationSearchResultLocationParam object`2612026121 - `type: "search_result_location"`2612226123 - `cited_text: string`2612426125 The full text of the cited block range, concatenated.2612626127 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.2612826129 - `end_block_index: number`2613026131 Exclusive 0-based end index of the cited block range in the source's `content` array.2613226133 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2613426135 - `search_result_index: number`2613626137 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.2613826139 Counted separately from `document_index`; server-side web search results are not included in this count.2614026141 minimum: 02614226143 - `source: string`2614426145 - `start_block_index: number`2614626147 0-based index of the first cited block in the source's `content` array.2614826149 minimum: 02615026151 - `title: string or null`2615226153 - `ImageBlockParam object`2615426155 - `type: "image"`2615626157 - `source: Base64ImageSource or URLImageSource or FileImageSource`2615826159 - `Base64ImageSource object`2616026161 - `type: "base64"`2616226163 - `data: string`2616426165 format: byte2616626167 - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"`2616826169 - `"image/jpeg"`2617026171 - `"image/png"`2617226173 - `"image/gif"`2617426175 - `"image/webp"`2617626177 - `URLImageSource object`2617826179 - `type: "url"`2618026181 - `url: string`2618226183 - `FileImageSource object`2618426185 - `type: "file"`2618626187 - `file_id: string`2618826189 - `cache_control: optional CacheControlEphemeral or null`2619026191 Create a cache control breakpoint at this content block.2619226193 - `transformations: optional ImageTransformationsParam or null`2619426195 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.2619626197 - `oversized_image: optional "downsize" or "error"`2619826199 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.2620026201 - `"downsize"`2620226203 - `"error"`2620426205 - `URLPDFSource object`2620626207 - `type: "url"`2620826209 - `url: string`2621026211 - `FileDocumentSource object`2621226213 - `type: "file"`2621426215 - `file_id: string`2621626217 - `cache_control: optional CacheControlEphemeral or null`2621826219 Create a cache control breakpoint at this content block.2622026221 - `citations: optional CitationsConfigParam or null`2622226223 - `enabled: optional boolean`2622426225 - `context: optional string or null`2622626227 minLength: 12622826229 - `title: optional string or null`2623026231 maxLength: 500, minLength: 12623226233 - `url: string`2623426235 Fetched content URL2623626237 - `retrieved_at: optional string or null`2623826239 ISO 8601 timestamp when the content was retrieved2624026241### Web Fetch Tool 202509102624226243- `WebFetchTool20250910 object`2624426245 - `type: "web_fetch_20250910"`2624626247 - `name: "web_fetch"`2624826249 Name of the tool.2625026251 This is how the tool will be called by the model and in `tool_use` blocks.2625226253 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2625426255 - `"direct"`2625626257 - `"code_execution_20250825"`2625826259 - `"code_execution_20260120"`2626026261 - `"code_execution_20260521"`2626226263 - `allowed_domains: optional array of string or null`2626426265 List of domains to allow fetching from2626626267 - `blocked_domains: optional array of string or null`2626826269 List of domains to block fetching from2627026271 - `cache_control: optional CacheControlEphemeral or null`2627226273 Create a cache control breakpoint at this content block.2627426275 - `type: "ephemeral"`2627626277 - `ttl: optional "5m" or "1h"`2627826279 The time-to-live for the cache control breakpoint.2628026281 This may be one the following values:2628226283 - `5m`: 5 minutes26284 - `1h`: 1 hour2628526286 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2628726288 - `"5m"`2628926290 - `"1h"`2629126292 - `citations: optional CitationsConfigParam or null`2629326294 Citations configuration for fetched documents. Citations are disabled by default.2629526296 - `enabled: optional boolean`2629726298 - `defer_loading: optional boolean`2629926300 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2630126302 - `max_content_tokens: optional number or null`2630326304 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.2630526306 exclusiveMinimum: 02630726308 - `max_uses: optional number or null`2630926310 Maximum number of times the tool can be used in the API request.2631126312 exclusiveMinimum: 02631326314 - `strict: optional boolean`2631526316 When true, guarantees schema validation on tool names and inputs2631726318 - `url_sources: optional WebFetchURLSources or null`2631926320 Which sources contribute to the set of URLs web fetch may fetch.2632126322 Each key is a tagged variant: `user_input` is `all` or `none`; the26323 two tool filters are `all`, `none`, `only` (only the named tools'26324 results) or `except` (every result but the named tools'). A named tool26325 must be declared in this request's `tools[]`.2632626327 - `client_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`2632826329 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].2633026331 - `WebFetchURLSourceAll object`2633226333 The `url_sources` variant under which a source contributes in26334 full: every result of the tool filter's source, or all user input.2633526336 - `type: "all"`2633726338 - `WebFetchURLSourceNone object`2633926340 The `url_sources` variant under which a source contributes nothing:26341 no result of the tool filter's source, or no user input.2634226343 - `type: "none"`2634426345 - `WebFetchURLSourceOnly object`2634626347 The tool filter variant under which only the named tools' results26348 contribute.2634926350 - `type: "only"`2635126352 - `tools: array of WebFetchURLSourceToolReference`2635326354 - `type: "tool_reference"`2635526356 - `name: string`2635726358 - `WebFetchURLSourceExcept object`2635926360 The tool filter variant under which every result but the named26361 tools' contributes.2636226363 - `type: "except"`2636426365 - `tools: array of WebFetchURLSourceToolReference`2636626367 - `type: "tool_reference"`2636826369 - `name: string`2637026371 - `server_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`2637226373 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.2637426375 - `WebFetchURLSourceAll object`2637626377 The `url_sources` variant under which a source contributes in26378 full: every result of the tool filter's source, or all user input.2637926380 - `WebFetchURLSourceNone object`2638126382 The `url_sources` variant under which a source contributes nothing:26383 no result of the tool filter's source, or no user input.2638426385 - `WebFetchURLSourceOnly object`2638626387 The tool filter variant under which only the named tools' results26388 contribute.2638926390 - `WebFetchURLSourceExcept object`2639126392 The tool filter variant under which every result but the named26393 tools' contributes.2639426395 - `user_input: optional WebFetchURLSourceAll or WebFetchURLSourceNone`2639626397 Whether URLs in user messages are fetchable: "all" or "none".2639826399 - `WebFetchURLSourceAll object`2640026401 The `url_sources` variant under which a source contributes in26402 full: every result of the tool filter's source, or all user input.2640326404 - `WebFetchURLSourceNone object`2640526406 The `url_sources` variant under which a source contributes nothing:26407 no result of the tool filter's source, or no user input.2640826409### Web Fetch Tool 202602092641026411- `WebFetchTool20260209 object`2641226413 - `type: "web_fetch_20260209"`2641426415 - `name: "web_fetch"`2641626417 Name of the tool.2641826419 This is how the tool will be called by the model and in `tool_use` blocks.2642026421 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2642226423 - `"direct"`2642426425 - `"code_execution_20250825"`2642626427 - `"code_execution_20260120"`2642826429 - `"code_execution_20260521"`2643026431 - `allowed_domains: optional array of string or null`2643226433 List of domains to allow fetching from2643426435 - `blocked_domains: optional array of string or null`2643626437 List of domains to block fetching from2643826439 - `cache_control: optional CacheControlEphemeral or null`2644026441 Create a cache control breakpoint at this content block.2644226443 - `type: "ephemeral"`2644426445 - `ttl: optional "5m" or "1h"`2644626447 The time-to-live for the cache control breakpoint.2644826449 This may be one the following values:2645026451 - `5m`: 5 minutes26452 - `1h`: 1 hour2645326454 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2645526456 - `"5m"`2645726458 - `"1h"`2645926460 - `citations: optional CitationsConfigParam or null`2646126462 Citations configuration for fetched documents. Citations are disabled by default.2646326464 - `enabled: optional boolean`2646526466 - `defer_loading: optional boolean`2646726468 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2646926470 - `max_content_tokens: optional number or null`2647126472 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.2647326474 exclusiveMinimum: 02647526476 - `max_uses: optional number or null`2647726478 Maximum number of times the tool can be used in the API request.2647926480 exclusiveMinimum: 02648126482 - `strict: optional boolean`2648326484 When true, guarantees schema validation on tool names and inputs2648526486 - `url_sources: optional WebFetchURLSources or null`2648726488 Which sources contribute to the set of URLs web fetch may fetch.2648926490 Each key is a tagged variant: `user_input` is `all` or `none`; the26491 two tool filters are `all`, `none`, `only` (only the named tools'26492 results) or `except` (every result but the named tools'). A named tool26493 must be declared in this request's `tools[]`.2649426495 - `client_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`2649626497 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].2649826499 - `WebFetchURLSourceAll object`2650026501 The `url_sources` variant under which a source contributes in26502 full: every result of the tool filter's source, or all user input.2650326504 - `type: "all"`2650526506 - `WebFetchURLSourceNone object`2650726508 The `url_sources` variant under which a source contributes nothing:26509 no result of the tool filter's source, or no user input.2651026511 - `type: "none"`2651226513 - `WebFetchURLSourceOnly object`2651426515 The tool filter variant under which only the named tools' results26516 contribute.2651726518 - `type: "only"`2651926520 - `tools: array of WebFetchURLSourceToolReference`2652126522 - `type: "tool_reference"`2652326524 - `name: string`2652526526 - `WebFetchURLSourceExcept object`2652726528 The tool filter variant under which every result but the named26529 tools' contributes.2653026531 - `type: "except"`2653226533 - `tools: array of WebFetchURLSourceToolReference`2653426535 - `type: "tool_reference"`2653626537 - `name: string`2653826539 - `server_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`2654026541 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.2654226543 - `WebFetchURLSourceAll object`2654426545 The `url_sources` variant under which a source contributes in26546 full: every result of the tool filter's source, or all user input.2654726548 - `WebFetchURLSourceNone object`2654926550 The `url_sources` variant under which a source contributes nothing:26551 no result of the tool filter's source, or no user input.2655226553 - `WebFetchURLSourceOnly object`2655426555 The tool filter variant under which only the named tools' results26556 contribute.2655726558 - `WebFetchURLSourceExcept object`2655926560 The tool filter variant under which every result but the named26561 tools' contributes.2656226563 - `user_input: optional WebFetchURLSourceAll or WebFetchURLSourceNone`2656426565 Whether URLs in user messages are fetchable: "all" or "none".2656626567 - `WebFetchURLSourceAll object`2656826569 The `url_sources` variant under which a source contributes in26570 full: every result of the tool filter's source, or all user input.2657126572 - `WebFetchURLSourceNone object`2657326574 The `url_sources` variant under which a source contributes nothing:26575 no result of the tool filter's source, or no user input.2657626577### Web Fetch Tool 202603092657826579- `WebFetchTool20260309 object`2658026581 Web fetch tool with use_cache parameter for bypassing cached content.2658226583 - `type: "web_fetch_20260309"`2658426585 - `name: "web_fetch"`2658626587 Name of the tool.2658826589 This is how the tool will be called by the model and in `tool_use` blocks.2659026591 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2659226593 - `"direct"`2659426595 - `"code_execution_20250825"`2659626597 - `"code_execution_20260120"`2659826599 - `"code_execution_20260521"`2660026601 - `allowed_domains: optional array of string or null`2660226603 List of domains to allow fetching from2660426605 - `blocked_domains: optional array of string or null`2660626607 List of domains to block fetching from2660826609 - `cache_control: optional CacheControlEphemeral or null`2661026611 Create a cache control breakpoint at this content block.2661226613 - `type: "ephemeral"`2661426615 - `ttl: optional "5m" or "1h"`2661626617 The time-to-live for the cache control breakpoint.2661826619 This may be one the following values:2662026621 - `5m`: 5 minutes26622 - `1h`: 1 hour2662326624 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2662526626 - `"5m"`2662726628 - `"1h"`2662926630 - `citations: optional CitationsConfigParam or null`2663126632 Citations configuration for fetched documents. Citations are disabled by default.2663326634 - `enabled: optional boolean`2663526636 - `defer_loading: optional boolean`2663726638 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2663926640 - `max_content_tokens: optional number or null`2664126642 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.2664326644 exclusiveMinimum: 02664526646 - `max_uses: optional number or null`2664726648 Maximum number of times the tool can be used in the API request.2664926650 exclusiveMinimum: 02665126652 - `strict: optional boolean`2665326654 When true, guarantees schema validation on tool names and inputs2665526656 - `url_sources: optional WebFetchURLSources or null`2665726658 Which sources contribute to the set of URLs web fetch may fetch.2665926660 Each key is a tagged variant: `user_input` is `all` or `none`; the26661 two tool filters are `all`, `none`, `only` (only the named tools'26662 results) or `except` (every result but the named tools'). A named tool26663 must be declared in this request's `tools[]`.2666426665 - `client_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`2666626667 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].2666826669 - `WebFetchURLSourceAll object`2667026671 The `url_sources` variant under which a source contributes in26672 full: every result of the tool filter's source, or all user input.2667326674 - `type: "all"`2667526676 - `WebFetchURLSourceNone object`2667726678 The `url_sources` variant under which a source contributes nothing:26679 no result of the tool filter's source, or no user input.2668026681 - `type: "none"`2668226683 - `WebFetchURLSourceOnly object`2668426685 The tool filter variant under which only the named tools' results26686 contribute.2668726688 - `type: "only"`2668926690 - `tools: array of WebFetchURLSourceToolReference`2669126692 - `type: "tool_reference"`2669326694 - `name: string`2669526696 - `WebFetchURLSourceExcept object`2669726698 The tool filter variant under which every result but the named26699 tools' contributes.2670026701 - `type: "except"`2670226703 - `tools: array of WebFetchURLSourceToolReference`2670426705 - `type: "tool_reference"`2670626707 - `name: string`2670826709 - `server_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`2671026711 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.2671226713 - `WebFetchURLSourceAll object`2671426715 The `url_sources` variant under which a source contributes in26716 full: every result of the tool filter's source, or all user input.2671726718 - `WebFetchURLSourceNone object`2671926720 The `url_sources` variant under which a source contributes nothing:26721 no result of the tool filter's source, or no user input.2672226723 - `WebFetchURLSourceOnly object`2672426725 The tool filter variant under which only the named tools' results26726 contribute.2672726728 - `WebFetchURLSourceExcept object`2672926730 The tool filter variant under which every result but the named26731 tools' contributes.2673226733 - `user_input: optional WebFetchURLSourceAll or WebFetchURLSourceNone`2673426735 Whether URLs in user messages are fetchable: "all" or "none".2673626737 - `WebFetchURLSourceAll object`2673826739 The `url_sources` variant under which a source contributes in26740 full: every result of the tool filter's source, or all user input.2674126742 - `WebFetchURLSourceNone object`2674326744 The `url_sources` variant under which a source contributes nothing:26745 no result of the tool filter's source, or no user input.2674626747 - `use_cache: optional boolean`2674826749 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.2675026751### Web Fetch Tool 202603182675226753- `WebFetchTool20260318 object`2675426755 - `type: "web_fetch_20260318"`2675626757 - `name: "web_fetch"`2675826759 Name of the tool.2676026761 This is how the tool will be called by the model and in `tool_use` blocks.2676226763 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2676426765 - `"direct"`2676626767 - `"code_execution_20250825"`2676826769 - `"code_execution_20260120"`2677026771 - `"code_execution_20260521"`2677226773 - `allowed_domains: optional array of string or null`2677426775 List of domains to allow fetching from2677626777 - `blocked_domains: optional array of string or null`2677826779 List of domains to block fetching from2678026781 - `cache_control: optional CacheControlEphemeral or null`2678226783 Create a cache control breakpoint at this content block.2678426785 - `type: "ephemeral"`2678626787 - `ttl: optional "5m" or "1h"`2678826789 The time-to-live for the cache control breakpoint.2679026791 This may be one the following values:2679226793 - `5m`: 5 minutes26794 - `1h`: 1 hour2679526796 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2679726798 - `"5m"`2679926800 - `"1h"`2680126802 - `citations: optional CitationsConfigParam or null`2680326804 Citations configuration for fetched documents. Citations are disabled by default.2680526806 - `enabled: optional boolean`2680726808 - `defer_loading: optional boolean`2680926810 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2681126812 - `max_content_tokens: optional number or null`2681326814 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.2681526816 exclusiveMinimum: 02681726818 - `max_uses: optional number or null`2681926820 Maximum number of times the tool can be used in the API request.2682126822 exclusiveMinimum: 02682326824 - `response_inclusion: optional "full" or "excluded"`2682526826 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.2682726828 - `"full"`2682926830 - `"excluded"`2683126832 - `strict: optional boolean`2683326834 When true, guarantees schema validation on tool names and inputs2683526836 - `url_sources: optional WebFetchURLSources or null`2683726838 Which sources contribute to the set of URLs web fetch may fetch.2683926840 Each key is a tagged variant: `user_input` is `all` or `none`; the26841 two tool filters are `all`, `none`, `only` (only the named tools'26842 results) or `except` (every result but the named tools'). A named tool26843 must be declared in this request's `tools[]`.2684426845 - `client_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`2684626847 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].2684826849 - `WebFetchURLSourceAll object`2685026851 The `url_sources` variant under which a source contributes in26852 full: every result of the tool filter's source, or all user input.2685326854 - `type: "all"`2685526856 - `WebFetchURLSourceNone object`2685726858 The `url_sources` variant under which a source contributes nothing:26859 no result of the tool filter's source, or no user input.2686026861 - `type: "none"`2686226863 - `WebFetchURLSourceOnly object`2686426865 The tool filter variant under which only the named tools' results26866 contribute.2686726868 - `type: "only"`2686926870 - `tools: array of WebFetchURLSourceToolReference`2687126872 - `type: "tool_reference"`2687326874 - `name: string`2687526876 - `WebFetchURLSourceExcept object`2687726878 The tool filter variant under which every result but the named26879 tools' contributes.2688026881 - `type: "except"`2688226883 - `tools: array of WebFetchURLSourceToolReference`2688426885 - `type: "tool_reference"`2688626887 - `name: string`2688826889 - `server_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`2689026891 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.2689226893 - `WebFetchURLSourceAll object`2689426895 The `url_sources` variant under which a source contributes in26896 full: every result of the tool filter's source, or all user input.2689726898 - `WebFetchURLSourceNone object`2689926900 The `url_sources` variant under which a source contributes nothing:26901 no result of the tool filter's source, or no user input.2690226903 - `WebFetchURLSourceOnly object`2690426905 The tool filter variant under which only the named tools' results26906 contribute.2690726908 - `WebFetchURLSourceExcept object`2690926910 The tool filter variant under which every result but the named26911 tools' contributes.2691226913 - `user_input: optional WebFetchURLSourceAll or WebFetchURLSourceNone`2691426915 Whether URLs in user messages are fetchable: "all" or "none".2691626917 - `WebFetchURLSourceAll object`2691826919 The `url_sources` variant under which a source contributes in26920 full: every result of the tool filter's source, or all user input.2692126922 - `WebFetchURLSourceNone object`2692326924 The `url_sources` variant under which a source contributes nothing:26925 no result of the tool filter's source, or no user input.2692626927 - `use_cache: optional boolean`2692826929 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.2693026931### Web Fetch Tool Result Block2693226933- `WebFetchToolResultBlock object`2693426935 - `type: "web_fetch_tool_result"`2693626937 default: web_fetch_tool_result2693826939 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`2694026941 default: {"type":"direct"}2694226943 - `DirectCaller object`2694426945 Tool invocation directly from the model.2694626947 - `type: "direct"`2694826949 - `ServerToolCaller object`2695026951 Tool invocation generated by a server-side tool.2695226953 - `type: "code_execution_20250825"`2695426955 - `tool_id: string`2695626957 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2695826959 - `ServerToolCaller20260120 object`2696026961 - `type: "code_execution_20260120"`2696226963 - `tool_id: string`2696426965 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2696626967 - `content: WebFetchToolResultErrorBlock or WebFetchBlock`2696826969 - `WebFetchToolResultErrorBlock object`2697026971 - `type: "web_fetch_tool_result_error"`2697226973 default: web_fetch_tool_result_error2697426975 - `error_code: WebFetchToolResultErrorCode`2697626977 - `"invalid_tool_input"`2697826979 - `"url_too_long"`2698026981 - `"url_not_allowed"`2698226983 - `"url_not_in_prior_context"`2698426985 - `"url_not_accessible"`2698626987 - `"unsupported_content_type"`2698826989 - `"too_many_requests"`2699026991 - `"max_uses_exceeded"`2699226993 - `"unavailable"`2699426995 - `"content_too_large"`2699626997 - `WebFetchBlock object`2699826999 - `type: "web_fetch_result"`2700027001 default: web_fetch_result2700227003 - `content: DocumentBlock`2700427005 - `type: "document"`2700627007 default: document2700827009 - `citations: CitationsConfig or null`2701027011 Citation configuration for the document2701227013 - `enabled: boolean`2701427015 default: false2701627017 - `source: Base64PDFSource or PlainTextSource`2701827019 - `Base64PDFSource object`2702027021 - `type: "base64"`2702227023 - `data: string`2702427025 format: byte2702627027 - `media_type: "application/pdf"`2702827029 - `PlainTextSource object`2703027031 - `type: "text"`2703227033 - `data: string`2703427035 - `media_type: "text/plain"`2703627037 - `title: string or null`2703827039 The title of the document2704027041 - `retrieved_at: string or null`2704227043 ISO 8601 timestamp when the content was retrieved2704427045 - `url: string`2704627047 Fetched content URL2704827049 - `tool_use_id: string`2705027051 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2705227053### Web Fetch Tool Result Block Param2705427055- `WebFetchToolResultBlockParam object`2705627057 - `type: "web_fetch_tool_result"`2705827059 - `content: WebFetchToolResultErrorBlockParam or WebFetchBlockParam`2706027061 - `WebFetchToolResultErrorBlockParam object`2706227063 - `type: "web_fetch_tool_result_error"`2706427065 - `error_code: WebFetchToolResultErrorCode`2706627067 - `"invalid_tool_input"`2706827069 - `"url_too_long"`2707027071 - `"url_not_allowed"`2707227073 - `"url_not_in_prior_context"`2707427075 - `"url_not_accessible"`2707627077 - `"unsupported_content_type"`2707827079 - `"too_many_requests"`2708027081 - `"max_uses_exceeded"`2708227083 - `"unavailable"`2708427085 - `"content_too_large"`2708627087 - `WebFetchBlockParam object`2708827089 - `type: "web_fetch_result"`2709027091 - `content: DocumentBlockParam`2709227093 - `type: "document"`2709427095 - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more`2709627097 - `Base64PDFSource object`2709827099 - `type: "base64"`2710027101 - `data: string`2710227103 format: byte2710427105 - `media_type: "application/pdf"`2710627107 - `PlainTextSource object`2710827109 - `type: "text"`2711027111 - `data: string`2711227113 - `media_type: "text/plain"`2711427115 - `ContentBlockSource object`2711627117 - `type: "content"`2711827119 - `content: string or array of ContentBlockSourceContent`2712027121 - `string`2712227123 - `ContentBlockSourceContent = array of ContentBlockSourceContent`2712427125 - `TextBlockParam object`2712627127 - `type: "text"`2712827129 - `text: string`2713027131 minLength: 12713227133 - `cache_control: optional CacheControlEphemeral or null`2713427135 Create a cache control breakpoint at this content block.2713627137 - `type: "ephemeral"`2713827139 - `ttl: optional "5m" or "1h"`2714027141 The time-to-live for the cache control breakpoint.2714227143 This may be one the following values:2714427145 - `5m`: 5 minutes27146 - `1h`: 1 hour2714727148 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2714927150 - `"5m"`2715127152 - `"1h"`2715327154 - `citations: optional array of TextCitationParam or null`2715527156 - `CitationCharLocationParam object`2715727158 - `type: "char_location"`2715927160 - `cited_text: string`2716127162 - `document_index: number`2716327164 minimum: 02716527166 - `document_title: string or null`2716727168 maxLength: 500, minLength: 12716927170 - `end_char_index: number`2717127172 - `start_char_index: number`2717327174 minimum: 02717527176 - `CitationPageLocationParam object`2717727178 - `type: "page_location"`2717927180 - `cited_text: string`2718127182 - `document_index: number`2718327184 minimum: 02718527186 - `document_title: string or null`2718727188 maxLength: 500, minLength: 12718927190 - `end_page_number: number`2719127192 - `start_page_number: number`2719327194 minimum: 12719527196 - `CitationContentBlockLocationParam object`2719727198 - `type: "content_block_location"`2719927200 - `cited_text: string`2720127202 The full text of the cited block range, concatenated.2720327204 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.2720527206 - `document_index: number`2720727208 minimum: 02720927210 - `document_title: string or null`2721127212 maxLength: 500, minLength: 12721327214 - `end_block_index: number`2721527216 Exclusive 0-based end index of the cited block range in the source's `content` array.2721727218 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2721927220 - `start_block_index: number`2722127222 0-based index of the first cited block in the source's `content` array.2722327224 minimum: 02722527226 - `CitationWebSearchResultLocationParam object`2722727228 - `type: "web_search_result_location"`2722927230 - `cited_text: string`2723127232 - `encrypted_index: string`2723327234 - `title: string or null`2723527236 maxLength: 512, minLength: 12723727238 - `url: string`2723927240 minLength: 12724127242 - `CitationSearchResultLocationParam object`2724327244 - `type: "search_result_location"`2724527246 - `cited_text: string`2724727248 The full text of the cited block range, concatenated.2724927250 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.2725127252 - `end_block_index: number`2725327254 Exclusive 0-based end index of the cited block range in the source's `content` array.2725527256 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2725727258 - `search_result_index: number`2725927260 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.2726127262 Counted separately from `document_index`; server-side web search results are not included in this count.2726327264 minimum: 02726527266 - `source: string`2726727268 - `start_block_index: number`2726927270 0-based index of the first cited block in the source's `content` array.2727127272 minimum: 02727327274 - `title: string or null`2727527276 - `ImageBlockParam object`2727727278 - `type: "image"`2727927280 - `source: Base64ImageSource or URLImageSource or FileImageSource`2728127282 - `Base64ImageSource object`2728327284 - `type: "base64"`2728527286 - `data: string`2728727288 format: byte2728927290 - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"`2729127292 - `"image/jpeg"`2729327294 - `"image/png"`2729527296 - `"image/gif"`2729727298 - `"image/webp"`2729927300 - `URLImageSource object`2730127302 - `type: "url"`2730327304 - `url: string`2730527306 - `FileImageSource object`2730727308 - `type: "file"`2730927310 - `file_id: string`2731127312 - `cache_control: optional CacheControlEphemeral or null`2731327314 Create a cache control breakpoint at this content block.2731527316 - `transformations: optional ImageTransformationsParam or null`2731727318 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.2731927320 - `oversized_image: optional "downsize" or "error"`2732127322 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.2732327324 - `"downsize"`2732527326 - `"error"`2732727328 - `URLPDFSource object`2732927330 - `type: "url"`2733127332 - `url: string`2733327334 - `FileDocumentSource object`2733527336 - `type: "file"`2733727338 - `file_id: string`2733927340 - `cache_control: optional CacheControlEphemeral or null`2734127342 Create a cache control breakpoint at this content block.2734327344 - `citations: optional CitationsConfigParam or null`2734527346 - `enabled: optional boolean`2734727348 - `context: optional string or null`2734927350 minLength: 12735127352 - `title: optional string or null`2735327354 maxLength: 500, minLength: 12735527356 - `url: string`2735727358 Fetched content URL2735927360 - `retrieved_at: optional string or null`2736127362 ISO 8601 timestamp when the content was retrieved2736327364 - `tool_use_id: string`2736527366 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2736727368 - `cache_control: optional CacheControlEphemeral or null`2736927370 Create a cache control breakpoint at this content block.2737127372 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`2737327374 - `DirectCaller object`2737527376 Tool invocation directly from the model.2737727378 - `type: "direct"`2737927380 - `ServerToolCaller object`2738127382 Tool invocation generated by a server-side tool.2738327384 - `type: "code_execution_20250825"`2738527386 - `tool_id: string`2738727388 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2738927390 - `ServerToolCaller20260120 object`2739127392 - `type: "code_execution_20260120"`2739327394 - `tool_id: string`2739527396 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2739727398### Web Fetch Tool Result Error Block2739927400- `WebFetchToolResultErrorBlock object`2740127402 - `type: "web_fetch_tool_result_error"`2740327404 default: web_fetch_tool_result_error2740527406 - `error_code: WebFetchToolResultErrorCode`2740727408 - `"invalid_tool_input"`2740927410 - `"url_too_long"`2741127412 - `"url_not_allowed"`2741327414 - `"url_not_in_prior_context"`2741527416 - `"url_not_accessible"`2741727418 - `"unsupported_content_type"`2741927420 - `"too_many_requests"`2742127422 - `"max_uses_exceeded"`2742327424 - `"unavailable"`2742527426 - `"content_too_large"`2742727428### Web Fetch Tool Result Error Block Param2742927430- `WebFetchToolResultErrorBlockParam object`2743127432 - `type: "web_fetch_tool_result_error"`2743327434 - `error_code: WebFetchToolResultErrorCode`2743527436 - `"invalid_tool_input"`2743727438 - `"url_too_long"`2743927440 - `"url_not_allowed"`2744127442 - `"url_not_in_prior_context"`2744327444 - `"url_not_accessible"`2744527446 - `"unsupported_content_type"`2744727448 - `"too_many_requests"`2744927450 - `"max_uses_exceeded"`2745127452 - `"unavailable"`2745327454 - `"content_too_large"`2745527456### Web Fetch Tool Result Error Code2745727458- `WebFetchToolResultErrorCode = "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 7 more`2745927460 - `"invalid_tool_input"`2746127462 - `"url_too_long"`2746327464 - `"url_not_allowed"`2746527466 - `"url_not_in_prior_context"`2746727468 - `"url_not_accessible"`2746927470 - `"unsupported_content_type"`2747127472 - `"too_many_requests"`2747327474 - `"max_uses_exceeded"`2747527476 - `"unavailable"`2747727478 - `"content_too_large"`2747927480### Web Fetch URL Source All2748127482- `WebFetchURLSourceAll object`2748327484 The `url_sources` variant under which a source contributes in27485 full: every result of the tool filter's source, or all user input.2748627487 - `type: "all"`2748827489### Web Fetch URL Source Except2749027491- `WebFetchURLSourceExcept object`2749227493 The tool filter variant under which every result but the named27494 tools' contributes.2749527496 - `type: "except"`2749727498 - `tools: array of WebFetchURLSourceToolReference`2749927500 - `type: "tool_reference"`2750127502 - `name: string`2750327504### Web Fetch URL Source None2750527506- `WebFetchURLSourceNone object`2750727508 The `url_sources` variant under which a source contributes nothing:27509 no result of the tool filter's source, or no user input.2751027511 - `type: "none"`2751227513### Web Fetch URL Source Only2751427515- `WebFetchURLSourceOnly object`2751627517 The tool filter variant under which only the named tools' results27518 contribute.2751927520 - `type: "only"`2752127522 - `tools: array of WebFetchURLSourceToolReference`2752327524 - `type: "tool_reference"`2752527526 - `name: string`2752727528### Web Fetch URL Source Tool Reference2752927530- `WebFetchURLSourceToolReference object`2753127532 One entry of a tool filter's `tools`: it must name a tool declared27533 in this request's `tools[]`.2753427535 - `type: "tool_reference"`2753627537 - `name: string`2753827539### Web Fetch URL Sources2754027541- `WebFetchURLSources object`2754227543 Which sources contribute to the set of URLs web fetch may fetch.2754427545 Each key is a tagged variant: `user_input` is `all` or `none`; the27546 two tool filters are `all`, `none`, `only` (only the named tools'27547 results) or `except` (every result but the named tools'). A named tool27548 must be declared in this request's `tools[]`.2754927550 - `client_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`2755127552 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].2755327554 - `WebFetchURLSourceAll object`2755527556 The `url_sources` variant under which a source contributes in27557 full: every result of the tool filter's source, or all user input.2755827559 - `type: "all"`2756027561 - `WebFetchURLSourceNone object`2756227563 The `url_sources` variant under which a source contributes nothing:27564 no result of the tool filter's source, or no user input.2756527566 - `type: "none"`2756727568 - `WebFetchURLSourceOnly object`2756927570 The tool filter variant under which only the named tools' results27571 contribute.2757227573 - `type: "only"`2757427575 - `tools: array of WebFetchURLSourceToolReference`2757627577 - `type: "tool_reference"`2757827579 - `name: string`2758027581 - `WebFetchURLSourceExcept object`2758227583 The tool filter variant under which every result but the named27584 tools' contributes.2758527586 - `type: "except"`2758727588 - `tools: array of WebFetchURLSourceToolReference`2758927590 - `type: "tool_reference"`2759127592 - `name: string`2759327594 - `server_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`2759527596 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.2759727598 - `WebFetchURLSourceAll object`2759927600 The `url_sources` variant under which a source contributes in27601 full: every result of the tool filter's source, or all user input.2760227603 - `WebFetchURLSourceNone object`2760427605 The `url_sources` variant under which a source contributes nothing:27606 no result of the tool filter's source, or no user input.2760727608 - `WebFetchURLSourceOnly object`2760927610 The tool filter variant under which only the named tools' results27611 contribute.2761227613 - `WebFetchURLSourceExcept object`2761427615 The tool filter variant under which every result but the named27616 tools' contributes.2761727618 - `user_input: optional WebFetchURLSourceAll or WebFetchURLSourceNone`2761927620 Whether URLs in user messages are fetchable: "all" or "none".2762127622 - `WebFetchURLSourceAll object`2762327624 The `url_sources` variant under which a source contributes in27625 full: every result of the tool filter's source, or all user input.2762627627 - `WebFetchURLSourceNone object`2762827629 The `url_sources` variant under which a source contributes nothing:27630 no result of the tool filter's source, or no user input.2763127632### Web Search Result Block2763327634- `WebSearchResultBlock object`2763527636 - `type: "web_search_result"`2763727638 default: web_search_result2763927640 - `encrypted_content: string`2764127642 - `page_age: string or null`2764327644 - `title: string`2764527646 - `url: string`2764727648### Web Search Result Block Param2764927650- `WebSearchResultBlockParam object`2765127652 - `type: "web_search_result"`2765327654 - `encrypted_content: string`2765527656 - `title: string`2765727658 - `url: string`2765927660 - `page_age: optional string or null`2766127662### Web Search Tool 202503052766327664- `WebSearchTool20250305 object`2766527666 - `type: "web_search_20250305"`2766727668 - `name: "web_search"`2766927670 Name of the tool.2767127672 This is how the tool will be called by the model and in `tool_use` blocks.2767327674 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2767527676 - `"direct"`2767727678 - `"code_execution_20250825"`2767927680 - `"code_execution_20260120"`2768127682 - `"code_execution_20260521"`2768327684 - `allowed_domains: optional array of string or null`2768527686 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.2768727688 - `blocked_domains: optional array of string or null`2768927690 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.2769127692 - `cache_control: optional CacheControlEphemeral or null`2769327694 Create a cache control breakpoint at this content block.2769527696 - `type: "ephemeral"`2769727698 - `ttl: optional "5m" or "1h"`2769927700 The time-to-live for the cache control breakpoint.2770127702 This may be one the following values:2770327704 - `5m`: 5 minutes27705 - `1h`: 1 hour2770627707 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2770827709 - `"5m"`2771027711 - `"1h"`2771227713 - `defer_loading: optional boolean`2771427715 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2771627717 - `max_uses: optional number or null`2771827719 Maximum number of times the tool can be used in the API request.2772027721 exclusiveMinimum: 02772227723 - `strict: optional boolean`2772427725 When true, guarantees schema validation on tool names and inputs2772627727 - `user_location: optional UserLocation or null`2772827729 Parameters for the user's location. Used to provide more relevant search results.2773027731 - `type: "approximate"`2773227733 - `city: optional string or null`2773427735 The city of the user.2773627737 maxLength: 255, minLength: 12773827739 - `country: optional string or null`2774027741 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.2774227743 maxLength: 2, minLength: 22774427745 - `region: optional string or null`2774627747 The region of the user.2774827749 maxLength: 255, minLength: 12775027751 - `timezone: optional string or null`2775227753 The [IANA timezone](https://nodatime.org/TimeZones) of the user.2775427755 maxLength: 255, minLength: 12775627757### Web Search Tool 202602092775827759- `WebSearchTool20260209 object`2776027761 - `type: "web_search_20260209"`2776227763 - `name: "web_search"`2776427765 Name of the tool.2776627767 This is how the tool will be called by the model and in `tool_use` blocks.2776827769 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2777027771 - `"direct"`2777227773 - `"code_execution_20250825"`2777427775 - `"code_execution_20260120"`2777627777 - `"code_execution_20260521"`2777827779 - `allowed_domains: optional array of string or null`2778027781 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.2778227783 - `blocked_domains: optional array of string or null`2778427785 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.2778627787 - `cache_control: optional CacheControlEphemeral or null`2778827789 Create a cache control breakpoint at this content block.2779027791 - `type: "ephemeral"`2779227793 - `ttl: optional "5m" or "1h"`2779427795 The time-to-live for the cache control breakpoint.2779627797 This may be one the following values:2779827799 - `5m`: 5 minutes27800 - `1h`: 1 hour2780127802 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2780327804 - `"5m"`2780527806 - `"1h"`2780727808 - `defer_loading: optional boolean`2780927810 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2781127812 - `max_uses: optional number or null`2781327814 Maximum number of times the tool can be used in the API request.2781527816 exclusiveMinimum: 02781727818 - `strict: optional boolean`2781927820 When true, guarantees schema validation on tool names and inputs2782127822 - `user_location: optional UserLocation or null`2782327824 Parameters for the user's location. Used to provide more relevant search results.2782527826 - `type: "approximate"`2782727828 - `city: optional string or null`2782927830 The city of the user.2783127832 maxLength: 255, minLength: 12783327834 - `country: optional string or null`2783527836 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.2783727838 maxLength: 2, minLength: 22783927840 - `region: optional string or null`2784127842 The region of the user.2784327844 maxLength: 255, minLength: 12784527846 - `timezone: optional string or null`2784727848 The [IANA timezone](https://nodatime.org/TimeZones) of the user.2784927850 maxLength: 255, minLength: 12785127852### Web Search Tool 202603182785327854- `WebSearchTool20260318 object`2785527856 - `type: "web_search_20260318"`2785727858 - `name: "web_search"`2785927860 Name of the tool.2786127862 This is how the tool will be called by the model and in `tool_use` blocks.2786327864 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2786527866 - `"direct"`2786727868 - `"code_execution_20250825"`2786927870 - `"code_execution_20260120"`2787127872 - `"code_execution_20260521"`2787327874 - `allowed_domains: optional array of string or null`2787527876 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.2787727878 - `blocked_domains: optional array of string or null`2787927880 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.2788127882 - `cache_control: optional CacheControlEphemeral or null`2788327884 Create a cache control breakpoint at this content block.2788527886 - `type: "ephemeral"`2788727888 - `ttl: optional "5m" or "1h"`2788927890 The time-to-live for the cache control breakpoint.2789127892 This may be one the following values:2789327894 - `5m`: 5 minutes27895 - `1h`: 1 hour2789627897 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2789827899 - `"5m"`2790027901 - `"1h"`2790227903 - `defer_loading: optional boolean`2790427905 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2790627907 - `max_uses: optional number or null`2790827909 Maximum number of times the tool can be used in the API request.2791027911 exclusiveMinimum: 02791227913 - `response_inclusion: optional "full" or "excluded"`2791427915 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.2791627917 - `"full"`2791827919 - `"excluded"`2792027921 - `strict: optional boolean`2792227923 When true, guarantees schema validation on tool names and inputs2792427925 - `user_location: optional UserLocation or null`2792627927 Parameters for the user's location. Used to provide more relevant search results.2792827929 - `type: "approximate"`2793027931 - `city: optional string or null`2793227933 The city of the user.2793427935 maxLength: 255, minLength: 12793627937 - `country: optional string or null`2793827939 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.2794027941 maxLength: 2, minLength: 22794227943 - `region: optional string or null`2794427945 The region of the user.2794627947 maxLength: 255, minLength: 12794827949 - `timezone: optional string or null`2795027951 The [IANA timezone](https://nodatime.org/TimeZones) of the user.2795227953 maxLength: 255, minLength: 12795427955### Web Search Tool Request Error2795627957- `WebSearchToolRequestError object`2795827959 - `type: "web_search_tool_result_error"`2796027961 - `error_code: WebSearchToolResultErrorCode`2796227963 - `"invalid_tool_input"`2796427965 - `"unavailable"`2796627967 - `"max_uses_exceeded"`2796827969 - `"too_many_requests"`2797027971 - `"query_too_long"`2797227973 - `"request_too_large"`2797427975### Web Search Tool Result Block2797627977- `WebSearchToolResultBlock object`2797827979 - `type: "web_search_tool_result"`2798027981 default: web_search_tool_result2798227983 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`2798427985 default: {"type":"direct"}2798627987 - `DirectCaller object`2798827989 Tool invocation directly from the model.2799027991 - `type: "direct"`2799227993 - `ServerToolCaller object`2799427995 Tool invocation generated by a server-side tool.2799627997 - `type: "code_execution_20250825"`2799827999 - `tool_id: string`2800028001 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2800228003 - `ServerToolCaller20260120 object`2800428005 - `type: "code_execution_20260120"`2800628007 - `tool_id: string`2800828009 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2801028011 - `content: WebSearchToolResultBlockContent`2801228013 - `WebSearchToolResultError object`2801428015 - `type: "web_search_tool_result_error"`2801628017 default: web_search_tool_result_error2801828019 - `error_code: WebSearchToolResultErrorCode`2802028021 - `"invalid_tool_input"`2802228023 - `"unavailable"`2802428025 - `"max_uses_exceeded"`2802628027 - `"too_many_requests"`2802828029 - `"query_too_long"`2803028031 - `"request_too_large"`2803228033 - `array of WebSearchResultBlock`2803428035 - `type: "web_search_result"`2803628037 default: web_search_result2803828039 - `encrypted_content: string`2804028041 - `page_age: string or null`2804228043 - `title: string`2804428045 - `url: string`2804628047 - `tool_use_id: string`2804828049 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2805028051### Web Search Tool Result Block Content2805228053- `WebSearchToolResultBlockContent = WebSearchToolResultError or array of WebSearchResultBlock`2805428055 - `WebSearchToolResultError object`2805628057 - `type: "web_search_tool_result_error"`2805828059 default: web_search_tool_result_error2806028061 - `error_code: WebSearchToolResultErrorCode`2806228063 - `"invalid_tool_input"`2806428065 - `"unavailable"`2806628067 - `"max_uses_exceeded"`2806828069 - `"too_many_requests"`2807028071 - `"query_too_long"`2807228073 - `"request_too_large"`2807428075 - `array of WebSearchResultBlock`2807628077 - `type: "web_search_result"`2807828079 default: web_search_result2808028081 - `encrypted_content: string`2808228083 - `page_age: string or null`2808428085 - `title: string`2808628087 - `url: string`2808828089### Web Search Tool Result Block Param2809028091- `WebSearchToolResultBlockParam object`2809228093 - `type: "web_search_tool_result"`2809428095 - `content: WebSearchToolResultBlockParamContent`2809628097 - `WebSearchToolResultBlockItem = array of WebSearchResultBlockParam`2809828099 - `type: "web_search_result"`2810028101 - `encrypted_content: string`2810228103 - `title: string`2810428105 - `url: string`2810628107 - `page_age: optional string or null`2810828109 - `WebSearchToolRequestError object`2811028111 - `type: "web_search_tool_result_error"`2811228113 - `error_code: WebSearchToolResultErrorCode`2811428115 - `"invalid_tool_input"`2811628117 - `"unavailable"`2811828119 - `"max_uses_exceeded"`2812028121 - `"too_many_requests"`2812228123 - `"query_too_long"`2812428125 - `"request_too_large"`2812628127 - `tool_use_id: string`2812828129 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2813028131 - `cache_control: optional CacheControlEphemeral or null`2813228133 Create a cache control breakpoint at this content block.2813428135 - `type: "ephemeral"`2813628137 - `ttl: optional "5m" or "1h"`2813828139 The time-to-live for the cache control breakpoint.2814028141 This may be one the following values:2814228143 - `5m`: 5 minutes28144 - `1h`: 1 hour2814528146 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2814728148 - `"5m"`2814928150 - `"1h"`2815128152 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`2815328154 - `DirectCaller object`2815528156 Tool invocation directly from the model.2815728158 - `type: "direct"`2815928160 - `ServerToolCaller object`2816128162 Tool invocation generated by a server-side tool.2816328164 - `type: "code_execution_20250825"`2816528166 - `tool_id: string`2816728168 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2816928170 - `ServerToolCaller20260120 object`2817128172 - `type: "code_execution_20260120"`2817328174 - `tool_id: string`2817528176 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2817728178### Web Search Tool Result Block Param Content2817928180- `WebSearchToolResultBlockParamContent = array of WebSearchResultBlockParam or WebSearchToolRequestError`2818128182 - `WebSearchToolResultBlockItem = array of WebSearchResultBlockParam`2818328184 - `type: "web_search_result"`2818528186 - `encrypted_content: string`2818728188 - `title: string`2818928190 - `url: string`2819128192 - `page_age: optional string or null`2819328194 - `WebSearchToolRequestError object`2819528196 - `type: "web_search_tool_result_error"`2819728198 - `error_code: WebSearchToolResultErrorCode`2819928200 - `"invalid_tool_input"`2820128202 - `"unavailable"`2820328204 - `"max_uses_exceeded"`2820528206 - `"too_many_requests"`2820728208 - `"query_too_long"`2820928210 - `"request_too_large"`2821128212### Web Search Tool Result Error2821328214- `WebSearchToolResultError object`2821528216 - `type: "web_search_tool_result_error"`2821728218 default: web_search_tool_result_error2821928220 - `error_code: WebSearchToolResultErrorCode`2822128222 - `"invalid_tool_input"`2822328224 - `"unavailable"`2822528226 - `"max_uses_exceeded"`2822728228 - `"too_many_requests"`2822928230 - `"query_too_long"`2823128232 - `"request_too_large"`2823328234### Web Search Tool Result Error Code2823528236- `WebSearchToolResultErrorCode = "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more`2823728238 - `"invalid_tool_input"`2823928240 - `"unavailable"`2824128242 - `"max_uses_exceeded"`2824328244 - `"too_many_requests"`2824528246 - `"query_too_long"`2824728248 - `"request_too_large"`2824928250## Messages › Batches2825128252### Create a Message Batch2825328254**POST** `/v1/messages/batches`2825528256Send a batch of Message creation requests.2825728258The 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.2825928260Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)2826128262#### Headers2826328264- `"anthropic-user-profile-id": optional string`2826528266 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.2826728268- `"anthropic-workspace-id": optional string`2826928270#### Body parameters2827128272- `requests: array of object`2827328274 List of requests for prompt completion. Each is an individual request to create a Message.2827528276 maxItems: 100000, minItems: 12827728278 - `custom_id: string`2827928280 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.2828128282 Must be unique for each request within the Message Batch.2828328284 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,64}$2828528286 - `params: object`2828728288 Messages API creation parameters for the individual request.2828928290 See the [Messages API reference](https://platform.claude.com/docs/en/api/messages) for full documentation on available parameters.2829128292 - `max_tokens: number`2829328294 The maximum number of tokens to generate before stopping.2829528296 Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.2829728298 Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#pre-warming-the-cache) without generating a response.2829928300 Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview) for details.2830128302 minimum: 02830328304 - `messages: array of MessageParam`2830528306 Input messages.2830728308 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.2830928310 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.2831128312 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.2831328314 Example with a single `user` message:2831528316 ```json28317 [{"role": "user", "content": "Hello, Claude"}]28318 ```2831928320 Example with multiple conversational turns:2832128322 ```json28323 [28324 {"role": "user", "content": "Hello there."},28325 {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"},28326 {"role": "user", "content": "Can you explain LLMs in plain English?"},28327 ]28328 ```2832928330 Example with a partially-filled response from Claude:2833128332 ```json28333 [28334 {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},28335 {"role": "assistant", "content": "The best answer is ("},28336 ]28337 ```2833828339 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:2834028341 ```json28342 {"role": "user", "content": "Hello, Claude"}28343 ```2834428345 ```json28346 {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]}28347 ```2834828349 See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages).2835028351 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#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API.2835228353 There is a limit of 100,000 messages in a single request.2835428355 - `content: string or array of ContentBlockParam`2835628357 - `string`2835828359 - `array of ContentBlockParam`2836028361 - `TextBlockParam object`2836228363 - `type: "text"`2836428365 - `text: string`2836628367 minLength: 12836828369 - `cache_control: optional CacheControlEphemeral or null`2837028371 Create a cache control breakpoint at this content block.2837228373 - `type: "ephemeral"`2837428375 - `ttl: optional "5m" or "1h"`2837628377 The time-to-live for the cache control breakpoint.2837828379 This may be one the following values:2838028381 - `5m`: 5 minutes28382 - `1h`: 1 hour2838328384 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.2838528386 - `"5m"`2838728388 - `"1h"`2838928390 - `citations: optional array of TextCitationParam or null`2839128392 - `CitationCharLocationParam object`2839328394 - `type: "char_location"`2839528396 - `cited_text: string`2839728398 - `document_index: number`2839928400 minimum: 02840128402 - `document_title: string or null`2840328404 maxLength: 500, minLength: 12840528406 - `end_char_index: number`2840728408 - `start_char_index: number`2840928410 minimum: 02841128412 - `CitationPageLocationParam object`2841328414 - `type: "page_location"`2841528416 - `cited_text: string`2841728418 - `document_index: number`2841928420 minimum: 02842128422 - `document_title: string or null`2842328424 maxLength: 500, minLength: 12842528426 - `end_page_number: number`2842728428 - `start_page_number: number`2842928430 minimum: 12843128432 - `CitationContentBlockLocationParam object`2843328434 - `type: "content_block_location"`2843528436 - `cited_text: string`2843728438 The full text of the cited block range, concatenated.2843928440 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.2844128442 - `document_index: number`2844328444 minimum: 02844528446 - `document_title: string or null`2844728448 maxLength: 500, minLength: 12844928450 - `end_block_index: number`2845128452 Exclusive 0-based end index of the cited block range in the source's `content` array.2845328454 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2845528456 - `start_block_index: number`2845728458 0-based index of the first cited block in the source's `content` array.2845928460 minimum: 02846128462 - `CitationWebSearchResultLocationParam object`2846328464 - `type: "web_search_result_location"`2846528466 - `cited_text: string`2846728468 - `encrypted_index: string`2846928470 - `title: string or null`2847128472 maxLength: 512, minLength: 12847328474 - `url: string`2847528476 minLength: 12847728478 - `CitationSearchResultLocationParam object`2847928480 - `type: "search_result_location"`2848128482 - `cited_text: string`2848328484 The full text of the cited block range, concatenated.2848528486 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.2848728488 - `end_block_index: number`2848928490 Exclusive 0-based end index of the cited block range in the source's `content` array.2849128492 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.2849328494 - `search_result_index: number`2849528496 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.2849728498 Counted separately from `document_index`; server-side web search results are not included in this count.2849928500 minimum: 02850128502 - `source: string`2850328504 - `start_block_index: number`2850528506 0-based index of the first cited block in the source's `content` array.2850728508 minimum: 02850928510 - `title: string or null`2851128512 - `ImageBlockParam object`2851328514 - `type: "image"`2851528516 - `source: Base64ImageSource or URLImageSource or FileImageSource`2851728518 - `Base64ImageSource object`2851928520 - `type: "base64"`2852128522 - `data: string`2852328524 format: byte2852528526 - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"`2852728528 - `"image/jpeg"`2852928530 - `"image/png"`2853128532 - `"image/gif"`2853328534 - `"image/webp"`2853528536 - `URLImageSource object`2853728538 - `type: "url"`2853928540 - `url: string`2854128542 - `FileImageSource object`2854328544 - `type: "file"`2854528546 - `file_id: string`2854728548 - `cache_control: optional CacheControlEphemeral or null`2854928550 Create a cache control breakpoint at this content block.2855128552 - `transformations: optional ImageTransformationsParam or null`2855328554 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.2855528556 - `oversized_image: optional "downsize" or "error"`2855728558 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.2855928560 - `"downsize"`2856128562 - `"error"`2856328564 - `DocumentBlockParam object`2856528566 - `type: "document"`2856728568 - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more`2856928570 - `Base64PDFSource object`2857128572 - `type: "base64"`2857328574 - `data: string`2857528576 format: byte2857728578 - `media_type: "application/pdf"`2857928580 - `PlainTextSource object`2858128582 - `type: "text"`2858328584 - `data: string`2858528586 - `media_type: "text/plain"`2858728588 - `ContentBlockSource object`2858928590 - `type: "content"`2859128592 - `content: string or array of ContentBlockSourceContent`2859328594 - `string`2859528596 - `ContentBlockSourceContent = array of ContentBlockSourceContent`2859728598 - `TextBlockParam object`2859928600 - `ImageBlockParam object`2860128602 - `URLPDFSource object`2860328604 - `type: "url"`2860528606 - `url: string`2860728608 - `FileDocumentSource object`2860928610 - `type: "file"`2861128612 - `file_id: string`2861328614 - `cache_control: optional CacheControlEphemeral or null`2861528616 Create a cache control breakpoint at this content block.2861728618 - `citations: optional CitationsConfigParam or null`2861928620 - `enabled: optional boolean`2862128622 - `context: optional string or null`2862328624 minLength: 12862528626 - `title: optional string or null`2862728628 maxLength: 500, minLength: 12862928630 - `SearchResultBlockParam object`2863128632 - `type: "search_result"`2863328634 - `content: array of TextBlockParam`2863528636 - `type: "text"`2863728638 - `text: string`2863928640 minLength: 12864128642 - `cache_control: optional CacheControlEphemeral or null`2864328644 Create a cache control breakpoint at this content block.2864528646 - `citations: optional array of TextCitationParam or null`2864728648 - `source: string`2864928650 - `title: string`2865128652 - `cache_control: optional CacheControlEphemeral or null`2865328654 Create a cache control breakpoint at this content block.2865528656 - `citations: optional CitationsConfigParam`2865728658 - `ThinkingBlockParam object`2865928660 - `type: "thinking"`2866128662 - `signature: string`2866328664 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.2866528666 Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`.2866728668 - `thinking: string`2866928670 The `thinking` text of this block as returned by the API.2867128672 - `RedactedThinkingBlockParam object`2867328674 - `type: "redacted_thinking"`2867528676 - `data: string`2867728678 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.2867928680 - `ToolUseBlockParam object`2868128682 - `type: "tool_use"`2868328684 - `id: string`2868528686 pattern: ^[a-zA-Z0-9_-]+$2868728688 - `input: map[unknown]`2868928690 - `name: string`2869128692 maxLength: 200, minLength: 12869328694 - `cache_control: optional CacheControlEphemeral or null`2869528696 Create a cache control breakpoint at this content block.2869728698 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`2869928700 - `DirectCaller object`2870128702 Tool invocation directly from the model.2870328704 - `type: "direct"`2870528706 - `ServerToolCaller object`2870728708 Tool invocation generated by a server-side tool.2870928710 - `type: "code_execution_20250825"`2871128712 - `tool_id: string`2871328714 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2871528716 - `ServerToolCaller20260120 object`2871728718 - `type: "code_execution_20260120"`2871928720 - `tool_id: string`2872128722 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2872328724 - `toolset_name: optional string or null`2872528726 For a toolset member tool_use, the toolset family this member belongs to.2872728728 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$2872928730 - `ToolResultBlockParam object`2873128732 - `type: "tool_result"`2873328734 - `tool_use_id: string`2873528736 pattern: ^[a-zA-Z0-9_-]+$2873728738 - `cache_control: optional CacheControlEphemeral or null`2873928740 Create a cache control breakpoint at this content block.2874128742 - `content: optional string or array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 3 more`2874328744 - `string`2874528746 - `array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 3 more`2874728748 - `TextBlockParam object`2874928750 - `ImageBlockParam object`2875128752 - `SearchResultBlockParam object`2875328754 - `DocumentBlockParam object`2875528756 - `ToolReferenceBlockParam object`2875728758 Tool reference block that can be included in tool_result content.2875928760 - `type: "tool_reference"`2876128762 - `tool_name: string`2876328764 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$2876528766 - `cache_control: optional CacheControlEphemeral or null`2876728768 Create a cache control breakpoint at this content block.2876928770 - `BrowserStateBlockParam object`2877128772 The caller's browser state after a browser toolset member call —28773 the full inventory of open tabs, which tab is active, and any side28774 effects (tabs opened, download state changes) the call produced.2877528776 At most one per `tool_result`, only on a non-error result answering a28777 browser toolset member `tool_use`. The server renders the28778 model-visible text from it; the model never sees the raw fields.2877928780 - `type: "browser_state"`2878128782 - `tabs: array of BrowserStateTabEntry`2878328784 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`.2878528786 maxItems: 1002878728788 - `tab_id: string`2878928790 The caller-assigned identifier for this tab, unique within the inventory.2879128792 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2879328794 - `title: string`2879528796 The title of the page the tab is showing. May be empty.2879728798 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2879928800 - `url: string`2880128802 The URL of the page the tab is showing. May be empty.2880328804 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2880528806 - `active: optional boolean`2880728808 Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.2880928810 - `cache_control: optional CacheControlEphemeral or null`2881128812 Create a cache control breakpoint at this content block.2881328814 - `state_changes: optional array of BrowserStateChange or null`2881528816 Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list.2881728818 maxItems: 200, minItems: 12881928820 - `BrowserStateChangeTabOpened object`2882128822 A tab this call's execution opened that remains open at its end —28823 the creation delta of the `tabs` inventory, not an event log.2882428825 Carries only the `tab_id`; the tab's `title` and `url` live on its28826 `tabs` entry, which must include the same `tab_id`. A tab opened28827 during a failed call gets no deferred `tab_opened`; it simply appears28828 in the next result's `tabs` inventory.2882928830 - `type: "tab_opened"`2883128832 - `tab_id: string`2883328834 The `tab_id` of the opened tab, present in `tabs`.2883528836 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2883728838 - `BrowserStateChangeDownloadStarted object`2883928840 A file download that started during this call.2884128842 - `type: "download_started"`2884328844 - `download_id: string`2884528846 The caller-assigned identifier for this download, stable across the state changes reporting it.2884728848 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2884928850 - `url: string`2885128852 The final post-redirect URL the download was served from.2885328854 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2885528856 - `BrowserStateChangeDownloadCompleted object`2885728858 A file download that finished during this call, reported with the28859 same `download_id` as its `download_started` — or without a prior28860 `download_started`, when the download finished during the call that28861 started it (at most one state change per `download_id` per result).2886228863 - `type: "download_completed"`2886428865 - `download_id: string`2886628867 The caller-assigned identifier for this download, stable across the state changes reporting it.2886828869 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2887028871 - `url: string`2887228873 The final post-redirect URL the download was served from.2887428875 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2887628877 - `path: optional string or null`2887828879 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.2888028881 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 40962888228883 - `size_bytes: optional number or null`2888428885 The completed download's size.2888628887 minimum: 02888828889 - `BrowserStateChangeDownloadFailed object`2889028891 A file download that failed — or was cancelled — during this call.2889228893 - `type: "download_failed"`2889428895 - `download_id: string`2889628897 The caller-assigned identifier for this download, stable across the state changes reporting it.2889828899 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2890028901 - `url: string`2890228903 The final post-redirect URL the download was served from.2890428905 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$2890628907 - `error: optional string or null`2890828909 The failure or cancellation detail, when known.2891028911 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 40962891228913 - `is_error: optional boolean`2891428915 - `toolset_name: optional string or null`2891628917 For a toolset member tool_result, the toolset family of the paired tool_use.2891828919 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$2892028921 - `ServerToolUseBlockParam object`2892228923 - `type: "server_tool_use"`2892428925 - `id: string`2892628927 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2892828929 - `input: map[unknown]`2893028931 - `name: "web_search" or "web_fetch" or "code_execution" or 4 more`2893228933 - `"web_search"`2893428935 - `"web_fetch"`2893628937 - `"code_execution"`2893828939 - `"bash_code_execution"`2894028941 - `"text_editor_code_execution"`2894228943 - `"tool_search_tool_regex"`2894428945 - `"tool_search_tool_bm25"`2894628947 - `cache_control: optional CacheControlEphemeral or null`2894828949 Create a cache control breakpoint at this content block.2895028951 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`2895228953 - `DirectCaller object`2895428955 Tool invocation directly from the model.2895628957 - `ServerToolCaller object`2895828959 Tool invocation generated by a server-side tool.2896028961 - `ServerToolCaller20260120 object`2896228963 - `WebSearchToolResultBlockParam object`2896428965 - `type: "web_search_tool_result"`2896628967 - `content: WebSearchToolResultBlockParamContent`2896828969 - `WebSearchToolResultBlockItem = array of WebSearchResultBlockParam`2897028971 - `type: "web_search_result"`2897228973 - `encrypted_content: string`2897428975 - `title: string`2897628977 - `url: string`2897828979 - `page_age: optional string or null`2898028981 - `WebSearchToolRequestError object`2898228983 - `type: "web_search_tool_result_error"`2898428985 - `error_code: WebSearchToolResultErrorCode`2898628987 - `"invalid_tool_input"`2898828989 - `"unavailable"`2899028991 - `"max_uses_exceeded"`2899228993 - `"too_many_requests"`2899428995 - `"query_too_long"`2899628997 - `"request_too_large"`2899828999 - `tool_use_id: string`2900029001 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2900229003 - `cache_control: optional CacheControlEphemeral or null`2900429005 Create a cache control breakpoint at this content block.2900629007 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`2900829009 - `DirectCaller object`2901029011 Tool invocation directly from the model.2901229013 - `ServerToolCaller object`2901429015 Tool invocation generated by a server-side tool.2901629017 - `ServerToolCaller20260120 object`2901829019 - `WebFetchToolResultBlockParam object`2902029021 - `type: "web_fetch_tool_result"`2902229023 - `content: WebFetchToolResultErrorBlockParam or WebFetchBlockParam`2902429025 - `WebFetchToolResultErrorBlockParam object`2902629027 - `type: "web_fetch_tool_result_error"`2902829029 - `error_code: WebFetchToolResultErrorCode`2903029031 - `"invalid_tool_input"`2903229033 - `"url_too_long"`2903429035 - `"url_not_allowed"`2903629037 - `"url_not_in_prior_context"`2903829039 - `"url_not_accessible"`2904029041 - `"unsupported_content_type"`2904229043 - `"too_many_requests"`2904429045 - `"max_uses_exceeded"`2904629047 - `"unavailable"`2904829049 - `"content_too_large"`2905029051 - `WebFetchBlockParam object`2905229053 - `type: "web_fetch_result"`2905429055 - `content: DocumentBlockParam`2905629057 - `url: string`2905829059 Fetched content URL2906029061 - `retrieved_at: optional string or null`2906229063 ISO 8601 timestamp when the content was retrieved2906429065 - `tool_use_id: string`2906629067 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2906829069 - `cache_control: optional CacheControlEphemeral or null`2907029071 Create a cache control breakpoint at this content block.2907229073 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`2907429075 - `DirectCaller object`2907629077 Tool invocation directly from the model.2907829079 - `ServerToolCaller object`2908029081 Tool invocation generated by a server-side tool.2908229083 - `ServerToolCaller20260120 object`2908429085 - `CodeExecutionToolResultBlockParam object`2908629087 - `type: "code_execution_tool_result"`2908829089 - `content: CodeExecutionToolResultBlockParamContent`2909029091 - `CodeExecutionToolResultErrorParam object`2909229093 - `type: "code_execution_tool_result_error"`2909429095 - `error_code: CodeExecutionToolResultErrorCode`2909629097 - `"invalid_tool_input"`2909829099 - `"unavailable"`2910029101 - `"too_many_requests"`2910229103 - `"execution_time_exceeded"`2910429105 - `CodeExecutionResultBlockParam object`2910629107 - `type: "code_execution_result"`2910829109 - `content: array of CodeExecutionOutputBlockParam`2911029111 - `type: "code_execution_output"`2911229113 - `file_id: string`2911429115 - `return_code: number`2911629117 - `stderr: string`2911829119 - `stdout: string`2912029121 - `EncryptedCodeExecutionResultBlockParam object`2912229123 Code execution result with encrypted stdout for PFC + web_search results.2912429125 - `type: "encrypted_code_execution_result"`2912629127 - `content: array of CodeExecutionOutputBlockParam`2912829129 - `type: "code_execution_output"`2913029131 - `file_id: string`2913229133 - `encrypted_stdout: string`2913429135 - `return_code: number`2913629137 - `stderr: string`2913829139 - `tool_use_id: string`2914029141 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2914229143 - `cache_control: optional CacheControlEphemeral or null`2914429145 Create a cache control breakpoint at this content block.2914629147 - `BashCodeExecutionToolResultBlockParam object`2914829149 - `type: "bash_code_execution_tool_result"`2915029151 - `content: BashCodeExecutionToolResultErrorParam or BashCodeExecutionResultBlockParam`2915229153 - `BashCodeExecutionToolResultErrorParam object`2915429155 - `type: "bash_code_execution_tool_result_error"`2915629157 - `error_code: BashCodeExecutionToolResultErrorCode`2915829159 - `"invalid_tool_input"`2916029161 - `"unavailable"`2916229163 - `"too_many_requests"`2916429165 - `"execution_time_exceeded"`2916629167 - `"output_file_too_large"`2916829169 - `BashCodeExecutionResultBlockParam object`2917029171 - `type: "bash_code_execution_result"`2917229173 - `content: array of BashCodeExecutionOutputBlockParam`2917429175 - `type: "bash_code_execution_output"`2917629177 - `file_id: string`2917829179 - `return_code: number`2918029181 - `stderr: string`2918229183 - `stdout: string`2918429185 - `tool_use_id: string`2918629187 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2918829189 - `cache_control: optional CacheControlEphemeral or null`2919029191 Create a cache control breakpoint at this content block.2919229193 - `TextEditorCodeExecutionToolResultBlockParam object`2919429195 - `type: "text_editor_code_execution_tool_result"`2919629197 - `content: TextEditorCodeExecutionToolResultErrorParam or TextEditorCodeExecutionViewResultBlockParam or TextEditorCodeExecutionCreateResultBlockParam or TextEditorCodeExecutionStrReplaceResultBlockParam`2919829199 - `TextEditorCodeExecutionToolResultErrorParam object`2920029201 - `type: "text_editor_code_execution_tool_result_error"`2920229203 - `error_code: TextEditorCodeExecutionToolResultErrorCode`2920429205 - `"invalid_tool_input"`2920629207 - `"unavailable"`2920829209 - `"too_many_requests"`2921029211 - `"execution_time_exceeded"`2921229213 - `"file_not_found"`2921429215 - `error_message: optional string or null`2921629217 - `TextEditorCodeExecutionViewResultBlockParam object`2921829219 - `type: "text_editor_code_execution_view_result"`2922029221 - `content: string`2922229223 - `file_type: "text" or "image" or "pdf"`2922429225 - `"text"`2922629227 - `"image"`2922829229 - `"pdf"`2923029231 - `num_lines: optional number or null`2923229233 - `start_line: optional number or null`2923429235 - `total_lines: optional number or null`2923629237 - `TextEditorCodeExecutionCreateResultBlockParam object`2923829239 - `type: "text_editor_code_execution_create_result"`2924029241 - `is_file_update: boolean`2924229243 - `TextEditorCodeExecutionStrReplaceResultBlockParam object`2924429245 - `type: "text_editor_code_execution_str_replace_result"`2924629247 - `lines: optional array of string or null`2924829249 - `new_lines: optional number or null`2925029251 - `new_start: optional number or null`2925229253 - `old_lines: optional number or null`2925429255 - `old_start: optional number or null`2925629257 - `tool_use_id: string`2925829259 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2926029261 - `cache_control: optional CacheControlEphemeral or null`2926229263 Create a cache control breakpoint at this content block.2926429265 - `ToolSearchToolResultBlockParam object`2926629267 - `type: "tool_search_tool_result"`2926829269 - `content: ToolSearchToolResultErrorParam or ToolSearchToolSearchResultBlockParam`2927029271 - `ToolSearchToolResultErrorParam object`2927229273 - `type: "tool_search_tool_result_error"`2927429275 - `error_code: ToolSearchToolResultErrorCode`2927629277 - `"invalid_tool_input"`2927829279 - `"unavailable"`2928029281 - `"too_many_requests"`2928229283 - `"execution_time_exceeded"`2928429285 - `error_message: optional string or null`2928629287 - `ToolSearchToolSearchResultBlockParam object`2928829289 - `type: "tool_search_tool_search_result"`2929029291 - `tool_references: array of ToolReferenceBlockParam`2929229293 - `type: "tool_reference"`2929429295 - `tool_name: string`2929629297 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$2929829299 - `cache_control: optional CacheControlEphemeral or null`2930029301 Create a cache control breakpoint at this content block.2930229303 - `tool_use_id: string`2930429305 pattern: ^srvtoolu_[a-zA-Z0-9_]+$2930629307 - `cache_control: optional CacheControlEphemeral or null`2930829309 Create a cache control breakpoint at this content block.2931029311 - `ContainerUploadBlockParam object`2931229313 A content block that represents a file to be uploaded to the container29314 Files uploaded via this block will be available in the container's input directory.2931529316 - `type: "container_upload"`2931729318 - `file_id: string`2931929320 - `cache_control: optional CacheControlEphemeral or null`2932129322 Create a cache control breakpoint at this content block.2932329324 - `role: "user" or "assistant" or "system"`2932529326 - `"user"`2932729328 - `"assistant"`2932929330 - `"system"`2933129332 - `model: Model`2933329334 The model that will complete your prompt.2933529336 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.2933729338 - `"claude-fable-5-1" or "claude-mythos-5-1" or "claude-sonnet-5" or 14 more`2933929340 The model that will complete your prompt.2934129342 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.2934329344 - `"claude-fable-5-1"`2934529346 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows2934729348 - `"claude-mythos-5-1"`2934929350 Our most capable model for cybersecurity and biology research, available through trusted access programs2935129352 - `"claude-sonnet-5"`2935329354 High-performance model for coding and agents2935529356 - `"claude-fable-5"`2935729358 Next generation of intelligence for the hardest knowledge work and coding problems2935929360 - `"claude-mythos-5"`2936129362 Most capable model for cybersecurity and biology research2936329364 - `"claude-opus-5"`2936529366 Powerful intelligence for long-running agents and coding2936729368 - `"claude-opus-4-8"`2936929370 Powerful intelligence for long-running agents and coding2937129372 - `"claude-opus-4-7"`2937329374 Powerful intelligence for long-running agents and coding2937529376 - `"claude-mythos-preview"`2937729378 New class of intelligence, strongest in coding and cybersecurity2937929380 - `"claude-opus-4-6"`2938129382 Powerful intelligence for long-running agents and coding2938329384 - `"claude-sonnet-4-6"`2938529386 Best combination of speed and intelligence2938729388 - `"claude-haiku-4-5"`2938929390 Fastest model with near-frontier intelligence2939129392 - `"claude-haiku-4-5-20251001"`2939329394 Fastest model with near-frontier intelligence2939529396 - `"claude-opus-4-5"`2939729398 Powerful intelligence for long-running agents and coding2939929400 - `"claude-opus-4-5-20251101"`2940129402 Powerful intelligence for long-running agents and coding2940329404 - `"claude-sonnet-4-5"`2940529406 High-performance model for agents and coding2940729408 - `"claude-sonnet-4-5-20250929"`2940929410 High-performance model for agents and coding2941129412 - `string`2941329414 - `cache_control: optional CacheControlEphemeral or null`2941529416 Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.2941729418 - `container: optional MessageCreateParamsContainer or null`2941929420 Container identifier for reuse across requests.2942129422 - `ContainerParams object`2942329424 Container parameters with skills to be loaded.2942529426 - `id: optional string or null`2942729428 Container id2942929430 - `skills: optional array of SkillParams or null`2943129432 List of skills to load in the container2943329434 maxItems: 202943529436 - `type: "anthropic" or "custom"`2943729438 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)2943929440 - `"anthropic"`2944129442 - `"custom"`2944329444 - `skill_id: string`2944529446 Skill ID2944729448 maxLength: 64, minLength: 12944929450 - `version: optional string`2945129452 Skill version or 'latest' for most recent version2945329454 maxLength: 64, minLength: 12945529456 - `string`2945729458 - `inference_geo: optional string or null`2945929460 Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used.2946129462 - `metadata: optional Metadata`2946329464 An object describing metadata about the request.2946529466 - `user_id: optional string or null`2946729468 An external identifier for the user who is associated with the request.2946929470 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.2947129472 maxLength: 5122947329474 - `output_config: optional OutputConfig`2947529476 Configuration options for the model's output, such as the output format.2947729478 - `effort: optional "low" or "medium" or "high" or 2 more or null`2947929480 All possible effort levels.2948129482 - `"low"`2948329484 - `"medium"`2948529486 - `"high"`2948729488 - `"xhigh"`2948929490 - `"max"`2949129492 - `format: optional JSONOutputFormat or null`2949329494 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)2949529496 - `type: "json_schema"`2949729498 - `schema: map[unknown]`2949929500 The JSON schema of the format2950129502 - `service_tier: optional "auto" or "standard_only"`2950329504 Determines whether to use priority capacity (if available) or standard capacity for this request.2950529506 Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers) for details.2950729508 - `"auto"`2950929510 - `"standard_only"`2951129512 - `stop_sequences: optional array of string`2951329514 Custom text sequences that will cause the model to stop generating.2951529516 Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`.2951729518 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.2951929520 - `stream: optional boolean`2952129522 Whether to incrementally stream the response using server-sent events.2952329524 See [streaming](https://platform.claude.com/docs/en/build-with-claude/streaming) for details.2952529526 - `system: optional string or array of TextBlockParam`2952729528 System prompt.2952929530 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#give-claude-a-role).2953129532 - `string`2953329534 - `array of TextBlockParam`2953529536 - `type: "text"`2953729538 - `text: string`2953929540 minLength: 12954129542 - `cache_control: optional CacheControlEphemeral or null`2954329544 Create a cache control breakpoint at this content block.2954529546 - `citations: optional array of TextCitationParam or null`2954729548 - `thinking: optional ThinkingConfigParam`2954929550 Configuration for enabling Claude's extended thinking.2955129552 When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit.2955329554 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.2955529556 - `ThinkingConfigEnabled object`2955729558 - `type: "enabled"`2955929560 - `budget_tokens: number`2956129562 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.2956329564 Must be ≥1024 and less than `max_tokens`.2956529566 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.2956729568 minimum: 10242956929570 - `display: optional "summarized" or "omitted" or null`2957129572 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`.2957329574 - `"summarized"`2957529576 - `"omitted"`2957729578 - `ThinkingConfigDisabled object`2957929580 - `type: "disabled"`2958129582 - `ThinkingConfigAdaptive object`2958329584 - `type: "adaptive"`2958529586 - `display: optional "summarized" or "omitted" or null`2958729588 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`.2958929590 - `"summarized"`2959129592 - `"omitted"`2959329594 - `tool_choice: optional ToolChoice`2959529596 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.2959729598 - `ToolChoiceAuto object`2959929600 The model will automatically decide whether to use tools.2960129602 - `type: "auto"`2960329604 - `disable_parallel_tool_use: optional boolean`2960529606 Whether to disable parallel tool use.2960729608 Defaults to `false`. If set to `true`, the model will output at most one tool use.2960929610 - `ToolChoiceAny object`2961129612 The model will use any available tools.2961329614 - `type: "any"`2961529616 - `disable_parallel_tool_use: optional boolean`2961729618 Whether to disable parallel tool use.2961929620 Defaults to `false`. If set to `true`, the model will output exactly one tool use.2962129622 - `ToolChoiceTool object`2962329624 The model will use the specified tool with `tool_choice.name`.2962529626 - `type: "tool"`2962729628 - `name: string`2962929630 The name of the tool to use.2963129632 - `disable_parallel_tool_use: optional boolean`2963329634 Whether to disable parallel tool use.2963529636 Defaults to `false`. If set to `true`, the model will output exactly one tool use.2963729638 - `ToolChoiceNone object`2963929640 The model will not be allowed to use tools.2964129642 - `type: "none"`2964329644 - `tools: optional array of ToolUnion`2964529646 Definitions of tools that the model may use.2964729648 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.2964929650 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), 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)).2965129652 Each tool definition includes:2965329654 * `name`: Name of the tool.29655 * `description`: Optional, but strongly-recommended description of the tool.29656 * `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.2965729658 For example, if you defined `tools` as:2965929660 ```json29661 [29662 {29663 "name": "get_stock_price",29664 "description": "Get the current stock price for a given ticker symbol.",29665 "input_schema": {29666 "type": "object",29667 "properties": {29668 "ticker": {29669 "type": "string",29670 "description": "The stock ticker symbol, e.g. AAPL for Apple Inc."29671 }29672 },29673 "required": ["ticker"]29674 }29675 }29676 ]29677 ```2967829679 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:2968029681 ```json29682 [29683 {29684 "type": "tool_use",29685 "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",29686 "name": "get_stock_price",29687 "input": { "ticker": "^GSPC" }29688 }29689 ]29690 ```2969129692 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:2969329694 ```json29695 [29696 {29697 "type": "tool_result",29698 "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",29699 "content": "259.75 USD"29700 }29701 ]29702 ```2970329704 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.2970529706 See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details.2970729708 - `Tool object`2970929710 - `type: optional "custom" or null`2971129712 - `input_schema: object`2971329714 [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.2971529716 This defines the shape of the `input` that your tool accepts and that the model will produce.2971729718 - `type: "object"`2971929720 - `properties: optional map[unknown] or null`2972129722 - `required: optional array of string or null`2972329724 - `name: string`2972529726 Name of the tool.2972729728 This is how the tool will be called by the model and in `tool_use` blocks.2972929730 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$2973129732 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2973329734 - `"direct"`2973529736 - `"code_execution_20250825"`2973729738 - `"code_execution_20260120"`2973929740 - `"code_execution_20260521"`2974129742 - `cache_control: optional CacheControlEphemeral or null`2974329744 Create a cache control breakpoint at this content block.2974529746 - `defer_loading: optional boolean`2974729748 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2974929750 - `description: optional string`2975129752 Description of what this tool does.2975329754 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.2975529756 - `eager_input_streaming: optional boolean or null`2975729758 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.2975929760 - `input_examples: optional array of map[unknown]`2976129762 - `strict: optional boolean`2976329764 When true, guarantees schema validation on tool names and inputs2976529766 - `ToolBash20250124 object`2976729768 - `type: "bash_20250124"`2976929770 - `name: "bash"`2977129772 Name of the tool.2977329774 This is how the tool will be called by the model and in `tool_use` blocks.2977529776 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2977729778 - `"direct"`2977929780 - `"code_execution_20250825"`2978129782 - `"code_execution_20260120"`2978329784 - `"code_execution_20260521"`2978529786 - `cache_control: optional CacheControlEphemeral or null`2978729788 Create a cache control breakpoint at this content block.2978929790 - `defer_loading: optional boolean`2979129792 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2979329794 - `input_examples: optional array of map[unknown]`2979529796 - `strict: optional boolean`2979729798 When true, guarantees schema validation on tool names and inputs2979929800 - `CodeExecutionTool20250522 object`2980129802 - `type: "code_execution_20250522"`2980329804 - `name: "code_execution"`2980529806 Name of the tool.2980729808 This is how the tool will be called by the model and in `tool_use` blocks.2980929810 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2981129812 - `"direct"`2981329814 - `"code_execution_20250825"`2981529816 - `"code_execution_20260120"`2981729818 - `"code_execution_20260521"`2981929820 - `cache_control: optional CacheControlEphemeral or null`2982129822 Create a cache control breakpoint at this content block.2982329824 - `defer_loading: optional boolean`2982529826 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2982729828 - `strict: optional boolean`2982929830 When true, guarantees schema validation on tool names and inputs2983129832 - `CodeExecutionTool20250825 object`2983329834 - `type: "code_execution_20250825"`2983529836 - `name: "code_execution"`2983729838 Name of the tool.2983929840 This is how the tool will be called by the model and in `tool_use` blocks.2984129842 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2984329844 - `"direct"`2984529846 - `"code_execution_20250825"`2984729848 - `"code_execution_20260120"`2984929850 - `"code_execution_20260521"`2985129852 - `cache_control: optional CacheControlEphemeral or null`2985329854 Create a cache control breakpoint at this content block.2985529856 - `defer_loading: optional boolean`2985729858 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2985929860 - `strict: optional boolean`2986129862 When true, guarantees schema validation on tool names and inputs2986329864 - `CodeExecutionTool20260120 object`2986529866 Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).2986729868 - `type: "code_execution_20260120"`2986929870 - `name: "code_execution"`2987129872 Name of the tool.2987329874 This is how the tool will be called by the model and in `tool_use` blocks.2987529876 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2987729878 - `"direct"`2987929880 - `"code_execution_20250825"`2988129882 - `"code_execution_20260120"`2988329884 - `"code_execution_20260521"`2988529886 - `cache_control: optional CacheControlEphemeral or null`2988729888 Create a cache control breakpoint at this content block.2988929890 - `defer_loading: optional boolean`2989129892 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2989329894 - `strict: optional boolean`2989529896 When true, guarantees schema validation on tool names and inputs2989729898 - `CodeExecutionTool20260521 object`2989929900 Code execution tool with REPL state persistence.2990129902 - `type: "code_execution_20260521"`2990329904 - `name: "code_execution"`2990529906 Name of the tool.2990729908 This is how the tool will be called by the model and in `tool_use` blocks.2990929910 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`2991129912 - `"direct"`2991329914 - `"code_execution_20250825"`2991529916 - `"code_execution_20260120"`2991729918 - `"code_execution_20260521"`2991929920 - `cache_control: optional CacheControlEphemeral or null`2992129922 Create a cache control breakpoint at this content block.2992329924 - `defer_loading: optional boolean`2992529926 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.2992729928 - `strict: optional boolean`2992929930 When true, guarantees schema validation on tool names and inputs2993129932 - `BrowserToolset20260801 object`2993329934 The browser toolset: a single `tools[]` entry (carrying no29935 `name`) that declares the browser tool family. The model is served29936 the family's tool with any members disabled via `configs` removed29937 from its schema.2993829939 - `type: "browser_toolset_20260801"`2994029941 - `cache_control: optional CacheControlEphemeral or null`2994229943 Create a cache control breakpoint at this content block.2994429945 - `configs: optional BrowserToolsetConfigs or null`2994629947 Per-member configuration for `browser_toolset_20260801`: one29948 optional field per member tool, keyed by the member name — the same29949 name the member's `tool_use` blocks carry. Every member is an29950 accepted key, and a member's defaults apply wherever its key is29951 absent. Unknown keys are rejected: the field set is this toolset29952 version's complete member set.2995329954 - `type: optional BrowserTypeConfig or null`2995529956 `type`'s config overrides.2995729958 - `defer_loading: optional boolean or null`2995929960 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2996129962 - `enabled: optional boolean or null`2996329964 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2996529966 - `close_tab: optional BrowserCloseTabConfig or null`2996729968 `close_tab`'s config overrides.2996929970 - `defer_loading: optional boolean or null`2997129972 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2997329974 - `enabled: optional boolean or null`2997529976 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2997729978 - `double_click: optional BrowserDoubleClickConfig or null`2997929980 `double_click`'s config overrides.2998129982 - `defer_loading: optional boolean or null`2998329984 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2998529986 - `enabled: optional boolean or null`2998729988 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.2998929990 - `file_upload: optional BrowserFileUploadConfig or null`2999129992 `file_upload`'s config overrides.2999329994 - `defer_loading: optional boolean or null`2999529996 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.2999729998 - `enabled: optional boolean or null`2999930000 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3000130002 - `find: optional BrowserFindConfig or null`3000330004 `find`'s config overrides.3000530006 - `defer_loading: optional boolean or null`3000730008 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3000930010 - `enabled: optional boolean or null`3001130012 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3001330014 - `form_input: optional BrowserFormInputConfig or null`3001530016 `form_input`'s config overrides.3001730018 - `defer_loading: optional boolean or null`3001930020 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3002130022 - `enabled: optional boolean or null`3002330024 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3002530026 - `get_page_text: optional BrowserGetPageTextConfig or null`3002730028 `get_page_text`'s config overrides.3002930030 - `defer_loading: optional boolean or null`3003130032 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3003330034 - `enabled: optional boolean or null`3003530036 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3003730038 - `hold_key: optional BrowserHoldKeyConfig or null`3003930040 `hold_key`'s config overrides.3004130042 - `defer_loading: optional boolean or null`3004330044 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3004530046 - `enabled: optional boolean or null`3004730048 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3004930050 - `hover: optional BrowserHoverConfig or null`3005130052 `hover`'s config overrides.3005330054 - `defer_loading: optional boolean or null`3005530056 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3005730058 - `enabled: optional boolean or null`3005930060 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3006130062 - `javascript_exec: optional BrowserJavascriptExecConfig or null`3006330064 `javascript_exec`'s config overrides.3006530066 - `defer_loading: optional boolean or null`3006730068 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3006930070 - `enabled: optional boolean or null`3007130072 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3007330074 - `key: optional BrowserKeyConfig or null`3007530076 `key`'s config overrides.3007730078 - `defer_loading: optional boolean or null`3007930080 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3008130082 - `enabled: optional boolean or null`3008330084 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3008530086 - `left_click: optional BrowserLeftClickConfig or null`3008730088 `left_click`'s config overrides.3008930090 - `defer_loading: optional boolean or null`3009130092 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3009330094 - `enabled: optional boolean or null`3009530096 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3009730098 - `left_click_drag: optional BrowserLeftClickDragConfig or null`3009930100 `left_click_drag`'s config overrides.3010130102 - `defer_loading: optional boolean or null`3010330104 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3010530106 - `enabled: optional boolean or null`3010730108 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3010930110 - `left_mouse_down: optional BrowserLeftMouseDownConfig or null`3011130112 `left_mouse_down`'s config overrides.3011330114 - `defer_loading: optional boolean or null`3011530116 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3011730118 - `enabled: optional boolean or null`3011930120 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3012130122 - `left_mouse_up: optional BrowserLeftMouseUpConfig or null`3012330124 `left_mouse_up`'s config overrides.3012530126 - `defer_loading: optional boolean or null`3012730128 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3012930130 - `enabled: optional boolean or null`3013130132 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3013330134 - `list_tabs: optional BrowserListTabsConfig or null`3013530136 `list_tabs`'s config overrides.3013730138 - `defer_loading: optional boolean or null`3013930140 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3014130142 - `enabled: optional boolean or null`3014330144 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3014530146 - `middle_click: optional BrowserMiddleClickConfig or null`3014730148 `middle_click`'s config overrides.3014930150 - `defer_loading: optional boolean or null`3015130152 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3015330154 - `enabled: optional boolean or null`3015530156 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3015730158 - `mouse_move: optional BrowserMouseMoveConfig or null`3015930160 `mouse_move`'s config overrides.3016130162 - `defer_loading: optional boolean or null`3016330164 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3016530166 - `enabled: optional boolean or null`3016730168 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3016930170 - `navigate: optional BrowserNavigateConfig or null`3017130172 `navigate`'s config overrides.3017330174 - `defer_loading: optional boolean or null`3017530176 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3017730178 - `enabled: optional boolean or null`3017930180 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3018130182 - `new_tab: optional BrowserNewTabConfig or null`3018330184 `new_tab`'s config overrides.3018530186 - `defer_loading: optional boolean or null`3018730188 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3018930190 - `enabled: optional boolean or null`3019130192 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3019330194 - `read_console: optional BrowserReadConsoleConfig or null`3019530196 `read_console`'s config overrides.3019730198 - `defer_loading: optional boolean or null`3019930200 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3020130202 - `enabled: optional boolean or null`3020330204 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3020530206 - `read_network: optional BrowserReadNetworkConfig or null`3020730208 `read_network`'s config overrides.3020930210 - `defer_loading: optional boolean or null`3021130212 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3021330214 - `enabled: optional boolean or null`3021530216 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3021730218 - `read_page: optional BrowserReadPageConfig or null`3021930220 `read_page`'s config overrides.3022130222 - `defer_loading: optional boolean or null`3022330224 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3022530226 - `enabled: optional boolean or null`3022730228 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3022930230 - `right_click: optional BrowserRightClickConfig or null`3023130232 `right_click`'s config overrides.3023330234 - `defer_loading: optional boolean or null`3023530236 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3023730238 - `enabled: optional boolean or null`3023930240 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3024130242 - `screenshot: optional BrowserScreenshotConfig or null`3024330244 `screenshot`'s config overrides.3024530246 - `defer_loading: optional boolean or null`3024730248 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3024930250 - `enabled: optional boolean or null`3025130252 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3025330254 - `scroll: optional BrowserScrollConfig or null`3025530256 `scroll`'s config overrides.3025730258 - `defer_loading: optional boolean or null`3025930260 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3026130262 - `enabled: optional boolean or null`3026330264 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3026530266 - `scroll_to: optional BrowserScrollToConfig or null`3026730268 `scroll_to`'s config overrides.3026930270 - `defer_loading: optional boolean or null`3027130272 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3027330274 - `enabled: optional boolean or null`3027530276 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3027730278 - `switch_tab: optional BrowserSwitchTabConfig or null`3027930280 `switch_tab`'s config overrides.3028130282 - `defer_loading: optional boolean or null`3028330284 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3028530286 - `enabled: optional boolean or null`3028730288 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3028930290 - `triple_click: optional BrowserTripleClickConfig or null`3029130292 `triple_click`'s config overrides.3029330294 - `defer_loading: optional boolean or null`3029530296 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3029730298 - `enabled: optional boolean or null`3029930300 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3030130302 - `wait: optional BrowserWaitConfig or null`3030330304 `wait`'s config overrides.3030530306 - `defer_loading: optional boolean or null`3030730308 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3030930310 - `enabled: optional boolean or null`3031130312 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3031330314 - `zoom: optional BrowserZoomConfig or null`3031530316 `zoom`'s config overrides.3031730318 - `defer_loading: optional boolean or null`3031930320 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3032130322 - `enabled: optional boolean or null`3032330324 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3032530326 - `MemoryTool20250818 object`3032730328 - `type: "memory_20250818"`3032930330 - `name: "memory"`3033130332 Name of the tool.3033330334 This is how the tool will be called by the model and in `tool_use` blocks.3033530336 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`3033730338 - `"direct"`3033930340 - `"code_execution_20250825"`3034130342 - `"code_execution_20260120"`3034330344 - `"code_execution_20260521"`3034530346 - `cache_control: optional CacheControlEphemeral or null`3034730348 Create a cache control breakpoint at this content block.3034930350 - `defer_loading: optional boolean`3035130352 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.3035330354 - `input_examples: optional array of map[unknown]`3035530356 - `strict: optional boolean`3035730358 When true, guarantees schema validation on tool names and inputs3035930360 - `ComputerToolset20260801 object`3036130362 The computer toolset: a single `tools[]` entry (carrying no30363 `name`) that declares the computer tool family. The model is30364 served the family's tool with any members disabled via `configs`30365 removed from its schema. Every member is enabled by default, zoom30366 included. The single-tool options `display_number` and30367 `enable_zoom` are not fields of a toolset entry — it carries only30368 `type`, `configs`, and `cache_control`; zoom is controlled30369 via `configs.zoom.enabled`.3037030371 - `type: "computer_toolset_20260801"`3037230373 - `cache_control: optional CacheControlEphemeral or null`3037430375 Create a cache control breakpoint at this content block.3037630377 - `configs: optional ComputerToolsetConfigs or null`3037830379 Per-member configuration for `computer_toolset_20260801`: one30380 optional field per member tool, keyed by the member name — the same30381 name the member's `tool_use` blocks carry. Every member is an30382 accepted key, and a member's defaults apply wherever its key is30383 absent. Unknown keys are rejected: the field set is this toolset30384 version's complete member set.3038530386 - `type: optional ComputerTypeConfig or null`3038730388 `type`'s config overrides.3038930390 - `defer_loading: optional boolean or null`3039130392 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3039330394 - `enabled: optional boolean or null`3039530396 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3039730398 - `cursor_position: optional ComputerCursorPositionConfig or null`3039930400 `cursor_position`'s config overrides.3040130402 - `defer_loading: optional boolean or null`3040330404 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3040530406 - `enabled: optional boolean or null`3040730408 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3040930410 - `double_click: optional ComputerDoubleClickConfig or null`3041130412 `double_click`'s config overrides.3041330414 - `defer_loading: optional boolean or null`3041530416 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3041730418 - `enabled: optional boolean or null`3041930420 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3042130422 - `hold_key: optional ComputerHoldKeyConfig or null`3042330424 `hold_key`'s config overrides.3042530426 - `defer_loading: optional boolean or null`3042730428 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3042930430 - `enabled: optional boolean or null`3043130432 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3043330434 - `key: optional ComputerKeyConfig or null`3043530436 `key`'s config overrides.3043730438 - `defer_loading: optional boolean or null`3043930440 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3044130442 - `enabled: optional boolean or null`3044330444 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3044530446 - `left_click: optional ComputerLeftClickConfig or null`3044730448 `left_click`'s config overrides.3044930450 - `defer_loading: optional boolean or null`3045130452 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3045330454 - `enabled: optional boolean or null`3045530456 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3045730458 - `left_click_drag: optional ComputerLeftClickDragConfig or null`3045930460 `left_click_drag`'s config overrides.3046130462 - `defer_loading: optional boolean or null`3046330464 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3046530466 - `enabled: optional boolean or null`3046730468 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3046930470 - `left_mouse_down: optional ComputerLeftMouseDownConfig or null`3047130472 `left_mouse_down`'s config overrides.3047330474 - `defer_loading: optional boolean or null`3047530476 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3047730478 - `enabled: optional boolean or null`3047930480 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3048130482 - `left_mouse_up: optional ComputerLeftMouseUpConfig or null`3048330484 `left_mouse_up`'s config overrides.3048530486 - `defer_loading: optional boolean or null`3048730488 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3048930490 - `enabled: optional boolean or null`3049130492 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3049330494 - `middle_click: optional ComputerMiddleClickConfig or null`3049530496 `middle_click`'s config overrides.3049730498 - `defer_loading: optional boolean or null`3049930500 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3050130502 - `enabled: optional boolean or null`3050330504 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3050530506 - `mouse_move: optional ComputerMouseMoveConfig or null`3050730508 `mouse_move`'s config overrides.3050930510 - `defer_loading: optional boolean or null`3051130512 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3051330514 - `enabled: optional boolean or null`3051530516 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3051730518 - `right_click: optional ComputerRightClickConfig or null`3051930520 `right_click`'s config overrides.3052130522 - `defer_loading: optional boolean or null`3052330524 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3052530526 - `enabled: optional boolean or null`3052730528 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3052930530 - `screenshot: optional ComputerScreenshotConfig or null`3053130532 `screenshot`'s config overrides.3053330534 - `defer_loading: optional boolean or null`3053530536 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3053730538 - `enabled: optional boolean or null`3053930540 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3054130542 - `scroll: optional ComputerScrollConfig or null`3054330544 `scroll`'s config overrides.3054530546 - `defer_loading: optional boolean or null`3054730548 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3054930550 - `enabled: optional boolean or null`3055130552 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3055330554 - `triple_click: optional ComputerTripleClickConfig or null`3055530556 `triple_click`'s config overrides.3055730558 - `defer_loading: optional boolean or null`3055930560 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3056130562 - `enabled: optional boolean or null`3056330564 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3056530566 - `wait: optional ComputerWaitConfig or null`3056730568 `wait`'s config overrides.3056930570 - `defer_loading: optional boolean or null`3057130572 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3057330574 - `enabled: optional boolean or null`3057530576 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3057730578 - `zoom: optional ComputerZoomConfig or null`3057930580 `zoom`'s config overrides.3058130582 - `defer_loading: optional boolean or null`3058330584 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.3058530586 - `enabled: optional boolean or null`3058730588 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.3058930590 - `ToolTextEditor20250124 object`3059130592 - `type: "text_editor_20250124"`3059330594 - `name: "str_replace_editor"`3059530596 Name of the tool.3059730598 This is how the tool will be called by the model and in `tool_use` blocks.3059930600 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`3060130602 - `"direct"`3060330604 - `"code_execution_20250825"`3060530606 - `"code_execution_20260120"`3060730608 - `"code_execution_20260521"`3060930610 - `cache_control: optional CacheControlEphemeral or null`3061130612 Create a cache control breakpoint at this content block.3061330614 - `defer_loading: optional boolean`3061530616 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.3061730618 - `input_examples: optional array of map[unknown]`3061930620 - `strict: optional boolean`3062130622 When true, guarantees schema validation on tool names and inputs3062330624 - `ToolTextEditor20250429 object`3062530626 - `type: "text_editor_20250429"`3062730628 - `name: "str_replace_based_edit_tool"`3062930630 Name of the tool.3063130632 This is how the tool will be called by the model and in `tool_use` blocks.3063330634 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`3063530636 - `"direct"`3063730638 - `"code_execution_20250825"`3063930640 - `"code_execution_20260120"`3064130642 - `"code_execution_20260521"`3064330644 - `cache_control: optional CacheControlEphemeral or null`3064530646 Create a cache control breakpoint at this content block.3064730648 - `defer_loading: optional boolean`3064930650 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.3065130652 - `input_examples: optional array of map[unknown]`3065330654 - `strict: optional boolean`3065530656 When true, guarantees schema validation on tool names and inputs3065730658 - `ToolTextEditor20250728 object`3065930660 - `type: "text_editor_20250728"`3066130662 - `name: "str_replace_based_edit_tool"`3066330664 Name of the tool.3066530666 This is how the tool will be called by the model and in `tool_use` blocks.3066730668 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`3066930670 - `"direct"`3067130672 - `"code_execution_20250825"`3067330674 - `"code_execution_20260120"`3067530676 - `"code_execution_20260521"`3067730678 - `cache_control: optional CacheControlEphemeral or null`3067930680 Create a cache control breakpoint at this content block.3068130682 - `defer_loading: optional boolean`3068330684 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.3068530686 - `input_examples: optional array of map[unknown]`3068730688 - `max_characters: optional number or null`3068930690 Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.3069130692 minimum: 13069330694 - `strict: optional boolean`3069530696 When true, guarantees schema validation on tool names and inputs3069730698 - `WebSearchTool20250305 object`3069930700 - `type: "web_search_20250305"`3070130702 - `name: "web_search"`3070330704 Name of the tool.3070530706 This is how the tool will be called by the model and in `tool_use` blocks.3070730708 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`3070930710 - `"direct"`3071130712 - `"code_execution_20250825"`3071330714 - `"code_execution_20260120"`3071530716 - `"code_execution_20260521"`3071730718 - `allowed_domains: optional array of string or null`3071930720 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.3072130722 - `blocked_domains: optional array of string or null`3072330724 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.3072530726 - `cache_control: optional CacheControlEphemeral or null`3072730728 Create a cache control breakpoint at this content block.3072930730 - `defer_loading: optional boolean`3073130732 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.3073330734 - `max_uses: optional number or null`3073530736 Maximum number of times the tool can be used in the API request.3073730738 exclusiveMinimum: 03073930740 - `strict: optional boolean`3074130742 When true, guarantees schema validation on tool names and inputs3074330744 - `user_location: optional UserLocation or null`3074530746 Parameters for the user's location. Used to provide more relevant search results.3074730748 - `type: "approximate"`3074930750 - `city: optional string or null`3075130752 The city of the user.3075330754 maxLength: 255, minLength: 13075530756 - `country: optional string or null`3075730758 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.3075930760 maxLength: 2, minLength: 23076130762 - `region: optional string or null`3076330764 The region of the user.3076530766 maxLength: 255, minLength: 13076730768 - `timezone: optional string or null`3076930770 The [IANA timezone](https://nodatime.org/TimeZones) of the user.3077130772 maxLength: 255, minLength: 13077330774 - `WebFetchTool20250910 object`3077530776 - `type: "web_fetch_20250910"`3077730778 - `name: "web_fetch"`3077930780 Name of the tool.3078130782 This is how the tool will be called by the model and in `tool_use` blocks.3078330784 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`3078530786 - `"direct"`3078730788 - `"code_execution_20250825"`3078930790 - `"code_execution_20260120"`3079130792 - `"code_execution_20260521"`3079330794 - `allowed_domains: optional array of string or null`3079530796 List of domains to allow fetching from3079730798 - `blocked_domains: optional array of string or null`3079930800 List of domains to block fetching from3080130802 - `cache_control: optional CacheControlEphemeral or null`3080330804 Create a cache control breakpoint at this content block.3080530806 - `citations: optional CitationsConfigParam or null`3080730808 Citations configuration for fetched documents. Citations are disabled by default.3080930810 - `defer_loading: optional boolean`3081130812 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.3081330814 - `max_content_tokens: optional number or null`3081530816 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.3081730818 exclusiveMinimum: 03081930820 - `max_uses: optional number or null`3082130822 Maximum number of times the tool can be used in the API request.3082330824 exclusiveMinimum: 03082530826 - `strict: optional boolean`3082730828 When true, guarantees schema validation on tool names and inputs3082930830 - `url_sources: optional WebFetchURLSources or null`3083130832 Which sources contribute to the set of URLs web fetch may fetch.3083330834 Each key is a tagged variant: `user_input` is `all` or `none`; the30835 two tool filters are `all`, `none`, `only` (only the named tools'30836 results) or `except` (every result but the named tools'). A named tool30837 must be declared in this request's `tools[]`.3083830839 - `client_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`3084030841 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].3084230843 - `WebFetchURLSourceAll object`3084430845 The `url_sources` variant under which a source contributes in30846 full: every result of the tool filter's source, or all user input.3084730848 - `type: "all"`3084930850 - `WebFetchURLSourceNone object`3085130852 The `url_sources` variant under which a source contributes nothing:30853 no result of the tool filter's source, or no user input.3085430855 - `type: "none"`3085630857 - `WebFetchURLSourceOnly object`3085830859 The tool filter variant under which only the named tools' results30860 contribute.3086130862 - `type: "only"`3086330864 - `tools: array of WebFetchURLSourceToolReference`3086530866 - `type: "tool_reference"`3086730868 - `name: string`3086930870 - `WebFetchURLSourceExcept object`3087130872 The tool filter variant under which every result but the named30873 tools' contributes.3087430875 - `type: "except"`3087630877 - `tools: array of WebFetchURLSourceToolReference`3087830879 - `type: "tool_reference"`3088030881 - `name: string`3088230883 - `server_tool_results: optional WebFetchURLSourceAll or WebFetchURLSourceNone or WebFetchURLSourceOnly or WebFetchURLSourceExcept`3088430885 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.3088630887 - `WebFetchURLSourceAll object`3088830889 The `url_sources` variant under which a source contributes in30890 full: every result of the tool filter's source, or all user input.3089130892 - `WebFetchURLSourceNone object`3089330894 The `url_sources` variant under which a source contributes nothing:30895 no result of the tool filter's source, or no user input.3089630897 - `WebFetchURLSourceOnly object`3089830899 The tool filter variant under which only the named tools' results30900 contribute.3090130902 - `WebFetchURLSourceExcept object`3090330904 The tool filter variant under which every result but the named30905 tools' contributes.3090630907 - `user_input: optional WebFetchURLSourceAll or WebFetchURLSourceNone`3090830909 Whether URLs in user messages are fetchable: "all" or "none".3091030911 - `WebFetchURLSourceAll object`3091230913 The `url_sources` variant under which a source contributes in30914 full: every result of the tool filter's source, or all user input.3091530916 - `WebFetchURLSourceNone object`3091730918 The `url_sources` variant under which a source contributes nothing:30919 no result of the tool filter's source, or no user input.3092030921 - `WebSearchTool20260209 object`3092230923 - `type: "web_search_20260209"`3092430925 - `name: "web_search"`3092630927 Name of the tool.3092830929 This is how the tool will be called by the model and in `tool_use` blocks.3093030931 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`3093230933 - `"direct"`3093430935 - `"code_execution_20250825"`3093630937 - `"code_execution_20260120"`3093830939 - `"code_execution_20260521"`3094030941 - `allowed_domains: optional array of string or null`3094230943 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.3094430945 - `blocked_domains: optional array of string or null`3094630947 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.3094830949 - `cache_control: optional CacheControlEphemeral or null`3095030951 Create a cache control breakpoint at this content block.3095230953 - `defer_loading: optional boolean`3095430955 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.3095630957 - `max_uses: optional number or null`3095830959 Maximum number of times the tool can be used in the API request.3096030961 exclusiveMinimum: 03096230963 - `strict: optional boolean`3096430965 When true, guarantees schema validation on tool names and inputs3096630967 - `user_location: optional UserLocation or null`3096830969 Parameters for the user's location. Used to provide more relevant search results.3097030971 - `WebFetchTool20260209 object`3097230973 - `type: "web_fetch_20260209"`3097430975 - `name: "web_fetch"`3097630977 Name of the tool.3097830979 This is how the tool will be called by the model and in `tool_use` blocks.3098030981 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`3098230983 - `"direct"`3098430985 - `"code_execution_20250825"`3098630987 - `"code_execution_20260120"`3098830989 - `"code_execution_20260521"`3099030991 - `allowed_domains: optional array of string or null`3099230993 List of domains to allow fetching from3099430995 - `blocked_domains: optional array of string or null`3099630997 List of domains to block fetching from3099830999 - `cache_control: optional CacheControlEphemeral or null`3100031001 Create a cache control breakpoint at this content block.3100231003 - `citations: optional CitationsConfigParam or null`3100431005 Citations configuration for fetched documents. Citations are disabled by default.3100631007 - `defer_loading: optional boolean`3100831009 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.3101031011 - `max_content_tokens: optional number or null`3101231013 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.3101431015 exclusiveMinimum: 03101631017 - `max_uses: optional number or null`3101831019 Maximum number of times the tool can be used in the API request.3102031021 exclusiveMinimum: 03102231023 - `strict: optional boolean`3102431025 When true, guarantees schema validation on tool names and inputs3102631027 - `url_sources: optional WebFetchURLSources or null`3102831029 Which sources contribute to the set of URLs web fetch may fetch.3103031031 Each key is a tagged variant: `user_input` is `all` or `none`; the31032 two tool filters are `all`, `none`, `only` (only the named tools'31033 results) or `except` (every result but the named tools'). A named tool31034 must be declared in this request's `tools[]`.3103531036 - `WebFetchTool20260309 object`3103731038 Web fetch tool with use_cache parameter for bypassing cached content.3103931040 - `type: "web_fetch_20260309"`3104131042 - `name: "web_fetch"`3104331044 Name of the tool.3104531046 This is how the tool will be called by the model and in `tool_use` blocks.3104731048 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`3104931050 - `"direct"`3105131052 - `"code_execution_20250825"`3105331054 - `"code_execution_20260120"`3105531056 - `"code_execution_20260521"`3105731058 - `allowed_domains: optional array of string or null`3105931060 List of domains to allow fetching from3106131062 - `blocked_domains: optional array of string or null`3106331064 List of domains to block fetching from3106531066 - `cache_control: optional CacheControlEphemeral or null`3106731068 Create a cache control breakpoint at this content block.3106931070 - `citations: optional CitationsConfigParam or null`3107131072 Citations configuration for fetched documents. Citations are disabled by default.3107331074 - `defer_loading: optional boolean`3107531076 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.3107731078 - `max_content_tokens: optional number or null`3107931080 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.3108131082 exclusiveMinimum: 03108331084 - `max_uses: optional number or null`3108531086 Maximum number of times the tool can be used in the API request.3108731088 exclusiveMinimum: 03108931090 - `strict: optional boolean`3109131092 When true, guarantees schema validation on tool names and inputs3109331094 - `url_sources: optional WebFetchURLSources or null`3109531096 Which sources contribute to the set of URLs web fetch may fetch.3109731098 Each key is a tagged variant: `user_input` is `all` or `none`; the31099 two tool filters are `all`, `none`, `only` (only the named tools'31100 results) or `except` (every result but the named tools'). A named tool31101 must be declared in this request's `tools[]`.3110231103 - `use_cache: optional boolean`3110431105 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.3110631107 - `WebSearchTool20260318 object`3110831109 - `type: "web_search_20260318"`3111031111 - `name: "web_search"`3111231113 Name of the tool.3111431115 This is how the tool will be called by the model and in `tool_use` blocks.3111631117 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`3111831119 - `"direct"`3112031121 - `"code_execution_20250825"`3112231123 - `"code_execution_20260120"`3112431125 - `"code_execution_20260521"`3112631127 - `allowed_domains: optional array of string or null`3112831129 If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.3113031131 - `blocked_domains: optional array of string or null`3113231133 If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.3113431135 - `cache_control: optional CacheControlEphemeral or null`3113631137 Create a cache control breakpoint at this content block.3113831139 - `defer_loading: optional boolean`3114031141 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.3114231143 - `max_uses: optional number or null`3114431145 Maximum number of times the tool can be used in the API request.3114631147 exclusiveMinimum: 03114831149 - `response_inclusion: optional "full" or "excluded"`3115031151 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.3115231153 - `"full"`3115431155 - `"excluded"`3115631157 - `strict: optional boolean`3115831159 When true, guarantees schema validation on tool names and inputs3116031161 - `user_location: optional UserLocation or null`3116231163 Parameters for the user's location. Used to provide more relevant search results.3116431165 - `WebFetchTool20260318 object`3116631167 - `type: "web_fetch_20260318"`3116831169 - `name: "web_fetch"`3117031171 Name of the tool.3117231173 This is how the tool will be called by the model and in `tool_use` blocks.3117431175 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`3117631177 - `"direct"`3117831179 - `"code_execution_20250825"`3118031181 - `"code_execution_20260120"`3118231183 - `"code_execution_20260521"`3118431185 - `allowed_domains: optional array of string or null`3118631187 List of domains to allow fetching from3118831189 - `blocked_domains: optional array of string or null`3119031191 List of domains to block fetching from3119231193 - `cache_control: optional CacheControlEphemeral or null`3119431195 Create a cache control breakpoint at this content block.3119631197 - `citations: optional CitationsConfigParam or null`3119831199 Citations configuration for fetched documents. Citations are disabled by default.3120031201 - `defer_loading: optional boolean`3120231203 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.3120431205 - `max_content_tokens: optional number or null`3120631207 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.3120831209 exclusiveMinimum: 03121031211 - `max_uses: optional number or null`3121231213 Maximum number of times the tool can be used in the API request.3121431215 exclusiveMinimum: 03121631217 - `response_inclusion: optional "full" or "excluded"`3121831219 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.3122031221 - `"full"`3122231223 - `"excluded"`3122431225 - `strict: optional boolean`3122631227 When true, guarantees schema validation on tool names and inputs3122831229 - `url_sources: optional WebFetchURLSources or null`3123031231 Which sources contribute to the set of URLs web fetch may fetch.3123231233 Each key is a tagged variant: `user_input` is `all` or `none`; the31234 two tool filters are `all`, `none`, `only` (only the named tools'31235 results) or `except` (every result but the named tools'). A named tool31236 must be declared in this request's `tools[]`.3123731238 - `use_cache: optional boolean`3123931240 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.3124131242 - `ToolSearchToolBm25_20251119 object`3124331244 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`3124531246 - `"tool_search_tool_bm25_20251119"`3124731248 - `"tool_search_tool_bm25"`3124931250 - `name: "tool_search_tool_bm25"`3125131252 Name of the tool.3125331254 This is how the tool will be called by the model and in `tool_use` blocks.3125531256 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`3125731258 - `"direct"`3125931260 - `"code_execution_20250825"`3126131262 - `"code_execution_20260120"`3126331264 - `"code_execution_20260521"`3126531266 - `cache_control: optional CacheControlEphemeral or null`3126731268 Create a cache control breakpoint at this content block.3126931270 - `defer_loading: optional boolean`3127131272 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.3127331274 - `strict: optional boolean`3127531276 When true, guarantees schema validation on tool names and inputs3127731278 - `ToolSearchToolRegex20251119 object`3127931280 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`3128131282 - `"tool_search_tool_regex_20251119"`3128331284 - `"tool_search_tool_regex"`3128531286 - `name: "tool_search_tool_regex"`3128731288 Name of the tool.3128931290 This is how the tool will be called by the model and in `tool_use` blocks.3129131292 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`3129331294 - `"direct"`3129531296 - `"code_execution_20250825"`3129731298 - `"code_execution_20260120"`3129931300 - `"code_execution_20260521"`3130131302 - `cache_control: optional CacheControlEphemeral or null`3130331304 Create a cache control breakpoint at this content block.3130531306 - `defer_loading: optional boolean`3130731308 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.3130931310 - `strict: optional boolean`3131131312 When true, guarantees schema validation on tool names and inputs3131331314 - `temperature: optional number`3131531316 **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.3131731318 Amount of randomness injected into the response.3131931320 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.3132131322 Note that even with `temperature` of `0.0`, the results will not be fully deterministic.3132331324 maximum: 1, minimum: 03132531326 - `top_k: optional number`3132731328 **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error.3132931330 Only sample from the top K options for each subsequent token.3133131332 Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277).3133331334 Recommended for advanced use cases only.3133531336 minimum: 03133731338 - `top_p: optional number`3133931340 **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.3134131342 Use nucleus sampling.3134331344 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`.3134531346 Recommended for advanced use cases only.3134731348 maximum: 1, minimum: 03134931350#### Returns3135131352- `MessageBatch object`3135331354 - `type: "message_batch"`3135531356 Object type.3135731358 For Message Batches, this is always `"message_batch"`.3135931360 default: message_batch3136131362 - `id: string`3136331364 Unique object identifier.3136531366 The format and length of IDs may change over time.3136731368 - `archived_at: string or null`3136931370 RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.3137131372 format: date-time3137331374 - `cancel_initiated_at: string or null`3137531376 RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.3137731378 format: date-time3137931380 - `created_at: string`3138131382 RFC 3339 datetime string representing the time at which the Message Batch was created.3138331384 format: date-time3138531386 - `ended_at: string or null`3138731388 RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends.3138931390 Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired.3139131392 format: date-time3139331394 - `expires_at: string`3139531396 RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.3139731398 format: date-time3139931400 - `processing_status: "in_progress" or "canceling" or "ended"`3140131402 Processing status of the Message Batch.3140331404 - `"in_progress"`3140531406 - `"canceling"`3140731408 - `"ended"`3140931410 - `request_counts: MessageBatchRequestCounts`3141131412 Tallies requests within the Message Batch, categorized by their status.3141331414 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.3141531416 - `canceled: number`3141731418 Number of requests in the Message Batch that have been canceled.3141931420 This is zero until processing of the entire Message Batch has ended.3142131422 default: 03142331424 - `errored: number`3142531426 Number of requests in the Message Batch that encountered an error.3142731428 This is zero until processing of the entire Message Batch has ended.3142931430 default: 03143131432 - `expired: number`3143331434 Number of requests in the Message Batch that have expired.3143531436 This is zero until processing of the entire Message Batch has ended.3143731438 default: 03143931440 - `processing: number`3144131442 Number of requests in the Message Batch that are processing.3144331444 default: 03144531446 - `succeeded: number`3144731448 Number of requests in the Message Batch that have completed successfully.3144931450 This is zero until processing of the entire Message Batch has ended.3145131452 default: 03145331454 - `results_url: string or null`3145531456 URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends.3145731458 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.3145931460#### Example3146131462```bash31463curl https://api.anthropic.com/v1/messages/batches \31464 -H 'Content-Type: application/json' \31465 -H 'anthropic-version: 2023-06-01' \31466 -H "X-Api-Key: $ANTHROPIC_API_KEY" \31467 -d '{31468 "requests": [31469 {31470 "custom_id": "my-custom-id-1",31471 "params": {31472 "max_tokens": 1024,31473 "messages": [31474 {31475 "content": "Hello, world",31476 "role": "user"31477 }31478 ],31479 "model": "claude-opus-5"31480 }31481 }31482 ]31483 }'31484```3148531486##### Response (200)3148731488```json31489{31490 "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",31491 "archived_at": "2024-08-20T18:37:24.100435Z",31492 "cancel_initiated_at": "2024-08-20T18:37:24.100435Z",31493 "created_at": "2024-08-20T18:37:24.100435Z",31494 "ended_at": "2024-08-20T18:37:24.100435Z",31495 "expires_at": "2024-08-20T18:37:24.100435Z",31496 "processing_status": "in_progress",31497 "request_counts": {31498 "canceled": 10,31499 "errored": 30,31500 "expired": 10,31501 "processing": 100,31502 "succeeded": 5031503 },31504 "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",31505 "type": "message_batch"31506}31507```3150831509### Retrieve a Message Batch3151031511**GET** `/v1/messages/batches/{message_batch_id}`3151231513This 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.3151431515Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)3151631517#### Path parameters3151831519- `message_batch_id: string`3152031521 ID of the Message Batch.3152231523#### Headers3152431525- `"anthropic-workspace-id": optional string`3152631527#### Returns3152831529- `MessageBatch object`3153031531 - `type: "message_batch"`3153231533 Object type.3153431535 For Message Batches, this is always `"message_batch"`.3153631537 default: message_batch3153831539 - `id: string`3154031541 Unique object identifier.3154231543 The format and length of IDs may change over time.3154431545 - `archived_at: string or null`3154631547 RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.3154831549 format: date-time3155031551 - `cancel_initiated_at: string or null`3155231553 RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.3155431555 format: date-time3155631557 - `created_at: string`3155831559 RFC 3339 datetime string representing the time at which the Message Batch was created.3156031561 format: date-time3156231563 - `ended_at: string or null`3156431565 RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends.3156631567 Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired.3156831569 format: date-time3157031571 - `expires_at: string`3157231573 RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.3157431575 format: date-time3157631577 - `processing_status: "in_progress" or "canceling" or "ended"`3157831579 Processing status of the Message Batch.3158031581 - `"in_progress"`3158231583 - `"canceling"`3158431585 - `"ended"`3158631587 - `request_counts: MessageBatchRequestCounts`3158831589 Tallies requests within the Message Batch, categorized by their status.3159031591 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.3159231593 - `canceled: number`3159431595 Number of requests in the Message Batch that have been canceled.3159631597 This is zero until processing of the entire Message Batch has ended.3159831599 default: 03160031601 - `errored: number`3160231603 Number of requests in the Message Batch that encountered an error.3160431605 This is zero until processing of the entire Message Batch has ended.3160631607 default: 03160831609 - `expired: number`3161031611 Number of requests in the Message Batch that have expired.3161231613 This is zero until processing of the entire Message Batch has ended.3161431615 default: 03161631617 - `processing: number`3161831619 Number of requests in the Message Batch that are processing.3162031621 default: 03162231623 - `succeeded: number`3162431625 Number of requests in the Message Batch that have completed successfully.3162631627 This is zero until processing of the entire Message Batch has ended.3162831629 default: 03163031631 - `results_url: string or null`3163231633 URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends.3163431635 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.3163631637#### Example3163831639```bash31640curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID \31641 -H 'anthropic-version: 2023-06-01' \31642 -H "X-Api-Key: $ANTHROPIC_API_KEY"31643```3164431645##### Response (200)3164631647```json31648{31649 "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",31650 "archived_at": "2024-08-20T18:37:24.100435Z",31651 "cancel_initiated_at": "2024-08-20T18:37:24.100435Z",31652 "created_at": "2024-08-20T18:37:24.100435Z",31653 "ended_at": "2024-08-20T18:37:24.100435Z",31654 "expires_at": "2024-08-20T18:37:24.100435Z",31655 "processing_status": "in_progress",31656 "request_counts": {31657 "canceled": 10,31658 "errored": 30,31659 "expired": 10,31660 "processing": 100,31661 "succeeded": 5031662 },31663 "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",31664 "type": "message_batch"31665}31666```3166731668### List Message Batches3166931670**GET** `/v1/messages/batches`3167131672List all Message Batches within a Workspace. Most recently created batches are returned first.3167331674Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)3167531676#### Query parameters3167731678- `after_id: optional string`3167931680 ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.3168131682- `before_id: optional string`3168331684 ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.3168531686- `limit: optional number`3168731688 Number of items to return per page.3168931690 Defaults to `20`. Ranges from `1` to `1000`.3169131692 default: 20, maximum: 1000, minimum: 13169331694#### Headers3169531696- `"anthropic-workspace-id": optional string`3169731698#### Returns3169931700- `data: array of MessageBatch`3170131702 - `type: "message_batch"`3170331704 Object type.3170531706 For Message Batches, this is always `"message_batch"`.3170731708 default: message_batch3170931710 - `id: string`3171131712 Unique object identifier.3171331714 The format and length of IDs may change over time.3171531716 - `archived_at: string or null`3171731718 RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.3171931720 format: date-time3172131722 - `cancel_initiated_at: string or null`3172331724 RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.3172531726 format: date-time3172731728 - `created_at: string`3172931730 RFC 3339 datetime string representing the time at which the Message Batch was created.3173131732 format: date-time3173331734 - `ended_at: string or null`3173531736 RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends.3173731738 Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired.3173931740 format: date-time3174131742 - `expires_at: string`3174331744 RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.3174531746 format: date-time3174731748 - `processing_status: "in_progress" or "canceling" or "ended"`3174931750 Processing status of the Message Batch.3175131752 - `"in_progress"`3175331754 - `"canceling"`3175531756 - `"ended"`3175731758 - `request_counts: MessageBatchRequestCounts`3175931760 Tallies requests within the Message Batch, categorized by their status.3176131762 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.3176331764 - `canceled: number`3176531766 Number of requests in the Message Batch that have been canceled.3176731768 This is zero until processing of the entire Message Batch has ended.3176931770 default: 03177131772 - `errored: number`3177331774 Number of requests in the Message Batch that encountered an error.3177531776 This is zero until processing of the entire Message Batch has ended.3177731778 default: 03177931780 - `expired: number`3178131782 Number of requests in the Message Batch that have expired.3178331784 This is zero until processing of the entire Message Batch has ended.3178531786 default: 03178731788 - `processing: number`3178931790 Number of requests in the Message Batch that are processing.3179131792 default: 03179331794 - `succeeded: number`3179531796 Number of requests in the Message Batch that have completed successfully.3179731798 This is zero until processing of the entire Message Batch has ended.3179931800 default: 03180131802 - `results_url: string or null`3180331804 URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends.3180531806 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.3180731808- `first_id: string or null`3180931810 First ID in the `data` list. Can be used as the `before_id` for the previous page.3181131812- `has_more: boolean`3181331814 Indicates if there are more results in the requested page direction.3181531816- `last_id: string or null`3181731818 Last ID in the `data` list. Can be used as the `after_id` for the next page.3181931820#### Example3182131822```bash31823curl https://api.anthropic.com/v1/messages/batches \31824 -H 'anthropic-version: 2023-06-01' \31825 -H "X-Api-Key: $ANTHROPIC_API_KEY"31826```3182731828##### Response (200)3182931830```json31831{31832 "data": [31833 {31834 "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",31835 "archived_at": "2024-08-20T18:37:24.100435Z",31836 "cancel_initiated_at": "2024-08-20T18:37:24.100435Z",31837 "created_at": "2024-08-20T18:37:24.100435Z",31838 "ended_at": "2024-08-20T18:37:24.100435Z",31839 "expires_at": "2024-08-20T18:37:24.100435Z",31840 "processing_status": "in_progress",31841 "request_counts": {31842 "canceled": 10,31843 "errored": 30,31844 "expired": 10,31845 "processing": 100,31846 "succeeded": 5031847 },31848 "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",31849 "type": "message_batch"31850 }31851 ],31852 "first_id": "first_id",31853 "has_more": true,31854 "last_id": "last_id"31855}31856```3185731858### Cancel a Message Batch3185931860**POST** `/v1/messages/batches/{message_batch_id}/cancel`3186131862Batches 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.3186331864The 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.3186531866Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)3186731868#### Path parameters3186931870- `message_batch_id: string`3187131872 ID of the Message Batch.3187331874#### Headers3187531876- `"anthropic-workspace-id": optional string`3187731878#### Returns3187931880- `MessageBatch object`3188131882 - `type: "message_batch"`3188331884 Object type.3188531886 For Message Batches, this is always `"message_batch"`.3188731888 default: message_batch3188931890 - `id: string`3189131892 Unique object identifier.3189331894 The format and length of IDs may change over time.3189531896 - `archived_at: string or null`3189731898 RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.3189931900 format: date-time3190131902 - `cancel_initiated_at: string or null`3190331904 RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.3190531906 format: date-time3190731908 - `created_at: string`3190931910 RFC 3339 datetime string representing the time at which the Message Batch was created.3191131912 format: date-time3191331914 - `ended_at: string or null`3191531916 RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends.3191731918 Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired.3191931920 format: date-time3192131922 - `expires_at: string`3192331924 RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.3192531926 format: date-time3192731928 - `processing_status: "in_progress" or "canceling" or "ended"`3192931930 Processing status of the Message Batch.3193131932 - `"in_progress"`3193331934 - `"canceling"`3193531936 - `"ended"`3193731938 - `request_counts: MessageBatchRequestCounts`3193931940 Tallies requests within the Message Batch, categorized by their status.3194131942 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.3194331944 - `canceled: number`3194531946 Number of requests in the Message Batch that have been canceled.3194731948 This is zero until processing of the entire Message Batch has ended.3194931950 default: 03195131952 - `errored: number`3195331954 Number of requests in the Message Batch that encountered an error.3195531956 This is zero until processing of the entire Message Batch has ended.3195731958 default: 03195931960 - `expired: number`3196131962 Number of requests in the Message Batch that have expired.3196331964 This is zero until processing of the entire Message Batch has ended.3196531966 default: 03196731968 - `processing: number`3196931970 Number of requests in the Message Batch that are processing.3197131972 default: 03197331974 - `succeeded: number`3197531976 Number of requests in the Message Batch that have completed successfully.3197731978 This is zero until processing of the entire Message Batch has ended.3197931980 default: 03198131982 - `results_url: string or null`3198331984 URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends.3198531986 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.3198731988#### Example3198931990```bash31991curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID/cancel \31992 -X POST \31993 -H 'anthropic-version: 2023-06-01' \31994 -H "X-Api-Key: $ANTHROPIC_API_KEY"31995```3199631997##### Response (200)3199831999```json32000{32001 "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",32002 "archived_at": "2024-08-20T18:37:24.100435Z",32003 "cancel_initiated_at": "2024-08-20T18:37:24.100435Z",32004 "created_at": "2024-08-20T18:37:24.100435Z",32005 "ended_at": "2024-08-20T18:37:24.100435Z",32006 "expires_at": "2024-08-20T18:37:24.100435Z",32007 "processing_status": "in_progress",32008 "request_counts": {32009 "canceled": 10,32010 "errored": 30,32011 "expired": 10,32012 "processing": 100,32013 "succeeded": 5032014 },32015 "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",32016 "type": "message_batch"32017}32018```3201932020### Delete a Message Batch3202132022**DELETE** `/v1/messages/batches/{message_batch_id}`3202332024Delete a Message Batch.3202532026Message 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.3202732028Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)3202932030#### Path parameters3203132032- `message_batch_id: string`3203332034 ID of the Message Batch.3203532036#### Headers3203732038- `"anthropic-workspace-id": optional string`3203932040#### Returns3204132042- `DeletedMessageBatch object`3204332044 - `type: "message_batch_deleted"`3204532046 Deleted object type.3204732048 For Message Batches, this is always `"message_batch_deleted"`.3204932050 default: message_batch_deleted3205132052 - `id: string`3205332054 ID of the Message Batch.3205532056#### Example3205732058```bash32059curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID \32060 -X DELETE \32061 -H 'anthropic-version: 2023-06-01' \32062 -H "X-Api-Key: $ANTHROPIC_API_KEY"32063```3206432065##### Response (200)3206632067```json32068{32069 "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",32070 "type": "message_batch_deleted"32071}32072```3207332074### Retrieve Message Batch results3207532076**GET** `/v1/messages/batches/{message_batch_id}/results`3207732078Streams the results of a Message Batch as a `.jsonl` file.3207932080Each 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.3208132082Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)3208332084#### Path parameters3208532086- `message_batch_id: string`3208732088 ID of the Message Batch.3208932090#### Headers3209132092- `"anthropic-workspace-id": optional string`3209332094#### Returns3209532096- `MessageBatchIndividualResponse object`3209732098 This is a single line in the response `.jsonl` file and does not represent the response as a whole.3209932100 - `custom_id: string`3210132102 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.3210332104 Must be unique for each request within the Message Batch.3210532106 - `result: MessageBatchResult`3210732108 Processing result for this request.3210932110 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.3211132112 - `MessageBatchSucceededResult object`3211332114 - `type: "succeeded"`3211532116 default: succeeded3211732118 - `message: Message`3211932120 - `type: "message"`3212132122 Object type.3212332124 For Messages, this is always `"message"`.3212532126 default: message3212732128 - `id: string`3212932130 Unique object identifier.3213132132 The format and length of IDs may change over time.3213332134 - `container: Container or null`3213532136 Information about the container used in the request (for the code execution tool)3213732138 - `id: string`3213932140 Identifier for the container used in this request3214132142 - `expires_at: string`3214332144 The time at which the container will expire.3214532146 format: date-time3214732148 - `skills: array of ContainerSkill or null`3214932150 Skills loaded in the container3215132152 - `type: "anthropic" or "custom"`3215332154 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)3215532156 - `"anthropic"`3215732158 - `"custom"`3215932160 - `skill_id: string`3216132162 Skill ID3216332164 maxLength: 64, minLength: 13216532166 - `version: string`3216732168 The resolved version: a skill version ID for custom skills.3216932170 maxLength: 64, minLength: 13217132172 - `content: array of ContentBlock`3217332174 Content generated by the model.3217532176 This is an array of content blocks, each of which has a `type` that determines its shape.3217732178 Example:3217932180 ```json32181 [{"type": "text", "text": "Hi, I'm Claude."}]32182 ```3218332184 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.3218532186 For example, if the input `messages` were:3218732188 ```json32189 [32190 {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},32191 {"role": "assistant", "content": "The best answer is ("}32192 ]32193 ```3219432195 Then the response `content` might be:3219632197 ```json32198 [{"type": "text", "text": "B)"}]32199 ```3220032201 - `TextBlock object`3220232203 - `type: "text"`3220432205 default: text3220632207 - `citations: array of TextCitation or null`3220832209 Citations supporting the text block.3221032211 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`.3221232213 - `CitationCharLocation object`3221432215 - `type: "char_location"`3221632217 default: char_location3221832219 - `cited_text: string`3222032221 - `document_index: number`3222232223 minimum: 03222432225 - `document_title: string or null`3222632227 - `end_char_index: number`3222832229 - `file_id: string or null`3223032231 - `start_char_index: number`3223232233 minimum: 03223432235 - `CitationPageLocation object`3223632237 - `type: "page_location"`3223832239 default: page_location3224032241 - `cited_text: string`3224232243 - `document_index: number`3224432245 minimum: 03224632247 - `document_title: string or null`3224832249 - `end_page_number: number`3225032251 - `file_id: string or null`3225232253 - `start_page_number: number`3225432255 minimum: 13225632257 - `CitationContentBlockLocation object`3225832259 - `type: "content_block_location"`3226032261 default: content_block_location3226232263 - `cited_text: string`3226432265 The full text of the cited block range, concatenated.3226632267 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.3226832269 - `document_index: number`3227032271 minimum: 03227232273 - `document_title: string or null`3227432275 - `end_block_index: number`3227632277 Exclusive 0-based end index of the cited block range in the source's `content` array.3227832279 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.3228032281 - `file_id: string or null`3228232283 - `start_block_index: number`3228432285 0-based index of the first cited block in the source's `content` array.3228632287 minimum: 03228832289 - `CitationsWebSearchResultLocation object`3229032291 - `type: "web_search_result_location"`3229232293 default: web_search_result_location3229432295 - `cited_text: string`3229632297 - `encrypted_index: string`3229832299 - `title: string or null`3230032301 maxLength: 5123230232303 - `url: string`3230432305 - `CitationsSearchResultLocation object`3230632307 - `type: "search_result_location"`3230832309 default: search_result_location3231032311 - `cited_text: string`3231232313 The full text of the cited block range, concatenated.3231432315 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.3231632317 - `end_block_index: number`3231832319 Exclusive 0-based end index of the cited block range in the source's `content` array.3232032321 Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.3232232323 - `search_result_index: number`3232432325 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.3232632327 Counted separately from `document_index`; server-side web search results are not included in this count.3232832329 minimum: 03233032331 - `source: string`3233232333 - `start_block_index: number`3233432335 0-based index of the first cited block in the source's `content` array.3233632337 minimum: 03233832339 - `title: string or null`3234032341 - `text: string`3234232343 minLength: 03234432345 - `ThinkingBlock object`3234632347 - `type: "thinking"`3234832349 default: thinking3235032351 - `signature: string`3235232353 A value used to verify that this thinking block was generated by Claude when it is passed back to the API.3235432355 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.3235632357 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.3235832359 - `thinking: string`3236032361 The text of Claude's thinking process for this block.3236232363 - `RedactedThinkingBlock object`3236432365 - `type: "redacted_thinking"`3236632367 default: redacted_thinking3236832369 - `data: string`3237032371 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.3237232373 Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.3237432375 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.3237632377 - `ToolUseBlock object`3237832379 - `type: "tool_use"`3238032381 default: tool_use3238232383 - `id: string`3238432385 pattern: ^[a-zA-Z0-9_-]+$3238632387 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`3238832389 default: {"type":"direct"}3239032391 - `DirectCaller object`3239232393 Tool invocation directly from the model.3239432395 - `type: "direct"`3239632397 - `ServerToolCaller object`3239832399 Tool invocation generated by a server-side tool.3240032401 - `type: "code_execution_20250825"`3240232403 - `tool_id: string`3240432405 pattern: ^srvtoolu_[a-zA-Z0-9_]+$3240632407 - `ServerToolCaller20260120 object`3240832409 - `type: "code_execution_20260120"`3241032411 - `tool_id: string`3241232413 pattern: ^srvtoolu_[a-zA-Z0-9_]+$3241432415 - `input: map[unknown]`3241632417 - `name: string`3241832419 minLength: 13242032421 - `toolset_name: optional string or null`3242232423 For a toolset member tool_use, the toolset family.3242432425 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$3242632427 - `ServerToolUseBlock object`3242832429 - `type: "server_tool_use"`3243032431 default: server_tool_use3243232433 - `id: string`3243432435 pattern: ^srvtoolu_[a-zA-Z0-9_]+$3243632437 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`3243832439 default: {"type":"direct"}3244032441 - `DirectCaller object`3244232443 Tool invocation directly from the model.3244432445 - `ServerToolCaller object`3244632447 Tool invocation generated by a server-side tool.3244832449 - `ServerToolCaller20260120 object`3245032451 - `input: map[unknown]`3245232453 - `name: "web_search" or "web_fetch" or "code_execution" or 4 more`3245432455 - `"web_search"`3245632457 - `"web_fetch"`3245832459 - `"code_execution"`3246032461 - `"bash_code_execution"`3246232463 - `"text_editor_code_execution"`3246432465 - `"tool_search_tool_regex"`3246632467 - `"tool_search_tool_bm25"`3246832469 - `WebSearchToolResultBlock object`3247032471 - `type: "web_search_tool_result"`3247232473 default: web_search_tool_result3247432475 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`3247632477 default: {"type":"direct"}3247832479 - `DirectCaller object`3248032481 Tool invocation directly from the model.3248232483 - `ServerToolCaller object`3248432485 Tool invocation generated by a server-side tool.3248632487 - `ServerToolCaller20260120 object`3248832489 - `content: WebSearchToolResultBlockContent`3249032491 - `WebSearchToolResultError object`3249232493 - `type: "web_search_tool_result_error"`3249432495 default: web_search_tool_result_error3249632497 - `error_code: WebSearchToolResultErrorCode`3249832499 - `"invalid_tool_input"`3250032501 - `"unavailable"`3250232503 - `"max_uses_exceeded"`3250432505 - `"too_many_requests"`3250632507 - `"query_too_long"`3250832509 - `"request_too_large"`3251032511 - `array of WebSearchResultBlock`3251232513 - `type: "web_search_result"`3251432515 default: web_search_result3251632517 - `encrypted_content: string`3251832519 - `page_age: string or null`3252032521 - `title: string`3252232523 - `url: string`3252432525 - `tool_use_id: string`3252632527 pattern: ^srvtoolu_[a-zA-Z0-9_]+$3252832529 - `WebFetchToolResultBlock object`3253032531 - `type: "web_fetch_tool_result"`3253232533 default: web_fetch_tool_result3253432535 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`3253632537 default: {"type":"direct"}3253832539 - `DirectCaller object`3254032541 Tool invocation directly from the model.3254232543 - `ServerToolCaller object`3254432545 Tool invocation generated by a server-side tool.3254632547 - `ServerToolCaller20260120 object`3254832549 - `content: WebFetchToolResultErrorBlock or WebFetchBlock`3255032551 - `WebFetchToolResultErrorBlock object`3255232553 - `type: "web_fetch_tool_result_error"`3255432555 default: web_fetch_tool_result_error3255632557 - `error_code: WebFetchToolResultErrorCode`3255832559 - `"invalid_tool_input"`3256032561 - `"url_too_long"`3256232563 - `"url_not_allowed"`3256432565 - `"url_not_in_prior_context"`3256632567 - `"url_not_accessible"`3256832569 - `"unsupported_content_type"`3257032571 - `"too_many_requests"`3257232573 - `"max_uses_exceeded"`3257432575 - `"unavailable"`3257632577 - `"content_too_large"`3257832579 - `WebFetchBlock object`3258032581 - `type: "web_fetch_result"`3258232583 default: web_fetch_result3258432585 - `content: DocumentBlock`3258632587 - `type: "document"`3258832589 default: document3259032591 - `citations: CitationsConfig or null`3259232593 Citation configuration for the document3259432595 - `enabled: boolean`3259632597 default: false3259832599 - `source: Base64PDFSource or PlainTextSource`3260032601 - `Base64PDFSource object`3260232603 - `type: "base64"`3260432605 - `data: string`3260632607 format: byte3260832609 - `media_type: "application/pdf"`3261032611 - `PlainTextSource object`3261232613 - `type: "text"`3261432615 - `data: string`3261632617 - `media_type: "text/plain"`3261832619 - `title: string or null`3262032621 The title of the document3262232623 - `retrieved_at: string or null`3262432625 ISO 8601 timestamp when the content was retrieved3262632627 - `url: string`3262832629 Fetched content URL3263032631 - `tool_use_id: string`3263232633 pattern: ^srvtoolu_[a-zA-Z0-9_]+$3263432635 - `CodeExecutionToolResultBlock object`3263632637 - `type: "code_execution_tool_result"`3263832639 default: code_execution_tool_result3264032641 - `content: CodeExecutionToolResultBlockContent`3264232643 - `CodeExecutionToolResultError object`3264432645 - `type: "code_execution_tool_result_error"`3264632647 default: code_execution_tool_result_error3264832649 - `error_code: CodeExecutionToolResultErrorCode`3265032651 - `"invalid_tool_input"`3265232653 - `"unavailable"`3265432655 - `"too_many_requests"`3265632657 - `"execution_time_exceeded"`3265832659 - `CodeExecutionResultBlock object`3266032661 - `type: "code_execution_result"`3266232663 default: code_execution_result3266432665 - `content: array of CodeExecutionOutputBlock`3266632667 - `type: "code_execution_output"`3266832669 default: code_execution_output3267032671 - `file_id: string`3267232673 - `return_code: number`3267432675 - `stderr: string`3267632677 - `stdout: string`3267832679 - `EncryptedCodeExecutionResultBlock object`3268032681 Code execution result with encrypted stdout for PFC + web_search results.3268232683 - `type: "encrypted_code_execution_result"`3268432685 default: encrypted_code_execution_result3268632687 - `content: array of CodeExecutionOutputBlock`3268832689 - `type: "code_execution_output"`3269032691 default: code_execution_output3269232693 - `file_id: string`3269432695 - `encrypted_stdout: string`3269632697 - `return_code: number`3269832699 - `stderr: string`3270032701 - `tool_use_id: string`3270232703 pattern: ^srvtoolu_[a-zA-Z0-9_]+$3270432705 - `BashCodeExecutionToolResultBlock object`3270632707 - `type: "bash_code_execution_tool_result"`3270832709 default: bash_code_execution_tool_result3271032711 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`3271232713 - `BashCodeExecutionToolResultError object`3271432715 - `type: "bash_code_execution_tool_result_error"`3271632717 default: bash_code_execution_tool_result_error3271832719 - `error_code: BashCodeExecutionToolResultErrorCode`3272032721 - `"invalid_tool_input"`3272232723 - `"unavailable"`3272432725 - `"too_many_requests"`3272632727 - `"execution_time_exceeded"`3272832729 - `"output_file_too_large"`3273032731 - `BashCodeExecutionResultBlock object`3273232733 - `type: "bash_code_execution_result"`3273432735 default: bash_code_execution_result3273632737 - `content: array of BashCodeExecutionOutputBlock`3273832739 - `type: "bash_code_execution_output"`3274032741 default: bash_code_execution_output3274232743 - `file_id: string`3274432745 - `return_code: number`3274632747 - `stderr: string`3274832749 - `stdout: string`3275032751 - `tool_use_id: string`3275232753 pattern: ^srvtoolu_[a-zA-Z0-9_]+$3275432755 - `TextEditorCodeExecutionToolResultBlock object`3275632757 - `type: "text_editor_code_execution_tool_result"`3275832759 default: text_editor_code_execution_tool_result3276032761 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`3276232763 - `TextEditorCodeExecutionToolResultError object`3276432765 - `type: "text_editor_code_execution_tool_result_error"`3276632767 default: text_editor_code_execution_tool_result_error3276832769 - `error_code: TextEditorCodeExecutionToolResultErrorCode`3277032771 - `"invalid_tool_input"`3277232773 - `"unavailable"`3277432775 - `"too_many_requests"`3277632777 - `"execution_time_exceeded"`3277832779 - `"file_not_found"`3278032781 - `error_message: string or null`3278232783 - `TextEditorCodeExecutionViewResultBlock object`3278432785 - `type: "text_editor_code_execution_view_result"`3278632787 default: text_editor_code_execution_view_result3278832789 - `content: string`3279032791 - `file_type: "text" or "image" or "pdf"`3279232793 - `"text"`3279432795 - `"image"`3279632797 - `"pdf"`3279832799 - `num_lines: number or null`3280032801 - `start_line: number or null`3280232803 - `total_lines: number or null`3280432805 - `TextEditorCodeExecutionCreateResultBlock object`3280632807 - `type: "text_editor_code_execution_create_result"`3280832809 default: text_editor_code_execution_create_result3281032811 - `is_file_update: boolean`3281232813 - `TextEditorCodeExecutionStrReplaceResultBlock object`3281432815 - `type: "text_editor_code_execution_str_replace_result"`3281632817 default: text_editor_code_execution_str_replace_result3281832819 - `lines: array of string or null`3282032821 - `new_lines: number or null`3282232823 - `new_start: number or null`3282432825 - `old_lines: number or null`3282632827 - `old_start: number or null`3282832829 - `tool_use_id: string`3283032831 pattern: ^srvtoolu_[a-zA-Z0-9_]+$3283232833 - `ToolSearchToolResultBlock object`3283432835 - `type: "tool_search_tool_result"`3283632837 default: tool_search_tool_result3283832839 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`3284032841 - `ToolSearchToolResultError object`3284232843 - `type: "tool_search_tool_result_error"`3284432845 default: tool_search_tool_result_error3284632847 - `error_code: ToolSearchToolResultErrorCode`3284832849 - `"invalid_tool_input"`3285032851 - `"unavailable"`3285232853 - `"too_many_requests"`3285432855 - `"execution_time_exceeded"`3285632857 - `error_message: string or null`3285832859 - `ToolSearchToolSearchResultBlock object`3286032861 - `type: "tool_search_tool_search_result"`3286232863 default: tool_search_tool_search_result3286432865 - `tool_references: array of ToolReferenceBlock`3286632867 - `type: "tool_reference"`3286832869 default: tool_reference3287032871 - `tool_name: string`3287232873 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$3287432875 - `tool_use_id: string`3287632877 pattern: ^srvtoolu_[a-zA-Z0-9_]+$3287832879 - `ContainerUploadBlock object`3288032881 Response model for a file uploaded to the container.3288232883 - `type: "container_upload"`3288432885 default: container_upload3288632887 - `file_id: string`3288832889 - `model: Model`3289032891 The model that will complete your prompt.3289232893 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.3289432895 - `"claude-fable-5-1" or "claude-mythos-5-1" or "claude-sonnet-5" or 14 more`3289632897 The model that will complete your prompt.3289832899 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.3290032901 - `"claude-fable-5-1"`3290232903 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows3290432905 - `"claude-mythos-5-1"`3290632907 Our most capable model for cybersecurity and biology research, available through trusted access programs3290832909 - `"claude-sonnet-5"`3291032911 High-performance model for coding and agents3291232913 - `"claude-fable-5"`3291432915 Next generation of intelligence for the hardest knowledge work and coding problems3291632917 - `"claude-mythos-5"`3291832919 Most capable model for cybersecurity and biology research3292032921 - `"claude-opus-5"`3292232923 Powerful intelligence for long-running agents and coding3292432925 - `"claude-opus-4-8"`3292632927 Powerful intelligence for long-running agents and coding3292832929 - `"claude-opus-4-7"`3293032931 Powerful intelligence for long-running agents and coding3293232933 - `"claude-mythos-preview"`3293432935 New class of intelligence, strongest in coding and cybersecurity3293632937 - `"claude-opus-4-6"`3293832939 Powerful intelligence for long-running agents and coding3294032941 - `"claude-sonnet-4-6"`3294232943 Best combination of speed and intelligence3294432945 - `"claude-haiku-4-5"`3294632947 Fastest model with near-frontier intelligence3294832949 - `"claude-haiku-4-5-20251001"`3295032951 Fastest model with near-frontier intelligence3295232953 - `"claude-opus-4-5"`3295432955 Powerful intelligence for long-running agents and coding3295632957 - `"claude-opus-4-5-20251101"`3295832959 Powerful intelligence for long-running agents and coding3296032961 - `"claude-sonnet-4-5"`3296232963 High-performance model for agents and coding3296432965 - `"claude-sonnet-4-5-20250929"`3296632967 High-performance model for agents and coding3296832969 - `string`3297032971 - `role: "assistant"`3297232973 Conversational role of the generated message.3297432975 This will always be `"assistant"`.3297632977 default: assistant3297832979 - `stop_details: RefusalStopDetails or null`3298032981 Structured information about a refusal.3298232983 - `type: "refusal"`3298432985 default: refusal3298632987 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`3298832989 The policy category that triggered a refusal.3299032991 - `"cyber"`3299232993 The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category.3299432995 - `"bio"`3299632997 The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category.3299832999 - `"frontier_llm"`3300033001 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.3300233003 - `"reasoning_extraction"`3300433005 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).3300633007 - `"general_harms"`3300833009 The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category.3301033011 - `explanation: string or null`3301233013 Human-readable explanation of the refusal.3301433015 This text is not guaranteed to be stable. `null` when no explanation is available for the category.3301633017 - `stop_reason: StopReason or null`3301833019 The reason that we stopped.3302033021 This may be one the following values:3302233023 * `"end_turn"`: the model reached a natural stopping point33024 * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum33025 * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated33026 * `"tool_use"`: the model invoked one or more tools33027 * `"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.33028 * `"refusal"`: when streaming classifiers intervene to handle potential policy violations33029 * `"model_context_window_exceeded"`: we exceeded the model's context window3303033031 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.3303233033 - `"end_turn"`3303433035 - `"max_tokens"`3303633037 - `"stop_sequence"`3303833039 - `"tool_use"`3304033041 - `"pause_turn"`3304233043 - `"refusal"`3304433045 - `"model_context_window_exceeded"`3304633047 - `stop_sequence: string or null`3304833049 Which custom stop sequence was generated, if any.3305033051 This value will be a non-null string if one of your custom stop sequences was generated.3305233053 - `usage: Usage`3305433055 Billing and rate-limit usage.3305633057 Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.3305833059 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.3306033061 For example, `output_tokens` will be non-zero, even for an empty string response from Claude.3306233063 Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`.3306433065 - `cache_creation: CacheCreation or null`3306633067 Breakdown of cached tokens by TTL3306833069 - `ephemeral_1h_input_tokens: number`3307033071 The number of input tokens used to create the 1 hour cache entry.3307233073 default: 0, minimum: 03307433075 - `ephemeral_5m_input_tokens: number`3307633077 The number of input tokens used to create the 5 minute cache entry.3307833079 default: 0, minimum: 03308033081 - `cache_creation_input_tokens: number or null`3308233083 The number of input tokens used to create the cache entry.3308433085 minimum: 03308633087 - `cache_read_input_tokens: number or null`3308833089 The number of input tokens read from the cache.3309033091 minimum: 03309233093 - `inference_geo: string or null`3309433095 The geographic region where inference was performed for this request.3309633097 - `input_tokens: number`3309833099 The number of input tokens which were used.3310033101 minimum: 03310233103 - `output_tokens: number`3310433105 The number of output tokens which were used.3310633107 minimum: 03310833109 - `output_tokens_details: OutputTokensDetails or null`3311033111 Breakdown of output tokens by category.3311233113 `output_tokens` remains the inclusive, authoritative total used for billing.33114 This object provides a read-only decomposition for observability — for example,33115 how many of the billed output tokens were spent on internal reasoning that may33116 have been summarized before being returned to you.3311733118 - `thinking_tokens: number`3311933120 Number of output tokens the model generated as internal reasoning, including33121 the thinking-block delimiter tokens.3312233123 Reflects the raw reasoning the model produced, not the (possibly shorter)33124 summarized thinking text returned in the response body. Computed by33125 re-tokenizing the raw reasoning text, so it may differ from the model's exact33126 generation count by a small number of tokens. Always ≤ `output_tokens`;33127 `output_tokens - thinking_tokens` approximates the non-reasoning output.3312833129 default: 0, minimum: 03313033131 - `server_tool_use: ServerToolUsage or null`3313233133 The number of server tool requests.3313433135 - `web_fetch_requests: number`3313633137 The number of web fetch tool requests.3313833139 default: 0, minimum: 03314033141 - `web_search_requests: number`3314233143 The number of web search tool requests.3314433145 default: 0, minimum: 03314633147 - `service_tier: "standard" or "priority" or "batch" or null`3314833149 If the request used the priority, standard, or batch tier.3315033151 - `"standard"`3315233153 - `"priority"`3315433155 - `"batch"`3315633157 - `MessageBatchErroredResult object`3315833159 - `type: "errored"`3316033161 default: errored3316233163 - `error: ErrorResponse`3316433165 - `type: "error"`3316633167 default: error3316833169 - `error: ErrorObject`3317033171 - `InvalidRequestError object`3317233173 - `type: "invalid_request_error"`3317433175 default: invalid_request_error3317633177 - `message: string`3317833179 default: Invalid request3318033181 - `AuthenticationError object`3318233183 - `type: "authentication_error"`3318433185 default: authentication_error3318633187 - `message: string`3318833189 default: Authentication error3319033191 - `BillingError object`3319233193 - `type: "billing_error"`3319433195 default: billing_error3319633197 - `message: string`3319833199 default: Billing error3320033201 - `PermissionError object`3320233203 - `type: "permission_error"`3320433205 default: permission_error3320633207 - `message: string`3320833209 default: Permission denied3321033211 - `NotFoundError object`3321233213 - `type: "not_found_error"`3321433215 default: not_found_error3321633217 - `message: string`3321833219 default: Not found3322033221 - `RateLimitError object`3322233223 - `type: "rate_limit_error"`3322433225 default: rate_limit_error3322633227 - `message: string`3322833229 default: Rate limited3323033231 - `GatewayTimeoutError object`3323233233 - `type: "timeout_error"`3323433235 default: timeout_error3323633237 - `message: string`3323833239 default: Request timeout3324033241 - `APIErrorObject object`3324233243 - `type: "api_error"`3324433245 default: api_error3324633247 - `message: string`3324833249 default: Internal server error3325033251 - `OverloadedError object`3325233253 - `type: "overloaded_error"`3325433255 default: overloaded_error3325633257 - `message: string`3325833259 default: Overloaded3326033261 - `request_id: string or null`3326233263 - `MessageBatchCanceledResult object`3326433265 - `type: "canceled"`3326633267 default: canceled3326833269 - `MessageBatchExpiredResult object`3327033271 - `type: "expired"`3327233273 default: expired3327433275#### Example3327633277```bash33278curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID/results \33279 -H 'anthropic-version: 2023-06-01' \33280 -H "X-Api-Key: $ANTHROPIC_API_KEY"33281```33282