--- title: Messages url: https://platform.claude.com/docs/en/api/java/messages --- # Messages ## Create a Message `Message messages().create(params, requestOptions = RequestOptions.none())` **POST** `/v1/messages` Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation. The Messages API can be used for either single queries or stateless multi-turn conversations. Learn more about the Messages API in our [user guide](https://platform.claude.com/docs/en/get-started?sdk_languages=java) ### Parameters - `MessageCreateParams params` - `Optional userProfileId` (header parameter) The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. - `long maxTokens` The maximum number of tokens to generate before stopping. Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=java) for details. minimum: 0 - `List messages` Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=java#prefill-not-supported). Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude, for models that support prefill: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=java). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=java#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `Content content` - `String` - `List` - `class TextBlockParam` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional> citations` - `class CitationCharLocationParam` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endCharIndex` - `long startCharIndex` minimum: 0 - `class CitationPageLocationParam` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endPageNumber` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocationParam` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationWebSearchResultLocationParam` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` minLength: 1, maxLength: 512 - `String url` minLength: 1 - `class CitationSearchResultLocationParam` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `class ImageBlockParam` - `JsonValue type = "image"` - `Source source` - `class Base64ImageSource` - `JsonValue type = "base64"` - `String data` format: byte - `MediaType mediaType` - `IMAGE_JPEG("image/jpeg")` - `IMAGE_PNG("image/png")` - `IMAGE_GIF("image/gif")` - `IMAGE_WEBP("image/webp")` - `class UrlImageSource` - `JsonValue type = "url"` - `String url` - `class FileImageSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional transformations` 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. - `Optional oversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `DOWNSIZE("downsize")` - `ERROR("error")` - `class DocumentBlockParam` - `JsonValue type = "document"` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `class ContentBlockSource` - `JsonValue type = "content"` - `Content content` - `String` - `List` - `class TextBlockParam` - `class ImageBlockParam` - `class UrlPdfSource` - `JsonValue type = "url"` - `String url` - `class FileDocumentSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` - `Optional enabled` - `Optional context` minLength: 1 - `Optional title` minLength: 1, maxLength: 500 - `class SearchResultBlockParam` - `JsonValue type = "search_result"` - `List content` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional> citations` - `String source` - `String title` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` - `class ThinkingBlockParam` - `JsonValue type = "thinking"` - `String signature` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `String thinking` The `thinking` text of this block as returned by the API. - `class RedactedThinkingBlockParam` - `JsonValue type = "redacted_thinking"` - `String data` 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. - `class ToolUseBlockParam` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `Input input` - `String name` minLength: 1, maxLength: 200 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional toolsetName` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ToolResultBlockParam` - `JsonValue type = "tool_result"` - `String toolUseId` pattern: ^[a-zA-Z0-9_-]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional content` - `String` - `List` - `class TextBlockParam` - `class ImageBlockParam` - `class SearchResultBlockParam` - `class DocumentBlockParam` - `class ToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class BrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonValue type = "browser_state"` - `List tabs` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `String tabId` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional> stateChanges` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `class BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonValue type = "tab_opened"` - `String tabId` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonValue type = "download_started"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonValue type = "download_completed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional sizeBytes` The completed download's size. minimum: 0 - `class BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonValue type = "download_failed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional isError` - `Optional toolsetName` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ServerToolUseBlockParam` - `JsonValue type = "server_tool_use"` - `String id` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input input` - `Name name` - `WEB_SEARCH("web_search")` - `WEB_FETCH("web_fetch")` - `CODE_EXECUTION("code_execution")` - `BASH_CODE_EXECUTION("bash_code_execution")` - `TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `class WebSearchToolResultBlockParam` - `JsonValue type = "web_search_tool_result"` - `WebSearchToolResultBlockParamContent content` - `List` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `String title` - `String url` - `Optional pageAge` - `class WebSearchToolRequestError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `class WebFetchToolResultBlockParam` - `JsonValue type = "web_fetch_tool_result"` - `Content content` - `class WebFetchToolResultErrorBlockParam` - `JsonValue type = "web_fetch_tool_result_error"` - `WebFetchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` - `class WebFetchBlockParam` - `JsonValue type = "web_fetch_result"` - `DocumentBlockParam content` - `String url` Fetched content URL - `Optional retrievedAt` ISO 8601 timestamp when the content was retrieved - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `class CodeExecutionToolResultBlockParam` - `JsonValue type = "code_execution_tool_result"` - `CodeExecutionToolResultBlockParamContent content` - `class CodeExecutionToolResultErrorParam` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `class CodeExecutionResultBlockParam` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `class EncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class BashCodeExecutionToolResultBlockParam` - `JsonValue type = "bash_code_execution_tool_result"` - `Content content` - `class BashCodeExecutionToolResultErrorParam` - `JsonValue type = "bash_code_execution_tool_result_error"` - `BashCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` - `class BashCodeExecutionResultBlockParam` - `JsonValue type = "bash_code_execution_result"` - `List content` - `JsonValue type = "bash_code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class TextEditorCodeExecutionToolResultBlockParam` - `JsonValue type = "text_editor_code_execution_tool_result"` - `Content content` - `class TextEditorCodeExecutionToolResultErrorParam` - `JsonValue type = "text_editor_code_execution_tool_result_error"` - `TextEditorCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` - `Optional errorMessage` - `class TextEditorCodeExecutionViewResultBlockParam` - `JsonValue type = "text_editor_code_execution_view_result"` - `String content` - `FileType fileType` - `TEXT("text")` - `IMAGE("image")` - `PDF("pdf")` - `Optional numLines` - `Optional startLine` - `Optional totalLines` - `class TextEditorCodeExecutionCreateResultBlockParam` - `JsonValue type = "text_editor_code_execution_create_result"` - `boolean isFileUpdate` - `class TextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonValue type = "text_editor_code_execution_str_replace_result"` - `Optional> lines` - `Optional newLines` - `Optional newStart` - `Optional oldLines` - `Optional oldStart` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class ToolSearchToolResultBlockParam` - `JsonValue type = "tool_search_tool_result"` - `Content content` - `class ToolSearchToolResultErrorParam` - `JsonValue type = "tool_search_tool_result_error"` - `ToolSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `Optional errorMessage` - `class ToolSearchToolSearchResultBlockParam` - `JsonValue type = "tool_search_tool_search_result"` - `List toolReferences` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class ContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `JsonValue type = "container_upload"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Role role` - `USER("user")` - `ASSISTANT("assistant")` - `SYSTEM("system")` - `Model model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `Optional cacheControl` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `Optional container` Container identifier for reuse across requests. - `Optional diagnostics` Request-level diagnostics. Supply `previous_message_id` to have the response include `diagnostics.cache_miss_reason` explaining any prompt-cache divergence from that prior request. - `Optional inferenceGeo` Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. - `Optional metadata` An object describing metadata about the request. - `Optional outputConfig` Configuration options for the model's output, such as the output format. - `Optional serviceTier` Determines whether to use priority capacity (if available) or standard capacity for this request. Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers?sdk_languages=java) for details. - `AUTO("auto")` - `STANDARD_ONLY("standard_only")` - `Optional speed` The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. Some models require the `fast-mode-2026-02-01` beta header for any `speed` value. See [fast mode](https://platform.claude.com/docs/en/build-with-claude/fast-mode?sdk_languages=java) for which models. - `STANDARD("standard")` - `FAST("fast")` - `Optional> stopSequences` Custom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`. If you want the model to stop generating when it encounters custom strings of text, you can use the `stop_sequences` parameter. If the model encounters one of the custom sequences, the response `stop_reason` value will be `"stop_sequence"` and the response `stop_sequence` value will contain the matched stop sequence. - `Optional system` System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=java#give-claude-a-role). - `String` - `List` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional> citations` - `Optional thinking` Configuration for Claude's thinking. With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit. Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=java#configuring-thinking) for each model's behavior. - `Optional toolChoice` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. - `Optional> tools` Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=java), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=java)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And then asked the model "What's the S&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=java) for more details. - `class Tool` - `Optional type` - `InputSchema inputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `JsonValue type = "object"` - `Optional properties` - `Optional> required` - `String name` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional description` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `Optional eagerInputStreaming` 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. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolBash20250124` - `JsonValue type = "bash_20250124"` - `JsonValue name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20250522` - `JsonValue type = "code_execution_20250522"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20250825` - `JsonValue type = "code_execution_20250825"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `JsonValue type = "code_execution_20260120"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonValue type = "code_execution_20260521"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class BrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonValue type = "browser_toolset_20260801"` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Optional type` `type`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional closeTab` `close_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional doubleClick` `double_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional fileUpload` `file_upload`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional find` `find`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional formInput` `form_input`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional getPageText` `get_page_text`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional holdKey` `hold_key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional hover` `hover`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional javascriptExec` `javascript_exec`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional key` `key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClick` `left_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClickDrag` `left_click_drag`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseDown` `left_mouse_down`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseUp` `left_mouse_up`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional listTabs` `list_tabs`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional middleClick` `middle_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional mouseMove` `mouse_move`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional navigate` `navigate`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional newTab` `new_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readConsole` `read_console`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readNetwork` `read_network`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readPage` `read_page`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional rightClick` `right_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional screenshot` `screenshot`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scroll` `scroll`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scrollTo` `scroll_to`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional switchTab` `switch_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional tripleClick` `triple_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional wait` `wait`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional zoom` `zoom`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class MemoryTool20250818` - `JsonValue type = "memory_20250818"` - `JsonValue name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonValue type = "computer_toolset_20260801"` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Optional type` `type`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional cursorPosition` `cursor_position`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional doubleClick` `double_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional holdKey` `hold_key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional key` `key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClick` `left_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClickDrag` `left_click_drag`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseDown` `left_mouse_down`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseUp` `left_mouse_up`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional middleClick` `middle_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional mouseMove` `mouse_move`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional rightClick` `right_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional screenshot` `screenshot`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scroll` `scroll`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional tripleClick` `triple_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional wait` `wait`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional zoom` `zoom`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class ToolTextEditor20250124` - `JsonValue type = "text_editor_20250124"` - `JsonValue name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolTextEditor20250429` - `JsonValue type = "text_editor_20250429"` - `JsonValue name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolTextEditor20250728` - `JsonValue type = "text_editor_20250728"` - `JsonValue name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional maxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class WebSearchTool20250305` - `JsonValue type = "web_search_20250305"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonValue type = "approximate"` - `Optional city` The city of the user. minLength: 1, maxLength: 255 - `Optional country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Optional region` The region of the user. minLength: 1, maxLength: 255 - `Optional timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class WebFetchTool20250910` - `JsonValue type = "web_fetch_20250910"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional clientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonValue type = "all"` - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonValue type = "none"` - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonValue type = "only"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonValue type = "except"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `Optional serverToolResults` 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. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Optional userInput` Whether URLs in user messages are fetchable: "all" or "none". - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class WebSearchTool20260209` - `JsonValue type = "web_search_20260209"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `class WebFetchTool20260209` - `JsonValue type = "web_fetch_20260209"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class WebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonValue type = "web_fetch_20260309"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional useCache` 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. - `class WebSearchTool20260318` - `JsonValue type = "web_search_20260318"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional responseInclusion` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `FULL("full")` - `EXCLUDED("excluded")` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `class WebFetchTool20260318` - `JsonValue type = "web_fetch_20260318"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional responseInclusion` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `FULL("full")` - `EXCLUDED("excluded")` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional useCache` 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. - `class ToolSearchToolBm25_20251119` - `Type type` - `TOOL_SEARCH_TOOL_BM25_20251119("tool_search_tool_bm25_20251119")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `JsonValue name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolSearchToolRegex20251119` - `Type type` - `TOOL_SEARCH_TOOL_REGEX_20251119("tool_search_tool_regex_20251119")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `JsonValue name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional temperature` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. Amount of randomness injected into the response. Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks. Note that even with `temperature` of `0.0`, the results will not be fully deterministic. minimum: 0, maximum: 1 - `Optional topK` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error. Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). Recommended for advanced use cases only. minimum: 0 - `Optional topP` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting top_p. A value >= 0.99 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. Use nucleus sampling. In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`. Recommended for advanced use cases only. minimum: 0, maximum: 1 ### Returns - `class Message` - `JsonValue type = "message"` Object type. For Messages, this is always `"message"`. - `String id` Unique object identifier. The format and length of IDs may change over time. - `Optional container` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `String id` Identifier for the container used in this request - `LocalDateTime expiresAt` The time at which the container will expire. format: date-time - `Optional> skills` Skills loaded in the container - `Type type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `ANTHROPIC("anthropic")` - `CUSTOM("custom")` - `String skillId` Skill ID minLength: 1, maxLength: 64 - `String version` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `List content` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `class TextBlock` - `JsonValue type = "text"` - `Optional> citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class CitationCharLocation` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endCharIndex` - `Optional fileId` - `long startCharIndex` minimum: 0 - `class CitationPageLocation` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endPageNumber` - `Optional fileId` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocation` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `Optional fileId` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationsWebSearchResultLocation` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` maxLength: 512 - `String url` - `class CitationsSearchResultLocation` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `String text` - `class ThinkingBlock` - `JsonValue type = "thinking"` - `String signature` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java) for details. - `String thinking` The text of Claude's thinking process for this block. - `class RedactedThinkingBlock` - `JsonValue type = "redacted_thinking"` - `String data` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java#redacted-thinking-blocks) for details. - `class ToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input input` - `String name` minLength: 1 - `Optional toolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ServerToolUseBlock` - `JsonValue type = "server_tool_use"` - `String id` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `Input input` - `Name name` - `WEB_SEARCH("web_search")` - `WEB_FETCH("web_fetch")` - `CODE_EXECUTION("code_execution")` - `BASH_CODE_EXECUTION("bash_code_execution")` - `TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `class WebSearchToolResultBlock` - `JsonValue type = "web_search_tool_result"` - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `WebSearchToolResultBlockContent content` - `class WebSearchToolResultError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` - `List` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `Optional pageAge` - `String title` - `String url` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class WebFetchToolResultBlock` - `JsonValue type = "web_fetch_tool_result"` - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `Content content` - `class WebFetchToolResultErrorBlock` - `JsonValue type = "web_fetch_tool_result_error"` - `WebFetchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` - `class WebFetchBlock` - `JsonValue type = "web_fetch_result"` - `DocumentBlock content` - `JsonValue type = "document"` - `Optional citations` Citation configuration for the document - `boolean enabled` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `Optional title` The title of the document - `Optional retrievedAt` ISO 8601 timestamp when the content was retrieved - `String url` Fetched content URL - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class CodeExecutionToolResultBlock` - `JsonValue type = "code_execution_tool_result"` - `CodeExecutionToolResultBlockContent content` - `class CodeExecutionToolResultError` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `class CodeExecutionResultBlock` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `class EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BashCodeExecutionToolResultBlock` - `JsonValue type = "bash_code_execution_tool_result"` - `Content content` - `class BashCodeExecutionToolResultError` - `JsonValue type = "bash_code_execution_tool_result_error"` - `BashCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` - `class BashCodeExecutionResultBlock` - `JsonValue type = "bash_code_execution_result"` - `List content` - `JsonValue type = "bash_code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class TextEditorCodeExecutionToolResultBlock` - `JsonValue type = "text_editor_code_execution_tool_result"` - `Content content` - `class TextEditorCodeExecutionToolResultError` - `JsonValue type = "text_editor_code_execution_tool_result_error"` - `TextEditorCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` - `Optional errorMessage` - `class TextEditorCodeExecutionViewResultBlock` - `JsonValue type = "text_editor_code_execution_view_result"` - `String content` - `FileType fileType` - `TEXT("text")` - `IMAGE("image")` - `PDF("pdf")` - `Optional numLines` - `Optional startLine` - `Optional totalLines` - `class TextEditorCodeExecutionCreateResultBlock` - `JsonValue type = "text_editor_code_execution_create_result"` - `boolean isFileUpdate` - `class TextEditorCodeExecutionStrReplaceResultBlock` - `JsonValue type = "text_editor_code_execution_str_replace_result"` - `Optional> lines` - `Optional newLines` - `Optional newStart` - `Optional oldLines` - `Optional oldStart` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ToolSearchToolResultBlock` - `JsonValue type = "tool_search_tool_result"` - `Content content` - `class ToolSearchToolResultError` - `JsonValue type = "tool_search_tool_result_error"` - `ToolSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `Optional errorMessage` - `class ToolSearchToolSearchResultBlock` - `JsonValue type = "tool_search_tool_search_result"` - `List toolReferences` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ContainerUploadBlock` Response model for a file uploaded to the container. - `JsonValue type = "container_upload"` - `String fileId` - `Optional diagnostics` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `Optional cacheMissReason` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `class CacheMissModelChanged` - `JsonValue type = "model_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissSystemChanged` - `JsonValue type = "system_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissToolsChanged` - `JsonValue type = "tools_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissMessagesChanged` - `JsonValue type = "messages_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissPreviousMessageNotFound` - `JsonValue type = "previous_message_not_found"` - `class CacheMissUnavailable` - `JsonValue type = "unavailable"` - `Model model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `CLAUDE_HAIKU_5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `CLAUDE_SONNET_5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `CLAUDE_FABLE_5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `CLAUDE_OPUS_5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `CLAUDE_MYTHOS_5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `CLAUDE_SONNET_5("claude-sonnet-5")` Efficient model for coding and agents - `CLAUDE_FABLE_5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `CLAUDE_MYTHOS_5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `CLAUDE_OPUS_5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `CLAUDE_SONNET_4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `CLAUDE_HAIKU_4_5("claude-haiku-4-5")` - `CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")` - `CLAUDE_OPUS_4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `CLAUDE_MYTHOS_PREVIEW("claude-mythos-preview")` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `CLAUDE_SONNET_4_5("claude-sonnet-4-5")` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `JsonValue role = "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `Optional stopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `JsonValue type = "refusal"` - `Optional category` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `CYBER("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `BIO("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FRONTIER_LLM("frontier_llm")` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `REASONING_EXTRACTION("reasoning_extraction")` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=java). - `GENERAL_HARMS("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `Optional explanation` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `Optional stopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations * `"model_context_window_exceeded"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `END_TURN("end_turn")` - `MAX_TOKENS("max_tokens")` - `STOP_SEQUENCE("stop_sequence")` - `TOOL_USE("tool_use")` - `PAUSE_TURN("pause_turn")` - `REFUSAL("refusal")` - `MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")` - `Optional stopSequence` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Usage usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `Optional cacheCreation` Breakdown of cached tokens by TTL - `long ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `long ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `Optional cacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `Optional cacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `Optional inferenceGeo` The geographic region where inference was performed for this request. - `long inputTokens` The number of input tokens which were used. minimum: 0 - `long outputTokens` The number of output tokens which were used. minimum: 0 - `Optional outputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `long thinkingTokens` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. minimum: 0 - `Optional serverToolUse` The number of server tool requests. - `long webFetchRequests` The number of web fetch tool requests. minimum: 0 - `long webSearchRequests` The number of web search tool requests. minimum: 0 - `Optional serviceTier` If the request used the priority, standard, or batch tier. - `STANDARD("standard")` - `PRIORITY("priority")` - `BATCH("batch")` - `Optional speed` The inference speed mode used for this request. - `STANDARD("standard")` - `FAST("fast")` - `class RawMessageStreamEvent: union` - `class RawMessageStartEvent` - `JsonValue type = "message_start"` - `Message message` - `class RawMessageDeltaEvent` - `JsonValue type = "message_delta"` - `Delta delta` - `Optional container` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `Optional stopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `Optional stopReason` - `Optional stopSequence` - `MessageDeltaUsage usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `Optional cacheCreationInputTokens` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `Optional cacheReadInputTokens` The cumulative number of input tokens read from the cache. minimum: 0 - `Optional inputTokens` The cumulative number of input tokens which were used. minimum: 0 - `long outputTokens` The cumulative number of output tokens which were used. - `Optional outputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `Optional serverToolUse` The number of server tool requests. - `class RawMessageStopEvent` - `JsonValue type = "message_stop"` - `class RawContentBlockStartEvent` - `JsonValue type = "content_block_start"` - `ContentBlock contentBlock` - `class TextBlock` - `class ThinkingBlock` - `class RedactedThinkingBlock` - `class ToolUseBlock` - `class ServerToolUseBlock` - `class WebSearchToolResultBlock` - `class WebFetchToolResultBlock` - `class CodeExecutionToolResultBlock` - `class BashCodeExecutionToolResultBlock` - `class TextEditorCodeExecutionToolResultBlock` - `class ToolSearchToolResultBlock` - `class ContainerUploadBlock` Response model for a file uploaded to the container. - `long index` - `class RawContentBlockDeltaEvent` - `JsonValue type = "content_block_delta"` - `RawContentBlockDelta delta` - `class TextDelta` - `JsonValue type = "text_delta"` - `String text` - `class InputJsonDelta` - `JsonValue type = "input_json_delta"` - `String partialJson` - `class CitationsDelta` - `JsonValue type = "citations_delta"` - `Citation citation` - `class CitationCharLocation` - `class CitationPageLocation` - `class CitationContentBlockLocation` - `class CitationsWebSearchResultLocation` - `class CitationsSearchResultLocation` - `class ThinkingDelta` - `JsonValue type = "thinking_delta"` - `String thinking` 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. - `class SignatureDelta` - `JsonValue type = "signature_delta"` - `String signature` 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. - `long index` - `class RawContentBlockStopEvent` - `JsonValue type = "content_block_stop"` - `long index` ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.messages.Message; import com.anthropic.models.messages.MessageCreateParams; import com.anthropic.models.messages.Model; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); MessageCreateParams params = MessageCreateParams.builder() .maxTokens(1024L) .addUserMessage("Hello, world") .model(Model.CLAUDE_OPUS_5_5) .build(); Message message = client.messages().create(params); } } ``` #### Response (200) ```json { "id": "msg_013Zva2CMHLNnXjNJJKqJ2EF", "container": { "id": "container_011CpZohnwH4vuy7gazohgSP", "expires_at": "2019-12-27T18:11:19.117Z", "skills": [ { "skill_id": "pdf", "type": "anthropic", "version": "latest" } ] }, "content": [ { "citations": [ { "cited_text": "The grass is green. The sky is blue.", "document_index": 0, "document_title": "My Document", "end_char_index": 0, "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "start_char_index": 0, "type": "char_location" } ], "text": "Hi! My name is Claude.", "type": "text" } ], "diagnostics": { "cache_miss_reason": { "cache_missed_input_tokens": 0, "type": "model_changed" } }, "model": "claude-opus-5-5", "role": "assistant", "stop_details": { "category": "cyber", "explanation": "This request was declined because it conflicts with Anthropic's Usage Policy.", "type": "refusal" }, "stop_reason": "end_turn", "stop_sequence": null, "type": "message", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_creation_input_tokens": 2051, "cache_read_input_tokens": 2051, "inference_geo": "global", "input_tokens": 2095, "output_tokens": 503, "output_tokens_details": { "thinking_tokens": 0 }, "server_tool_use": { "web_fetch_requests": 2, "web_search_requests": 0 }, "service_tier": "standard", "speed": "standard" } } ``` ## Count tokens in a Message `MessageTokensCount messages().countTokens(params, requestOptions = RequestOptions.none())` **POST** `/v1/messages/count_tokens` Count the number of tokens in a Message. The Token Count API can be used to count the number of tokens in a Message, including tools, images, and documents, without creating it. Learn more about token counting in our [user guide](https://platform.claude.com/docs/en/build-with-claude/token-counting?sdk_languages=java) ### Parameters - `MessageCountTokensParams params` - `Optional userProfileId` (header parameter) The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. - `List messages` Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=java#prefill-not-supported). Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude, for models that support prefill: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=java). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=java#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `Content content` - `String` - `List` - `class TextBlockParam` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional> citations` - `class CitationCharLocationParam` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endCharIndex` - `long startCharIndex` minimum: 0 - `class CitationPageLocationParam` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endPageNumber` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocationParam` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationWebSearchResultLocationParam` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` minLength: 1, maxLength: 512 - `String url` minLength: 1 - `class CitationSearchResultLocationParam` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `class ImageBlockParam` - `JsonValue type = "image"` - `Source source` - `class Base64ImageSource` - `JsonValue type = "base64"` - `String data` format: byte - `MediaType mediaType` - `IMAGE_JPEG("image/jpeg")` - `IMAGE_PNG("image/png")` - `IMAGE_GIF("image/gif")` - `IMAGE_WEBP("image/webp")` - `class UrlImageSource` - `JsonValue type = "url"` - `String url` - `class FileImageSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional transformations` 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. - `Optional oversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `DOWNSIZE("downsize")` - `ERROR("error")` - `class DocumentBlockParam` - `JsonValue type = "document"` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `class ContentBlockSource` - `JsonValue type = "content"` - `Content content` - `String` - `List` - `class TextBlockParam` - `class ImageBlockParam` - `class UrlPdfSource` - `JsonValue type = "url"` - `String url` - `class FileDocumentSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` - `Optional enabled` - `Optional context` minLength: 1 - `Optional title` minLength: 1, maxLength: 500 - `class SearchResultBlockParam` - `JsonValue type = "search_result"` - `List content` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional> citations` - `String source` - `String title` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` - `class ThinkingBlockParam` - `JsonValue type = "thinking"` - `String signature` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `String thinking` The `thinking` text of this block as returned by the API. - `class RedactedThinkingBlockParam` - `JsonValue type = "redacted_thinking"` - `String data` 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. - `class ToolUseBlockParam` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `Input input` - `String name` minLength: 1, maxLength: 200 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional toolsetName` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ToolResultBlockParam` - `JsonValue type = "tool_result"` - `String toolUseId` pattern: ^[a-zA-Z0-9_-]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional content` - `String` - `List` - `class TextBlockParam` - `class ImageBlockParam` - `class SearchResultBlockParam` - `class DocumentBlockParam` - `class ToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class BrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonValue type = "browser_state"` - `List tabs` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `String tabId` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional> stateChanges` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `class BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonValue type = "tab_opened"` - `String tabId` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonValue type = "download_started"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonValue type = "download_completed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional sizeBytes` The completed download's size. minimum: 0 - `class BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonValue type = "download_failed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional isError` - `Optional toolsetName` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ServerToolUseBlockParam` - `JsonValue type = "server_tool_use"` - `String id` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input input` - `Name name` - `WEB_SEARCH("web_search")` - `WEB_FETCH("web_fetch")` - `CODE_EXECUTION("code_execution")` - `BASH_CODE_EXECUTION("bash_code_execution")` - `TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `class WebSearchToolResultBlockParam` - `JsonValue type = "web_search_tool_result"` - `WebSearchToolResultBlockParamContent content` - `List` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `String title` - `String url` - `Optional pageAge` - `class WebSearchToolRequestError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `class WebFetchToolResultBlockParam` - `JsonValue type = "web_fetch_tool_result"` - `Content content` - `class WebFetchToolResultErrorBlockParam` - `JsonValue type = "web_fetch_tool_result_error"` - `WebFetchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` - `class WebFetchBlockParam` - `JsonValue type = "web_fetch_result"` - `DocumentBlockParam content` - `String url` Fetched content URL - `Optional retrievedAt` ISO 8601 timestamp when the content was retrieved - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `class CodeExecutionToolResultBlockParam` - `JsonValue type = "code_execution_tool_result"` - `CodeExecutionToolResultBlockParamContent content` - `class CodeExecutionToolResultErrorParam` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `class CodeExecutionResultBlockParam` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `class EncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class BashCodeExecutionToolResultBlockParam` - `JsonValue type = "bash_code_execution_tool_result"` - `Content content` - `class BashCodeExecutionToolResultErrorParam` - `JsonValue type = "bash_code_execution_tool_result_error"` - `BashCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` - `class BashCodeExecutionResultBlockParam` - `JsonValue type = "bash_code_execution_result"` - `List content` - `JsonValue type = "bash_code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class TextEditorCodeExecutionToolResultBlockParam` - `JsonValue type = "text_editor_code_execution_tool_result"` - `Content content` - `class TextEditorCodeExecutionToolResultErrorParam` - `JsonValue type = "text_editor_code_execution_tool_result_error"` - `TextEditorCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` - `Optional errorMessage` - `class TextEditorCodeExecutionViewResultBlockParam` - `JsonValue type = "text_editor_code_execution_view_result"` - `String content` - `FileType fileType` - `TEXT("text")` - `IMAGE("image")` - `PDF("pdf")` - `Optional numLines` - `Optional startLine` - `Optional totalLines` - `class TextEditorCodeExecutionCreateResultBlockParam` - `JsonValue type = "text_editor_code_execution_create_result"` - `boolean isFileUpdate` - `class TextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonValue type = "text_editor_code_execution_str_replace_result"` - `Optional> lines` - `Optional newLines` - `Optional newStart` - `Optional oldLines` - `Optional oldStart` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class ToolSearchToolResultBlockParam` - `JsonValue type = "tool_search_tool_result"` - `Content content` - `class ToolSearchToolResultErrorParam` - `JsonValue type = "tool_search_tool_result_error"` - `ToolSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `Optional errorMessage` - `class ToolSearchToolSearchResultBlockParam` - `JsonValue type = "tool_search_tool_search_result"` - `List toolReferences` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class ContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `JsonValue type = "container_upload"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Role role` - `USER("user")` - `ASSISTANT("assistant")` - `SYSTEM("system")` - `Model model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `Optional cacheControl` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `Optional outputConfig` Configuration options for the model's output, such as the output format. - `Optional speed` The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. Some models require the `fast-mode-2026-02-01` beta header for any `speed` value. See [fast mode](https://platform.claude.com/docs/en/build-with-claude/fast-mode?sdk_languages=java) for which models. - `STANDARD("standard")` - `FAST("fast")` - `Optional system` System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=java#give-claude-a-role). - `String` - `List` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional> citations` - `Optional thinking` Configuration for Claude's thinking. With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit. Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=java#configuring-thinking) for each model's behavior. - `Optional toolChoice` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. - `Optional> tools` Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=java), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=java)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And then asked the model "What's the S&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=java) for more details. - `class Tool` - `Optional type` - `InputSchema inputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `JsonValue type = "object"` - `Optional properties` - `Optional> required` - `String name` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional description` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `Optional eagerInputStreaming` 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. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolBash20250124` - `JsonValue type = "bash_20250124"` - `JsonValue name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20250522` - `JsonValue type = "code_execution_20250522"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20250825` - `JsonValue type = "code_execution_20250825"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `JsonValue type = "code_execution_20260120"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonValue type = "code_execution_20260521"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class BrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonValue type = "browser_toolset_20260801"` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Optional type` `type`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional closeTab` `close_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional doubleClick` `double_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional fileUpload` `file_upload`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional find` `find`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional formInput` `form_input`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional getPageText` `get_page_text`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional holdKey` `hold_key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional hover` `hover`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional javascriptExec` `javascript_exec`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional key` `key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClick` `left_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClickDrag` `left_click_drag`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseDown` `left_mouse_down`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseUp` `left_mouse_up`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional listTabs` `list_tabs`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional middleClick` `middle_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional mouseMove` `mouse_move`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional navigate` `navigate`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional newTab` `new_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readConsole` `read_console`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readNetwork` `read_network`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readPage` `read_page`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional rightClick` `right_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional screenshot` `screenshot`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scroll` `scroll`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scrollTo` `scroll_to`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional switchTab` `switch_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional tripleClick` `triple_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional wait` `wait`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional zoom` `zoom`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class MemoryTool20250818` - `JsonValue type = "memory_20250818"` - `JsonValue name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonValue type = "computer_toolset_20260801"` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Optional type` `type`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional cursorPosition` `cursor_position`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional doubleClick` `double_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional holdKey` `hold_key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional key` `key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClick` `left_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClickDrag` `left_click_drag`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseDown` `left_mouse_down`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseUp` `left_mouse_up`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional middleClick` `middle_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional mouseMove` `mouse_move`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional rightClick` `right_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional screenshot` `screenshot`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scroll` `scroll`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional tripleClick` `triple_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional wait` `wait`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional zoom` `zoom`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class ToolTextEditor20250124` - `JsonValue type = "text_editor_20250124"` - `JsonValue name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolTextEditor20250429` - `JsonValue type = "text_editor_20250429"` - `JsonValue name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolTextEditor20250728` - `JsonValue type = "text_editor_20250728"` - `JsonValue name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional maxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class WebSearchTool20250305` - `JsonValue type = "web_search_20250305"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonValue type = "approximate"` - `Optional city` The city of the user. minLength: 1, maxLength: 255 - `Optional country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Optional region` The region of the user. minLength: 1, maxLength: 255 - `Optional timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class WebFetchTool20250910` - `JsonValue type = "web_fetch_20250910"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional clientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonValue type = "all"` - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonValue type = "none"` - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonValue type = "only"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonValue type = "except"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `Optional serverToolResults` 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. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Optional userInput` Whether URLs in user messages are fetchable: "all" or "none". - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class WebSearchTool20260209` - `JsonValue type = "web_search_20260209"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `class WebFetchTool20260209` - `JsonValue type = "web_fetch_20260209"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class WebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonValue type = "web_fetch_20260309"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional useCache` 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. - `class WebSearchTool20260318` - `JsonValue type = "web_search_20260318"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional responseInclusion` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `FULL("full")` - `EXCLUDED("excluded")` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `class WebFetchTool20260318` - `JsonValue type = "web_fetch_20260318"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional responseInclusion` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `FULL("full")` - `EXCLUDED("excluded")` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional useCache` 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. - `class ToolSearchToolBm25_20251119` - `Type type` - `TOOL_SEARCH_TOOL_BM25_20251119("tool_search_tool_bm25_20251119")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `JsonValue name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolSearchToolRegex20251119` - `Type type` - `TOOL_SEARCH_TOOL_REGEX_20251119("tool_search_tool_regex_20251119")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `JsonValue name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs ### Returns - `class MessageTokensCount` - `long inputTokens` The total number of tokens across the provided list of messages, system prompt, and tools. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.messages.MessageCountTokensParams; import com.anthropic.models.messages.MessageTokensCount; import com.anthropic.models.messages.Model; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); MessageCountTokensParams params = MessageCountTokensParams.builder() .addUserMessage("Hello, world") .model(Model.CLAUDE_OPUS_5_5) .build(); MessageTokensCount messageTokensCount = client.messages().countTokens(params); } } ``` #### Response (200) ```json { "input_tokens": 2095 } ``` ## Domain types ### Base64 Image Source - `class Base64ImageSource` - `JsonValue type = "base64"` - `String data` format: byte - `MediaType mediaType` - `IMAGE_JPEG("image/jpeg")` - `IMAGE_PNG("image/png")` - `IMAGE_GIF("image/gif")` - `IMAGE_WEBP("image/webp")` ### Base64 PDF Source - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` ### Bash Code Execution Output Block - `class BashCodeExecutionOutputBlock` - `JsonValue type = "bash_code_execution_output"` - `String fileId` ### Bash Code Execution Output Block Param - `class BashCodeExecutionOutputBlockParam` - `JsonValue type = "bash_code_execution_output"` - `String fileId` ### Bash Code Execution Result Block - `class BashCodeExecutionResultBlock` - `JsonValue type = "bash_code_execution_result"` - `List content` - `JsonValue type = "bash_code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` ### Bash Code Execution Result Block Param - `class BashCodeExecutionResultBlockParam` - `JsonValue type = "bash_code_execution_result"` - `List content` - `JsonValue type = "bash_code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` ### Bash Code Execution Tool Result Block - `class BashCodeExecutionToolResultBlock` - `JsonValue type = "bash_code_execution_tool_result"` - `Content content` - `class BashCodeExecutionToolResultError` - `JsonValue type = "bash_code_execution_tool_result_error"` - `BashCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` - `class BashCodeExecutionResultBlock` - `JsonValue type = "bash_code_execution_result"` - `List content` - `JsonValue type = "bash_code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Bash Code Execution Tool Result Block Param - `class BashCodeExecutionToolResultBlockParam` - `JsonValue type = "bash_code_execution_tool_result"` - `Content content` - `class BashCodeExecutionToolResultErrorParam` - `JsonValue type = "bash_code_execution_tool_result_error"` - `BashCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` - `class BashCodeExecutionResultBlockParam` - `JsonValue type = "bash_code_execution_result"` - `List content` - `JsonValue type = "bash_code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` ### Bash Code Execution Tool Result Error - `class BashCodeExecutionToolResultError` - `JsonValue type = "bash_code_execution_tool_result_error"` - `BashCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` ### Bash Code Execution Tool Result Error Code - `enum BashCodeExecutionToolResultErrorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` ### Bash Code Execution Tool Result Error Param - `class BashCodeExecutionToolResultErrorParam` - `JsonValue type = "bash_code_execution_tool_result_error"` - `BashCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` ### Browser Click Target - `class BrowserClickTarget: union` Where to act: either a viewport coordinate or an element reference. - `class BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `class BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. ### Browser Close Tab Config - `class BrowserCloseTabConfig` `close_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Close Tab Input - `class BrowserCloseTabInput` Close the tab with the given tab_id. - `String tabId` The tab to close. ### Browser Close Tab Tool Use Block - `class BrowserCloseTabToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserCloseTabInput input` Close the tab with the given tab_id. - `String tabId` The tab to close. - `JsonValue name = "close_tab"` - `JsonValue toolsetName = "browser"` ### Browser Coordinate Target - `class BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 ### Browser Double Click Config - `class BrowserDoubleClickConfig` `double_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Double Click Input - `class BrowserDoubleClickInput` Double left-click at a viewport coordinate or on an element by reference. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `class BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `class BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Double Click Tool Use Block - `class BrowserDoubleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserDoubleClickInput input` Double left-click at a viewport coordinate or on an element by reference. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `class BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `class BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "double_click"` - `JsonValue toolsetName = "browser"` ### Browser File Upload Config - `class BrowserFileUploadConfig` `file_upload`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser File Upload Input - `class BrowserFileUploadInput` Set the value of a file-input element to one or more files. The target must be an element reference; at least one of paths or document_ids is required. - `BrowserRefTarget target` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Optional> documentIds` References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem. minItems: 1 - `Optional> paths` File paths on the browser executor's filesystem. minItems: 1 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser File Upload Tool Use Block - `class BrowserFileUploadToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserFileUploadInput input` Set the value of a file-input element to one or more files. The target must be an element reference; at least one of paths or document_ids is required. - `BrowserRefTarget target` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Optional> documentIds` References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem. minItems: 1 - `Optional> paths` File paths on the browser executor's filesystem. minItems: 1 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "file_upload"` - `JsonValue toolsetName = "browser"` ### Browser Find Config - `class BrowserFindConfig` `find`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Find Input - `class BrowserFindInput` Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references. - `String query` Natural-language description of the element(s) to find. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Find Tool Use Block - `class BrowserFindToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserFindInput input` Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references. - `String query` Natural-language description of the element(s) to find. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "find"` - `JsonValue toolsetName = "browser"` ### Browser Form Input Config - `class BrowserFormInputConfig` `form_input`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Form Input Input - `class BrowserFormInputInput` Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects. - `BrowserRefTarget target` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `BrowserFormInputValue value` The value to set. - `String` - `double` - `boolean` - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Form Input Tool Use Block - `class BrowserFormInputToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserFormInputInput input` Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects. - `BrowserRefTarget target` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `BrowserFormInputValue value` The value to set. - `String` - `double` - `boolean` - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "form_input"` - `JsonValue toolsetName = "browser"` ### Browser Form Input Value - `class BrowserFormInputValue: union` - `String` - `double` - `boolean` ### Browser Get Page Text Config - `class BrowserGetPageTextConfig` `get_page_text`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Get Page Text Input - `class BrowserGetPageTextInput` Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Get Page Text Tool Use Block - `class BrowserGetPageTextToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserGetPageTextInput input` Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "get_page_text"` - `JsonValue toolsetName = "browser"` ### Browser Hold Key Config - `class BrowserHoldKeyConfig` `hold_key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Hold Key Input - `class BrowserHoldKeyInput` Hold a key or key chord down for a duration, then release it. Uses the same key names and "+" chord syntax as the key action. - `double duration` Seconds to hold the key down (maximum 30). minimum: 0, maximum: 30 - `String text` The key or chord to hold. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Hold Key Tool Use Block - `class BrowserHoldKeyToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserHoldKeyInput input` Hold a key or key chord down for a duration, then release it. Uses the same key names and "+" chord syntax as the key action. - `double duration` Seconds to hold the key down (maximum 30). minimum: 0, maximum: 30 - `String text` The key or chord to hold. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "hold_key"` - `JsonValue toolsetName = "browser"` ### Browser Hover Config - `class BrowserHoverConfig` `hover`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Hover Input - `class BrowserHoverInput` Move the cursor to a coordinate or element without clicking. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `class BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `class BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Hover Tool Use Block - `class BrowserHoverToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserHoverInput input` Move the cursor to a coordinate or element without clicking. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `class BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `class BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "hover"` - `JsonValue toolsetName = "browser"` ### Browser Javascript Exec Config - `class BrowserJavascriptExecConfig` `javascript_exec`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Javascript Exec Input - `class BrowserJavascriptExecInput` Execute JavaScript in the page context and return the value of the last expression. The code runs with access to the DOM, `window`, and page variables. Write the expression you want evaluated — do NOT use `return`. - `String text` JavaScript to execute in the page context. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Javascript Exec Tool Use Block - `class BrowserJavascriptExecToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserJavascriptExecInput input` Execute JavaScript in the page context and return the value of the last expression. The code runs with access to the DOM, `window`, and page variables. Write the expression you want evaluated — do NOT use `return`. - `String text` JavaScript to execute in the page context. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "javascript_exec"` - `JsonValue toolsetName = "browser"` ### Browser Key Config - `class BrowserKeyConfig` `key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Key Input - `class BrowserKeyInput` Press a key or key chord. Use "+" to combine modifiers with a key (e.g. "ctrl+a", "cmd+shift+p") and space to sequence presses (e.g. "Backspace Backspace Delete"). Common names like "Return", "Tab", "Escape", "BackSpace" are supported. - `String text` The key, chord, or space-separated sequence to press. - `Optional repeat` Number of times to repeat. Default 1. minimum: 1, maximum: 100 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Key Tool Use Block - `class BrowserKeyToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserKeyInput input` Press a key or key chord. Use "+" to combine modifiers with a key (e.g. "ctrl+a", "cmd+shift+p") and space to sequence presses (e.g. "Backspace Backspace Delete"). Common names like "Return", "Tab", "Escape", "BackSpace" are supported. - `String text` The key, chord, or space-separated sequence to press. - `Optional repeat` Number of times to repeat. Default 1. minimum: 1, maximum: 100 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "key"` - `JsonValue toolsetName = "browser"` ### Browser Left Click Config - `class BrowserLeftClickConfig` `left_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Left Click Drag Config - `class BrowserLeftClickDragConfig` `left_click_drag`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Left Click Drag Input - `class BrowserLeftClickDragInput` Press at `from`, drag to `target`, release. Both must be coordinate targets. - `BrowserCoordinateTarget from` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Left Click Drag Tool Use Block - `class BrowserLeftClickDragToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserLeftClickDragInput input` Press at `from`, drag to `target`, release. Both must be coordinate targets. - `BrowserCoordinateTarget from` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "left_click_drag"` - `JsonValue toolsetName = "browser"` ### Browser Left Click Input - `class BrowserLeftClickInput` Left-click at a viewport coordinate or on an element by reference. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `class BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `class BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Left Click Tool Use Block - `class BrowserLeftClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserLeftClickInput input` Left-click at a viewport coordinate or on an element by reference. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `class BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `class BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "left_click"` - `JsonValue toolsetName = "browser"` ### Browser Left Mouse Down Config - `class BrowserLeftMouseDownConfig` `left_mouse_down`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Left Mouse Down Input - `class BrowserLeftMouseDownInput` Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag. - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Left Mouse Down Tool Use Block - `class BrowserLeftMouseDownToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserLeftMouseDownInput input` Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag. - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "left_mouse_down"` - `JsonValue toolsetName = "browser"` ### Browser Left Mouse Up Config - `class BrowserLeftMouseUpConfig` `left_mouse_up`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Left Mouse Up Input - `class BrowserLeftMouseUpInput` Release the left mouse button at a viewport coordinate. - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Left Mouse Up Tool Use Block - `class BrowserLeftMouseUpToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserLeftMouseUpInput input` Release the left mouse button at a viewport coordinate. - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "left_mouse_up"` - `JsonValue toolsetName = "browser"` ### Browser List Tabs Config - `class BrowserListTabsConfig` `list_tabs`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser List Tabs Input - `class BrowserListTabsInput:` List all open tabs with each tab's tab_id, title, and URL. ### Browser List Tabs Tool Use Block - `class BrowserListTabsToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserListTabsInput input` List all open tabs with each tab's tab_id, title, and URL. - `JsonValue name = "list_tabs"` - `JsonValue toolsetName = "browser"` ### Browser Middle Click Config - `class BrowserMiddleClickConfig` `middle_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Middle Click Input - `class BrowserMiddleClickInput` Middle-click at a viewport coordinate or on an element by reference. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `class BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `class BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Middle Click Tool Use Block - `class BrowserMiddleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserMiddleClickInput input` Middle-click at a viewport coordinate or on an element by reference. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `class BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `class BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "middle_click"` - `JsonValue toolsetName = "browser"` ### Browser Mouse Move Config - `class BrowserMouseMoveConfig` `mouse_move`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Mouse Move Input - `class BrowserMouseMoveInput` Move the pointer to a viewport coordinate without clicking. - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Mouse Move Tool Use Block - `class BrowserMouseMoveToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserMouseMoveInput input` Move the pointer to a viewport coordinate without clicking. - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "mouse_move"` - `JsonValue toolsetName = "browser"` ### Browser Navigate Config - `class BrowserNavigateConfig` `navigate`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Navigate Input - `class BrowserNavigateInput` Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://). - `String url` The URL to navigate to, or "back" / "forward" / "reload" for history navigation. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Navigate Tool Use Block - `class BrowserNavigateToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserNavigateInput input` Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://). - `String url` The URL to navigate to, or "back" / "forward" / "reload" for history navigation. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "navigate"` - `JsonValue toolsetName = "browser"` ### Browser New Tab Config - `class BrowserNewTabConfig` `new_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser New Tab Input - `class BrowserNewTabInput:` Open a new empty tab and return its tab_id. ### Browser New Tab Tool Use Block - `class BrowserNewTabToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserNewTabInput input` Open a new empty tab and return its tab_id. - `JsonValue name = "new_tab"` - `JsonValue toolsetName = "browser"` ### Browser Read Console Config - `class BrowserReadConsoleConfig` `read_console`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Read Console Input - `class BrowserReadConsoleInput` Return console output (log entries, errors, warnings) accumulated since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Read Console Tool Use Block - `class BrowserReadConsoleToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserReadConsoleInput input` Return console output (log entries, errors, warnings) accumulated since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "read_console"` - `JsonValue toolsetName = "browser"` ### Browser Read Network Config - `class BrowserReadNetworkConfig` `read_network`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Read Network Input - `class BrowserReadNetworkInput` Return the network requests (method, URL, status, MIME type, timing) recorded since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Read Network Tool Use Block - `class BrowserReadNetworkToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserReadNetworkInput input` Return the network requests (method, URL, status, MIME type, timing) recorded since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "read_network"` - `JsonValue toolsetName = "browser"` ### Browser Read Page Config - `class BrowserReadPageConfig` `read_page`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Read Page Filter - `enum BrowserReadPageFilter` - `ALL("all")` - `INTERACTIVE("interactive")` ### Browser Read Page Input - `class BrowserReadPageInput` Return a structured accessibility tree of the page (or the subtree rooted at `ref`), with element references like [ref_7] that can be used as targets on later actions. Output is capped at 50,000 characters — narrow with `ref` or a smaller `depth` when exceeded. - `Optional depth` Maximum tree depth. Default 15. minimum: 1 - `Optional filter` Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements. - `ALL("all")` - `INTERACTIVE("interactive")` - `Optional ref` Element reference to read a subtree from. Omit to read from the page root. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Read Page Tool Use Block - `class BrowserReadPageToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserReadPageInput input` Return a structured accessibility tree of the page (or the subtree rooted at `ref`), with element references like [ref_7] that can be used as targets on later actions. Output is capped at 50,000 characters — narrow with `ref` or a smaller `depth` when exceeded. - `Optional depth` Maximum tree depth. Default 15. minimum: 1 - `Optional filter` Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements. - `ALL("all")` - `INTERACTIVE("interactive")` - `Optional ref` Element reference to read a subtree from. Omit to read from the page root. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "read_page"` - `JsonValue toolsetName = "browser"` ### Browser Ref Target - `class BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. ### Browser Right Click Config - `class BrowserRightClickConfig` `right_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Right Click Input - `class BrowserRightClickInput` Right-click at a viewport coordinate or on an element by reference. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `class BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `class BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Right Click Tool Use Block - `class BrowserRightClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserRightClickInput input` Right-click at a viewport coordinate or on an element by reference. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `class BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `class BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "right_click"` - `JsonValue toolsetName = "browser"` ### Browser Screenshot Config - `class BrowserScreenshotConfig` `screenshot`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Screenshot Input - `class BrowserScreenshotInput` Capture the current browser viewport. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Screenshot Tool Use Block - `class BrowserScreenshotToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserScreenshotInput input` Capture the current browser viewport. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "screenshot"` - `JsonValue toolsetName = "browser"` ### Browser Scroll Config - `class BrowserScrollConfig` `scroll`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Scroll Direction - `enum BrowserScrollDirection` - `UP("up")` - `DOWN("down")` - `LEFT("left")` - `RIGHT("right")` ### Browser Scroll Input - `class BrowserScrollInput` Scroll at a viewport position. `target` must be a coordinate target. - `BrowserScrollDirection scrollDirection` - `UP("up")` - `DOWN("down")` - `LEFT("left")` - `RIGHT("right")` - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `Optional scrollAmount` Scroll-wheel notches (1–10). Default 3. minimum: 1, maximum: 10 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Scroll To Config - `class BrowserScrollToConfig` `scroll_to`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Scroll To Input - `class BrowserScrollToInput` Scroll an element into view. - `BrowserRefTarget target` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Scroll To Tool Use Block - `class BrowserScrollToToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserScrollToInput input` Scroll an element into view. - `BrowserRefTarget target` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "scroll_to"` - `JsonValue toolsetName = "browser"` ### Browser Scroll Tool Use Block - `class BrowserScrollToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserScrollInput input` Scroll at a viewport position. `target` must be a coordinate target. - `BrowserScrollDirection scrollDirection` - `UP("up")` - `DOWN("down")` - `LEFT("left")` - `RIGHT("right")` - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `Optional scrollAmount` Scroll-wheel notches (1–10). Default 3. minimum: 1, maximum: 10 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "scroll"` - `JsonValue toolsetName = "browser"` ### Browser State Block Param - `class BrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonValue type = "browser_state"` - `List tabs` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `String tabId` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional> stateChanges` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `class BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonValue type = "tab_opened"` - `String tabId` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonValue type = "download_started"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonValue type = "download_completed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional sizeBytes` The completed download's size. minimum: 0 - `class BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonValue type = "download_failed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Browser State Change - `class BrowserStateChange: union` - `class BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonValue type = "tab_opened"` - `String tabId` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonValue type = "download_started"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonValue type = "download_completed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional sizeBytes` The completed download's size. minimum: 0 - `class BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonValue type = "download_failed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Browser State Change Download Completed - `class BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonValue type = "download_completed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional sizeBytes` The completed download's size. minimum: 0 ### Browser State Change Download Failed - `class BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonValue type = "download_failed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Browser State Change Download Started - `class BrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonValue type = "download_started"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Browser State Change Tab Opened - `class BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonValue type = "tab_opened"` - `String tabId` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Browser State Tab Entry - `class BrowserStateTabEntry` One open browser tab reported in a `browser_state` block's `tabs` inventory. `tab_id` is the caller-assigned identifier for the tab; `title` and `url` describe the page the tab is currently showing and may be empty strings (a blank tab legitimately has both empty). `active` marks the tab that is active after this call; whenever `tabs` is non-empty, exactly one entry is marked. - `String tabId` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. ### Browser Switch Tab Config - `class BrowserSwitchTabConfig` `switch_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Switch Tab Input - `class BrowserSwitchTabInput` Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to. - `String tabId` The tab to switch to. ### Browser Switch Tab Tool Use Block - `class BrowserSwitchTabToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserSwitchTabInput input` Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to. - `String tabId` The tab to switch to. - `JsonValue name = "switch_tab"` - `JsonValue toolsetName = "browser"` ### Browser Tool Use Block - `class BrowserToolUseBlock: union` - `class BrowserNavigateToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserNavigateInput input` Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://). - `String url` The URL to navigate to, or "back" / "forward" / "reload" for history navigation. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "navigate"` - `JsonValue toolsetName = "browser"` - `class BrowserListTabsToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserListTabsInput input` List all open tabs with each tab's tab_id, title, and URL. - `JsonValue name = "list_tabs"` - `JsonValue toolsetName = "browser"` - `class BrowserNewTabToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserNewTabInput input` Open a new empty tab and return its tab_id. - `JsonValue name = "new_tab"` - `JsonValue toolsetName = "browser"` - `class BrowserSwitchTabToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserSwitchTabInput input` Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to. - `String tabId` The tab to switch to. - `JsonValue name = "switch_tab"` - `JsonValue toolsetName = "browser"` - `class BrowserCloseTabToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserCloseTabInput input` Close the tab with the given tab_id. - `String tabId` The tab to close. - `JsonValue name = "close_tab"` - `JsonValue toolsetName = "browser"` - `class BrowserReadPageToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserReadPageInput input` Return a structured accessibility tree of the page (or the subtree rooted at `ref`), with element references like [ref_7] that can be used as targets on later actions. Output is capped at 50,000 characters — narrow with `ref` or a smaller `depth` when exceeded. - `Optional depth` Maximum tree depth. Default 15. minimum: 1 - `Optional filter` Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements. - `ALL("all")` - `INTERACTIVE("interactive")` - `Optional ref` Element reference to read a subtree from. Omit to read from the page root. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "read_page"` - `JsonValue toolsetName = "browser"` - `class BrowserGetPageTextToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserGetPageTextInput input` Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "get_page_text"` - `JsonValue toolsetName = "browser"` - `class BrowserReadConsoleToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserReadConsoleInput input` Return console output (log entries, errors, warnings) accumulated since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "read_console"` - `JsonValue toolsetName = "browser"` - `class BrowserReadNetworkToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserReadNetworkInput input` Return the network requests (method, URL, status, MIME type, timing) recorded since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "read_network"` - `JsonValue toolsetName = "browser"` - `class BrowserFindToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserFindInput input` Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references. - `String query` Natural-language description of the element(s) to find. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "find"` - `JsonValue toolsetName = "browser"` - `class BrowserFormInputToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserFormInputInput input` Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects. - `BrowserRefTarget target` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `BrowserFormInputValue value` The value to set. - `String` - `double` - `boolean` - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "form_input"` - `JsonValue toolsetName = "browser"` - `class BrowserFileUploadToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserFileUploadInput input` Set the value of a file-input element to one or more files. The target must be an element reference; at least one of paths or document_ids is required. - `BrowserRefTarget target` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `Optional> documentIds` References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem. minItems: 1 - `Optional> paths` File paths on the browser executor's filesystem. minItems: 1 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "file_upload"` - `JsonValue toolsetName = "browser"` - `class BrowserScrollToToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserScrollToInput input` Scroll an element into view. - `BrowserRefTarget target` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "scroll_to"` - `JsonValue toolsetName = "browser"` - `class BrowserScreenshotToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserScreenshotInput input` Capture the current browser viewport. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "screenshot"` - `JsonValue toolsetName = "browser"` - `class BrowserZoomToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserZoomInput input` Return a cropped screenshot of the given viewport region, scaled up for closer inspection — useful for small icons, buttons, or text. Coordinates are in the same viewport-pixel space as a full screenshot. - `List region` [x0, y0, x1, y1] in viewport pixels. minItems: 4, maxItems: 4 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "zoom"` - `JsonValue toolsetName = "browser"` - `class BrowserLeftClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserLeftClickInput input` Left-click at a viewport coordinate or on an element by reference. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `class BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `class BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "left_click"` - `JsonValue toolsetName = "browser"` - `class BrowserRightClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserRightClickInput input` Right-click at a viewport coordinate or on an element by reference. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "right_click"` - `JsonValue toolsetName = "browser"` - `class BrowserMiddleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserMiddleClickInput input` Middle-click at a viewport coordinate or on an element by reference. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "middle_click"` - `JsonValue toolsetName = "browser"` - `class BrowserDoubleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserDoubleClickInput input` Double left-click at a viewport coordinate or on an element by reference. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "double_click"` - `JsonValue toolsetName = "browser"` - `class BrowserTripleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserTripleClickInput input` Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph). - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "triple_click"` - `JsonValue toolsetName = "browser"` - `class BrowserHoverToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserHoverInput input` Move the cursor to a coordinate or element without clicking. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "hover"` - `JsonValue toolsetName = "browser"` - `class BrowserLeftClickDragToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserLeftClickDragInput input` Press at `from`, drag to `target`, release. Both must be coordinate targets. - `BrowserCoordinateTarget from` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "left_click_drag"` - `JsonValue toolsetName = "browser"` - `class BrowserLeftMouseDownToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserLeftMouseDownInput input` Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag. - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "left_mouse_down"` - `JsonValue toolsetName = "browser"` - `class BrowserLeftMouseUpToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserLeftMouseUpInput input` Release the left mouse button at a viewport coordinate. - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "left_mouse_up"` - `JsonValue toolsetName = "browser"` - `class BrowserMouseMoveToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserMouseMoveInput input` Move the pointer to a viewport coordinate without clicking. - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "mouse_move"` - `JsonValue toolsetName = "browser"` - `class BrowserScrollToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserScrollInput input` Scroll at a viewport position. `target` must be a coordinate target. - `BrowserScrollDirection scrollDirection` - `UP("up")` - `DOWN("down")` - `LEFT("left")` - `RIGHT("right")` - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Optional scrollAmount` Scroll-wheel notches (1–10). Default 3. minimum: 1, maximum: 10 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "scroll"` - `JsonValue toolsetName = "browser"` - `class BrowserTypeToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserTypeInput input` Type a literal string at the current focus. - `String text` The text to type. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "type"` - `JsonValue toolsetName = "browser"` - `class BrowserKeyToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserKeyInput input` Press a key or key chord. Use "+" to combine modifiers with a key (e.g. "ctrl+a", "cmd+shift+p") and space to sequence presses (e.g. "Backspace Backspace Delete"). Common names like "Return", "Tab", "Escape", "BackSpace" are supported. - `String text` The key, chord, or space-separated sequence to press. - `Optional repeat` Number of times to repeat. Default 1. minimum: 1, maximum: 100 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "key"` - `JsonValue toolsetName = "browser"` - `class BrowserHoldKeyToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserHoldKeyInput input` Hold a key or key chord down for a duration, then release it. Uses the same key names and "+" chord syntax as the key action. - `double duration` Seconds to hold the key down (maximum 30). minimum: 0, maximum: 30 - `String text` The key or chord to hold. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "hold_key"` - `JsonValue toolsetName = "browser"` - `class BrowserWaitToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserWaitInput input` Pause for the given duration. - `double duration` Seconds to wait (maximum 30). minimum: 0, maximum: 30 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "wait"` - `JsonValue toolsetName = "browser"` - `class BrowserJavascriptExecToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserJavascriptExecInput input` Execute JavaScript in the page context and return the value of the last expression. The code runs with access to the DOM, `window`, and page variables. Write the expression you want evaluated — do NOT use `return`. - `String text` JavaScript to execute in the page context. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "javascript_exec"` - `JsonValue toolsetName = "browser"` ### Browser Toolset 20260801 - `class BrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonValue type = "browser_toolset_20260801"` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Optional type` `type`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional closeTab` `close_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional doubleClick` `double_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional fileUpload` `file_upload`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional find` `find`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional formInput` `form_input`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional getPageText` `get_page_text`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional holdKey` `hold_key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional hover` `hover`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional javascriptExec` `javascript_exec`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional key` `key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClick` `left_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClickDrag` `left_click_drag`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseDown` `left_mouse_down`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseUp` `left_mouse_up`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional listTabs` `list_tabs`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional middleClick` `middle_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional mouseMove` `mouse_move`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional navigate` `navigate`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional newTab` `new_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readConsole` `read_console`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readNetwork` `read_network`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readPage` `read_page`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional rightClick` `right_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional screenshot` `screenshot`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scroll` `scroll`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scrollTo` `scroll_to`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional switchTab` `switch_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional tripleClick` `triple_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional wait` `wait`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional zoom` `zoom`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Toolset Configs - `class BrowserToolsetConfigs` Per-member configuration for `browser_toolset_20260801`: one optional field per member tool, keyed by the member name — the same name the member's `tool_use` blocks carry. Every member is an accepted key, and a member's defaults apply wherever its key is absent. Unknown keys are rejected: the field set is this toolset version's complete member set. - `Optional type` `type`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional closeTab` `close_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional doubleClick` `double_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional fileUpload` `file_upload`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional find` `find`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional formInput` `form_input`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional getPageText` `get_page_text`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional holdKey` `hold_key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional hover` `hover`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional javascriptExec` `javascript_exec`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional key` `key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClick` `left_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClickDrag` `left_click_drag`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseDown` `left_mouse_down`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseUp` `left_mouse_up`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional listTabs` `list_tabs`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional middleClick` `middle_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional mouseMove` `mouse_move`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional navigate` `navigate`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional newTab` `new_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readConsole` `read_console`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readNetwork` `read_network`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readPage` `read_page`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional rightClick` `right_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional screenshot` `screenshot`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scroll` `scroll`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scrollTo` `scroll_to`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional switchTab` `switch_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional tripleClick` `triple_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional wait` `wait`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional zoom` `zoom`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Triple Click Config - `class BrowserTripleClickConfig` `triple_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Triple Click Input - `class BrowserTripleClickInput` Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph). - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `class BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `class BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Triple Click Tool Use Block - `class BrowserTripleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserTripleClickInput input` Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph). - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `class BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `class BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "triple_click"` - `JsonValue toolsetName = "browser"` ### Browser Type Config - `class BrowserTypeConfig` `type`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Type Input - `class BrowserTypeInput` Type a literal string at the current focus. - `String text` The text to type. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Type Tool Use Block - `class BrowserTypeToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserTypeInput input` Type a literal string at the current focus. - `String text` The text to type. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "type"` - `JsonValue toolsetName = "browser"` ### Browser Wait Config - `class BrowserWaitConfig` `wait`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Wait Input - `class BrowserWaitInput` Pause for the given duration. - `double duration` Seconds to wait (maximum 30). minimum: 0, maximum: 30 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Wait Tool Use Block - `class BrowserWaitToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserWaitInput input` Pause for the given duration. - `double duration` Seconds to wait (maximum 30). minimum: 0, maximum: 30 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "wait"` - `JsonValue toolsetName = "browser"` ### Browser Zoom Config - `class BrowserZoomConfig` `zoom`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Browser Zoom Input - `class BrowserZoomInput` Return a cropped screenshot of the given viewport region, scaled up for closer inspection — useful for small icons, buttons, or text. Coordinates are in the same viewport-pixel space as a full screenshot. - `List region` [x0, y0, x1, y1] in viewport pixels. minItems: 4, maxItems: 4 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. ### Browser Zoom Tool Use Block - `class BrowserZoomToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserZoomInput input` Return a cropped screenshot of the given viewport region, scaled up for closer inspection — useful for small icons, buttons, or text. Coordinates are in the same viewport-pixel space as a full screenshot. - `List region` [x0, y0, x1, y1] in viewport pixels. minItems: 4, maxItems: 4 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "zoom"` - `JsonValue toolsetName = "browser"` ### Cache Control Ephemeral - `class CacheControlEphemeral` - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` ### Cache Creation - `class CacheCreation` - `long ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `long ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 ### Cache Miss Messages Changed - `class CacheMissMessagesChanged` - `JsonValue type = "messages_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. ### Cache Miss Model Changed - `class CacheMissModelChanged` - `JsonValue type = "model_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. ### Cache Miss Previous Message Not Found - `class CacheMissPreviousMessageNotFound` - `JsonValue type = "previous_message_not_found"` ### Cache Miss Reason - `class CacheMissReason: union` - `class CacheMissModelChanged` - `JsonValue type = "model_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissSystemChanged` - `JsonValue type = "system_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissToolsChanged` - `JsonValue type = "tools_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissMessagesChanged` - `JsonValue type = "messages_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissPreviousMessageNotFound` - `JsonValue type = "previous_message_not_found"` - `class CacheMissUnavailable` - `JsonValue type = "unavailable"` ### Cache Miss System Changed - `class CacheMissSystemChanged` - `JsonValue type = "system_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. ### Cache Miss Tools Changed - `class CacheMissToolsChanged` - `JsonValue type = "tools_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. ### Cache Miss Unavailable - `class CacheMissUnavailable` - `JsonValue type = "unavailable"` ### Citation Char Location - `class CitationCharLocation` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endCharIndex` - `Optional fileId` - `long startCharIndex` minimum: 0 ### Citation Char Location Param - `class CitationCharLocationParam` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endCharIndex` - `long startCharIndex` minimum: 0 ### Citation Content Block Location - `class CitationContentBlockLocation` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `Optional fileId` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 ### Citation Content Block Location Param - `class CitationContentBlockLocationParam` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 ### Citation Page Location - `class CitationPageLocation` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endPageNumber` - `Optional fileId` - `long startPageNumber` minimum: 1 ### Citation Page Location Param - `class CitationPageLocationParam` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endPageNumber` - `long startPageNumber` minimum: 1 ### Citation Search Result Location Param - `class CitationSearchResultLocationParam` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` ### Citation Web Search Result Location Param - `class CitationWebSearchResultLocationParam` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` minLength: 1, maxLength: 512 - `String url` minLength: 1 ### Citations Config - `class CitationsConfig` - `boolean enabled` ### Citations Config Param - `class CitationsConfigParam` - `Optional enabled` ### Citations Delta - `class CitationsDelta` - `JsonValue type = "citations_delta"` - `Citation citation` - `class CitationCharLocation` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endCharIndex` - `Optional fileId` - `long startCharIndex` minimum: 0 - `class CitationPageLocation` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endPageNumber` - `Optional fileId` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocation` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `Optional fileId` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationsWebSearchResultLocation` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` maxLength: 512 - `String url` - `class CitationsSearchResultLocation` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` ### Citations Search Result Location - `class CitationsSearchResultLocation` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` ### Citations Web Search Result Location - `class CitationsWebSearchResultLocation` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` maxLength: 512 - `String url` ### Code Execution Output Block - `class CodeExecutionOutputBlock` - `JsonValue type = "code_execution_output"` - `String fileId` ### Code Execution Output Block Param - `class CodeExecutionOutputBlockParam` - `JsonValue type = "code_execution_output"` - `String fileId` ### Code Execution Result Block - `class CodeExecutionResultBlock` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` ### Code Execution Result Block Param - `class CodeExecutionResultBlockParam` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` ### Code Execution Tool 20250522 - `class CodeExecutionTool20250522` - `JsonValue type = "code_execution_20250522"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs ### Code Execution Tool 20250825 - `class CodeExecutionTool20250825` - `JsonValue type = "code_execution_20250825"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs ### Code Execution Tool 20260120 - `class CodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `JsonValue type = "code_execution_20260120"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs ### Code Execution Tool 20260521 - `class CodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonValue type = "code_execution_20260521"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs ### Code Execution Tool Result Block - `class CodeExecutionToolResultBlock` - `JsonValue type = "code_execution_tool_result"` - `CodeExecutionToolResultBlockContent content` - `class CodeExecutionToolResultError` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `class CodeExecutionResultBlock` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `class EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Code Execution Tool Result Block Content - `class CodeExecutionToolResultBlockContent: union` - `class CodeExecutionToolResultError` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `class CodeExecutionResultBlock` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `class EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` ### Code Execution Tool Result Block Param - `class CodeExecutionToolResultBlockParam` - `JsonValue type = "code_execution_tool_result"` - `CodeExecutionToolResultBlockParamContent content` - `class CodeExecutionToolResultErrorParam` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `class CodeExecutionResultBlockParam` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `class EncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` ### Code Execution Tool Result Block Param Content - `class CodeExecutionToolResultBlockParamContent: union` - `class CodeExecutionToolResultErrorParam` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `class CodeExecutionResultBlockParam` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `class EncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` ### Code Execution Tool Result Error - `class CodeExecutionToolResultError` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` ### Code Execution Tool Result Error Code - `enum CodeExecutionToolResultErrorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` ### Code Execution Tool Result Error Param - `class CodeExecutionToolResultErrorParam` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` ### Computer Cursor Position Config - `class ComputerCursorPositionConfig` `cursor_position`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Cursor Position Input - `class ComputerCursorPositionInput:` Get the current (x, y) pixel coordinate of the cursor. ### Computer Cursor Position Tool Use Block - `class ComputerCursorPositionToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerCursorPositionInput input` Get the current (x, y) pixel coordinate of the cursor. - `JsonValue name = "cursor_position"` - `JsonValue toolsetName = "computer"` ### Computer Double Click Config - `class ComputerDoubleClickConfig` `double_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Double Click Input - `class ComputerDoubleClickInput` Double-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Computer Double Click Tool Use Block - `class ComputerDoubleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerDoubleClickInput input` Double-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "double_click"` - `JsonValue toolsetName = "computer"` ### Computer Hold Key Config - `class ComputerHoldKeyConfig` `hold_key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Hold Key Input - `class ComputerHoldKeyInput` Hold down a key or key-combination for a specified duration. Uses the same key syntax as `key`. - `long duration` Duration to hold the key, in seconds. maximum: 300 - `String text` The key or key-combination to hold. ### Computer Hold Key Tool Use Block - `class ComputerHoldKeyToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerHoldKeyInput input` Hold down a key or key-combination for a specified duration. Uses the same key syntax as `key`. - `long duration` Duration to hold the key, in seconds. maximum: 300 - `String text` The key or key-combination to hold. - `JsonValue name = "hold_key"` - `JsonValue toolsetName = "computer"` ### Computer Key Config - `class ComputerKeyConfig` `key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Key Input - `class ComputerKeyInput` Press a key or key-combination on the keyboard. Use "+" to combine modifiers with a key (e.g. "ctrl+s", "alt+Tab", "ctrl+shift+Escape"). Key names are case-insensitive; common names like "Return", "Tab", "Escape", "Up", "Down", "Left", "Right", "Home", "End", "Page_Up", "Page_Down", "Delete", "BackSpace" are supported. - `String text` The key or key-combination to press. - `Optional repeat` Number of times to repeat the key press. Default is 1. minimum: 1, maximum: 100 ### Computer Key Tool Use Block - `class ComputerKeyToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerKeyInput input` Press a key or key-combination on the keyboard. Use "+" to combine modifiers with a key (e.g. "ctrl+s", "alt+Tab", "ctrl+shift+Escape"). Key names are case-insensitive; common names like "Return", "Tab", "Escape", "Up", "Down", "Left", "Right", "Home", "End", "Page_Up", "Page_Down", "Delete", "BackSpace" are supported. - `String text` The key or key-combination to press. - `Optional repeat` Number of times to repeat the key press. Default is 1. minimum: 1, maximum: 100 - `JsonValue name = "key"` - `JsonValue toolsetName = "computer"` ### Computer Left Click Config - `class ComputerLeftClickConfig` `left_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Left Click Drag Config - `class ComputerLeftClickDragConfig` `left_click_drag`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Left Click Drag Input - `class ComputerLeftClickDragInput` Click and drag the cursor from `start_coordinate` to `coordinate`. - `List coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `List startCoordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Computer Left Click Drag Tool Use Block - `class ComputerLeftClickDragToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerLeftClickDragInput input` Click and drag the cursor from `start_coordinate` to `coordinate`. - `List coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `List startCoordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "left_click_drag"` - `JsonValue toolsetName = "computer"` ### Computer Left Click Input - `class ComputerLeftClickInput` Click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Computer Left Click Tool Use Block - `class ComputerLeftClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerLeftClickInput input` Click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "left_click"` - `JsonValue toolsetName = "computer"` ### Computer Left Mouse Down Config - `class ComputerLeftMouseDownConfig` `left_mouse_down`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Left Mouse Down Input - `class ComputerLeftMouseDownInput:` Press and hold the left mouse button at the current cursor position. ### Computer Left Mouse Down Tool Use Block - `class ComputerLeftMouseDownToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerLeftMouseDownInput input` Press and hold the left mouse button at the current cursor position. - `JsonValue name = "left_mouse_down"` - `JsonValue toolsetName = "computer"` ### Computer Left Mouse Up Config - `class ComputerLeftMouseUpConfig` `left_mouse_up`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Left Mouse Up Input - `class ComputerLeftMouseUpInput:` Release the left mouse button. ### Computer Left Mouse Up Tool Use Block - `class ComputerLeftMouseUpToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerLeftMouseUpInput input` Release the left mouse button. - `JsonValue name = "left_mouse_up"` - `JsonValue toolsetName = "computer"` ### Computer Middle Click Config - `class ComputerMiddleClickConfig` `middle_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Middle Click Input - `class ComputerMiddleClickInput` Click the middle mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Computer Middle Click Tool Use Block - `class ComputerMiddleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerMiddleClickInput input` Click the middle mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "middle_click"` - `JsonValue toolsetName = "computer"` ### Computer Mouse Move Config - `class ComputerMouseMoveConfig` `mouse_move`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Mouse Move Input - `class ComputerMouseMoveInput` Move the cursor to a specified (x, y) pixel coordinate. Use this ONLY to hover without clicking; otherwise use a click action directly. - `List coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 ### Computer Mouse Move Tool Use Block - `class ComputerMouseMoveToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerMouseMoveInput input` Move the cursor to a specified (x, y) pixel coordinate. Use this ONLY to hover without clicking; otherwise use a click action directly. - `List coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `JsonValue name = "mouse_move"` - `JsonValue toolsetName = "computer"` ### Computer Right Click Config - `class ComputerRightClickConfig` `right_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Right Click Input - `class ComputerRightClickInput` Click the right mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Computer Right Click Tool Use Block - `class ComputerRightClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerRightClickInput input` Click the right mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "right_click"` - `JsonValue toolsetName = "computer"` ### Computer Screenshot Config - `class ComputerScreenshotConfig` `screenshot`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Screenshot Input - `class ComputerScreenshotInput:` Take a screenshot of the screen. ### Computer Screenshot Tool Use Block - `class ComputerScreenshotToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerScreenshotInput input` Take a screenshot of the screen. - `JsonValue name = "screenshot"` - `JsonValue toolsetName = "computer"` ### Computer Scroll Config - `class ComputerScrollConfig` `scroll`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Scroll Direction - `enum ComputerScrollDirection` - `UP("up")` - `DOWN("down")` - `LEFT("left")` - `RIGHT("right")` ### Computer Scroll Input - `class ComputerScrollInput` Scroll the screen at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. Do NOT use PageUp/PageDown to scroll. - `long scrollAmount` Number of 'clicks' of the scroll wheel. - `ComputerScrollDirection scrollDirection` - `UP("up")` - `DOWN("down")` - `LEFT("left")` - `RIGHT("right")` - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Computer Scroll Tool Use Block - `class ComputerScrollToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerScrollInput input` Scroll the screen at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. Do NOT use PageUp/PageDown to scroll. - `long scrollAmount` Number of 'clicks' of the scroll wheel. - `ComputerScrollDirection scrollDirection` - `UP("up")` - `DOWN("down")` - `LEFT("left")` - `RIGHT("right")` - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "scroll"` - `JsonValue toolsetName = "computer"` ### Computer Tool Use Block - `class ComputerToolUseBlock: union` - `class ComputerKeyToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerKeyInput input` Press a key or key-combination on the keyboard. Use "+" to combine modifiers with a key (e.g. "ctrl+s", "alt+Tab", "ctrl+shift+Escape"). Key names are case-insensitive; common names like "Return", "Tab", "Escape", "Up", "Down", "Left", "Right", "Home", "End", "Page_Up", "Page_Down", "Delete", "BackSpace" are supported. - `String text` The key or key-combination to press. - `Optional repeat` Number of times to repeat the key press. Default is 1. minimum: 1, maximum: 100 - `JsonValue name = "key"` - `JsonValue toolsetName = "computer"` - `class ComputerHoldKeyToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerHoldKeyInput input` Hold down a key or key-combination for a specified duration. Uses the same key syntax as `key`. - `long duration` Duration to hold the key, in seconds. maximum: 300 - `String text` The key or key-combination to hold. - `JsonValue name = "hold_key"` - `JsonValue toolsetName = "computer"` - `class ComputerTypeToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerTypeInput input` Type a string of text on the keyboard. - `String text` The text to type. - `JsonValue name = "type"` - `JsonValue toolsetName = "computer"` - `class ComputerCursorPositionToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerCursorPositionInput input` Get the current (x, y) pixel coordinate of the cursor. - `JsonValue name = "cursor_position"` - `JsonValue toolsetName = "computer"` - `class ComputerMouseMoveToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerMouseMoveInput input` Move the cursor to a specified (x, y) pixel coordinate. Use this ONLY to hover without clicking; otherwise use a click action directly. - `List coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `JsonValue name = "mouse_move"` - `JsonValue toolsetName = "computer"` - `class ComputerLeftMouseDownToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerLeftMouseDownInput input` Press and hold the left mouse button at the current cursor position. - `JsonValue name = "left_mouse_down"` - `JsonValue toolsetName = "computer"` - `class ComputerLeftMouseUpToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerLeftMouseUpInput input` Release the left mouse button. - `JsonValue name = "left_mouse_up"` - `JsonValue toolsetName = "computer"` - `class ComputerLeftClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerLeftClickInput input` Click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "left_click"` - `JsonValue toolsetName = "computer"` - `class ComputerLeftClickDragToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerLeftClickDragInput input` Click and drag the cursor from `start_coordinate` to `coordinate`. - `List coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `List startCoordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "left_click_drag"` - `JsonValue toolsetName = "computer"` - `class ComputerRightClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerRightClickInput input` Click the right mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "right_click"` - `JsonValue toolsetName = "computer"` - `class ComputerMiddleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerMiddleClickInput input` Click the middle mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "middle_click"` - `JsonValue toolsetName = "computer"` - `class ComputerDoubleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerDoubleClickInput input` Double-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "double_click"` - `JsonValue toolsetName = "computer"` - `class ComputerTripleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerTripleClickInput input` Triple-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "triple_click"` - `JsonValue toolsetName = "computer"` - `class ComputerScrollToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerScrollInput input` Scroll the screen at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. Do NOT use PageUp/PageDown to scroll. - `long scrollAmount` Number of 'clicks' of the scroll wheel. - `ComputerScrollDirection scrollDirection` - `UP("up")` - `DOWN("down")` - `LEFT("left")` - `RIGHT("right")` - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "scroll"` - `JsonValue toolsetName = "computer"` - `class ComputerWaitToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerWaitInput input` Wait for a specified duration. - `long duration` Duration to wait, in seconds. maximum: 300 - `JsonValue name = "wait"` - `JsonValue toolsetName = "computer"` - `class ComputerScreenshotToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerScreenshotInput input` Take a screenshot of the screen. - `JsonValue name = "screenshot"` - `JsonValue toolsetName = "computer"` - `class ComputerZoomToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerZoomInput input` Take a screenshot of a rectangular region. Region coordinates are in the full-screenshot space (not physical display pixels). The crop is scaled up to fill the image budget so fine details become legible. - `List region` (x0, y0, x1, y1): The region to capture. minItems: 4, maxItems: 4 - `JsonValue name = "zoom"` - `JsonValue toolsetName = "computer"` ### Computer Toolset 20260801 - `class ComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonValue type = "computer_toolset_20260801"` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Optional type` `type`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional cursorPosition` `cursor_position`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional doubleClick` `double_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional holdKey` `hold_key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional key` `key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClick` `left_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClickDrag` `left_click_drag`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseDown` `left_mouse_down`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseUp` `left_mouse_up`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional middleClick` `middle_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional mouseMove` `mouse_move`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional rightClick` `right_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional screenshot` `screenshot`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scroll` `scroll`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional tripleClick` `triple_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional wait` `wait`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional zoom` `zoom`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Toolset Configs - `class ComputerToolsetConfigs` Per-member configuration for `computer_toolset_20260801`: one optional field per member tool, keyed by the member name — the same name the member's `tool_use` blocks carry. Every member is an accepted key, and a member's defaults apply wherever its key is absent. Unknown keys are rejected: the field set is this toolset version's complete member set. - `Optional type` `type`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional cursorPosition` `cursor_position`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional doubleClick` `double_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional holdKey` `hold_key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional key` `key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClick` `left_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClickDrag` `left_click_drag`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseDown` `left_mouse_down`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseUp` `left_mouse_up`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional middleClick` `middle_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional mouseMove` `mouse_move`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional rightClick` `right_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional screenshot` `screenshot`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scroll` `scroll`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional tripleClick` `triple_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional wait` `wait`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional zoom` `zoom`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Triple Click Config - `class ComputerTripleClickConfig` `triple_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Triple Click Input - `class ComputerTripleClickInput` Triple-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Computer Triple Click Tool Use Block - `class ComputerTripleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerTripleClickInput input` Triple-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "triple_click"` - `JsonValue toolsetName = "computer"` ### Computer Type Config - `class ComputerTypeConfig` `type`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Type Input - `class ComputerTypeInput` Type a string of text on the keyboard. - `String text` The text to type. ### Computer Type Tool Use Block - `class ComputerTypeToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerTypeInput input` Type a string of text on the keyboard. - `String text` The text to type. - `JsonValue name = "type"` - `JsonValue toolsetName = "computer"` ### Computer Wait Config - `class ComputerWaitConfig` `wait`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Wait Input - `class ComputerWaitInput` Wait for a specified duration. - `long duration` Duration to wait, in seconds. maximum: 300 ### Computer Wait Tool Use Block - `class ComputerWaitToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerWaitInput input` Wait for a specified duration. - `long duration` Duration to wait, in seconds. maximum: 300 - `JsonValue name = "wait"` - `JsonValue toolsetName = "computer"` ### Computer Zoom Config - `class ComputerZoomConfig` `zoom`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. ### Computer Zoom Input - `class ComputerZoomInput` Take a screenshot of a rectangular region. Region coordinates are in the full-screenshot space (not physical display pixels). The crop is scaled up to fill the image budget so fine details become legible. - `List region` (x0, y0, x1, y1): The region to capture. minItems: 4, maxItems: 4 ### Computer Zoom Tool Use Block - `class ComputerZoomToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ComputerZoomInput input` Take a screenshot of a rectangular region. Region coordinates are in the full-screenshot space (not physical display pixels). The crop is scaled up to fill the image budget so fine details become legible. - `List region` (x0, y0, x1, y1): The region to capture. minItems: 4, maxItems: 4 - `JsonValue name = "zoom"` - `JsonValue toolsetName = "computer"` ### Container - `class Container` Information about the container used in the request (for the code execution tool) - `String id` Identifier for the container used in this request - `LocalDateTime expiresAt` The time at which the container will expire. format: date-time - `Optional> skills` Skills loaded in the container - `Type type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `ANTHROPIC("anthropic")` - `CUSTOM("custom")` - `String skillId` Skill ID minLength: 1, maxLength: 64 - `String version` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 ### Container Params - `class ContainerParams` Container parameters with skills to be loaded. - `Optional id` Container id - `Optional> skills` List of skills to load in the container maxItems: 20 - `Type type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `ANTHROPIC("anthropic")` - `CUSTOM("custom")` - `String skillId` Skill ID minLength: 1, maxLength: 64 - `Optional version` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 ### Container Skill - `class ContainerSkill` A skill that was loaded in a container (response model). - `Type type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `ANTHROPIC("anthropic")` - `CUSTOM("custom")` - `String skillId` Skill ID minLength: 1, maxLength: 64 - `String version` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 ### Container Upload Block - `class ContainerUploadBlock` Response model for a file uploaded to the container. - `JsonValue type = "container_upload"` - `String fileId` ### Container Upload Block Param - `class ContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `JsonValue type = "container_upload"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` ### Content Block - `class ContentBlock: union` - `class TextBlock` - `JsonValue type = "text"` - `Optional> citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class CitationCharLocation` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endCharIndex` - `Optional fileId` - `long startCharIndex` minimum: 0 - `class CitationPageLocation` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endPageNumber` - `Optional fileId` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocation` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `Optional fileId` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationsWebSearchResultLocation` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` maxLength: 512 - `String url` - `class CitationsSearchResultLocation` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `String text` - `class ThinkingBlock` - `JsonValue type = "thinking"` - `String signature` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java) for details. - `String thinking` The text of Claude's thinking process for this block. - `class RedactedThinkingBlock` - `JsonValue type = "redacted_thinking"` - `String data` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java#redacted-thinking-blocks) for details. - `class ToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input input` - `String name` minLength: 1 - `Optional toolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ServerToolUseBlock` - `JsonValue type = "server_tool_use"` - `String id` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `Input input` - `Name name` - `WEB_SEARCH("web_search")` - `WEB_FETCH("web_fetch")` - `CODE_EXECUTION("code_execution")` - `BASH_CODE_EXECUTION("bash_code_execution")` - `TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `class WebSearchToolResultBlock` - `JsonValue type = "web_search_tool_result"` - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `WebSearchToolResultBlockContent content` - `class WebSearchToolResultError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` - `List` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `Optional pageAge` - `String title` - `String url` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class WebFetchToolResultBlock` - `JsonValue type = "web_fetch_tool_result"` - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `Content content` - `class WebFetchToolResultErrorBlock` - `JsonValue type = "web_fetch_tool_result_error"` - `WebFetchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` - `class WebFetchBlock` - `JsonValue type = "web_fetch_result"` - `DocumentBlock content` - `JsonValue type = "document"` - `Optional citations` Citation configuration for the document - `boolean enabled` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `Optional title` The title of the document - `Optional retrievedAt` ISO 8601 timestamp when the content was retrieved - `String url` Fetched content URL - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class CodeExecutionToolResultBlock` - `JsonValue type = "code_execution_tool_result"` - `CodeExecutionToolResultBlockContent content` - `class CodeExecutionToolResultError` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `class CodeExecutionResultBlock` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `class EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BashCodeExecutionToolResultBlock` - `JsonValue type = "bash_code_execution_tool_result"` - `Content content` - `class BashCodeExecutionToolResultError` - `JsonValue type = "bash_code_execution_tool_result_error"` - `BashCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` - `class BashCodeExecutionResultBlock` - `JsonValue type = "bash_code_execution_result"` - `List content` - `JsonValue type = "bash_code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class TextEditorCodeExecutionToolResultBlock` - `JsonValue type = "text_editor_code_execution_tool_result"` - `Content content` - `class TextEditorCodeExecutionToolResultError` - `JsonValue type = "text_editor_code_execution_tool_result_error"` - `TextEditorCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` - `Optional errorMessage` - `class TextEditorCodeExecutionViewResultBlock` - `JsonValue type = "text_editor_code_execution_view_result"` - `String content` - `FileType fileType` - `TEXT("text")` - `IMAGE("image")` - `PDF("pdf")` - `Optional numLines` - `Optional startLine` - `Optional totalLines` - `class TextEditorCodeExecutionCreateResultBlock` - `JsonValue type = "text_editor_code_execution_create_result"` - `boolean isFileUpdate` - `class TextEditorCodeExecutionStrReplaceResultBlock` - `JsonValue type = "text_editor_code_execution_str_replace_result"` - `Optional> lines` - `Optional newLines` - `Optional newStart` - `Optional oldLines` - `Optional oldStart` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ToolSearchToolResultBlock` - `JsonValue type = "tool_search_tool_result"` - `Content content` - `class ToolSearchToolResultError` - `JsonValue type = "tool_search_tool_result_error"` - `ToolSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `Optional errorMessage` - `class ToolSearchToolSearchResultBlock` - `JsonValue type = "tool_search_tool_search_result"` - `List toolReferences` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ContainerUploadBlock` Response model for a file uploaded to the container. - `JsonValue type = "container_upload"` - `String fileId` ### Content Block Param - `class ContentBlockParam: union` - `class TextBlockParam` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional> citations` - `class CitationCharLocationParam` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endCharIndex` - `long startCharIndex` minimum: 0 - `class CitationPageLocationParam` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endPageNumber` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocationParam` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationWebSearchResultLocationParam` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` minLength: 1, maxLength: 512 - `String url` minLength: 1 - `class CitationSearchResultLocationParam` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `class ImageBlockParam` - `JsonValue type = "image"` - `Source source` - `class Base64ImageSource` - `JsonValue type = "base64"` - `String data` format: byte - `MediaType mediaType` - `IMAGE_JPEG("image/jpeg")` - `IMAGE_PNG("image/png")` - `IMAGE_GIF("image/gif")` - `IMAGE_WEBP("image/webp")` - `class UrlImageSource` - `JsonValue type = "url"` - `String url` - `class FileImageSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional transformations` 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. - `Optional oversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `DOWNSIZE("downsize")` - `ERROR("error")` - `class DocumentBlockParam` - `JsonValue type = "document"` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `class ContentBlockSource` - `JsonValue type = "content"` - `Content content` - `String` - `List` - `class TextBlockParam` - `class ImageBlockParam` - `class UrlPdfSource` - `JsonValue type = "url"` - `String url` - `class FileDocumentSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` - `Optional enabled` - `Optional context` minLength: 1 - `Optional title` minLength: 1, maxLength: 500 - `class SearchResultBlockParam` - `JsonValue type = "search_result"` - `List content` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional> citations` - `String source` - `String title` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` - `class ThinkingBlockParam` - `JsonValue type = "thinking"` - `String signature` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `String thinking` The `thinking` text of this block as returned by the API. - `class RedactedThinkingBlockParam` - `JsonValue type = "redacted_thinking"` - `String data` 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. - `class ToolUseBlockParam` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `Input input` - `String name` minLength: 1, maxLength: 200 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional toolsetName` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ToolResultBlockParam` - `JsonValue type = "tool_result"` - `String toolUseId` pattern: ^[a-zA-Z0-9_-]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional content` - `String` - `List` - `class TextBlockParam` - `class ImageBlockParam` - `class SearchResultBlockParam` - `class DocumentBlockParam` - `class ToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class BrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonValue type = "browser_state"` - `List tabs` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `String tabId` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional> stateChanges` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `class BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonValue type = "tab_opened"` - `String tabId` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonValue type = "download_started"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonValue type = "download_completed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional sizeBytes` The completed download's size. minimum: 0 - `class BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonValue type = "download_failed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional isError` - `Optional toolsetName` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ServerToolUseBlockParam` - `JsonValue type = "server_tool_use"` - `String id` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input input` - `Name name` - `WEB_SEARCH("web_search")` - `WEB_FETCH("web_fetch")` - `CODE_EXECUTION("code_execution")` - `BASH_CODE_EXECUTION("bash_code_execution")` - `TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `class WebSearchToolResultBlockParam` - `JsonValue type = "web_search_tool_result"` - `WebSearchToolResultBlockParamContent content` - `List` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `String title` - `String url` - `Optional pageAge` - `class WebSearchToolRequestError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `class WebFetchToolResultBlockParam` - `JsonValue type = "web_fetch_tool_result"` - `Content content` - `class WebFetchToolResultErrorBlockParam` - `JsonValue type = "web_fetch_tool_result_error"` - `WebFetchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` - `class WebFetchBlockParam` - `JsonValue type = "web_fetch_result"` - `DocumentBlockParam content` - `String url` Fetched content URL - `Optional retrievedAt` ISO 8601 timestamp when the content was retrieved - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `class CodeExecutionToolResultBlockParam` - `JsonValue type = "code_execution_tool_result"` - `CodeExecutionToolResultBlockParamContent content` - `class CodeExecutionToolResultErrorParam` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `class CodeExecutionResultBlockParam` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `class EncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class BashCodeExecutionToolResultBlockParam` - `JsonValue type = "bash_code_execution_tool_result"` - `Content content` - `class BashCodeExecutionToolResultErrorParam` - `JsonValue type = "bash_code_execution_tool_result_error"` - `BashCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` - `class BashCodeExecutionResultBlockParam` - `JsonValue type = "bash_code_execution_result"` - `List content` - `JsonValue type = "bash_code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class TextEditorCodeExecutionToolResultBlockParam` - `JsonValue type = "text_editor_code_execution_tool_result"` - `Content content` - `class TextEditorCodeExecutionToolResultErrorParam` - `JsonValue type = "text_editor_code_execution_tool_result_error"` - `TextEditorCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` - `Optional errorMessage` - `class TextEditorCodeExecutionViewResultBlockParam` - `JsonValue type = "text_editor_code_execution_view_result"` - `String content` - `FileType fileType` - `TEXT("text")` - `IMAGE("image")` - `PDF("pdf")` - `Optional numLines` - `Optional startLine` - `Optional totalLines` - `class TextEditorCodeExecutionCreateResultBlockParam` - `JsonValue type = "text_editor_code_execution_create_result"` - `boolean isFileUpdate` - `class TextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonValue type = "text_editor_code_execution_str_replace_result"` - `Optional> lines` - `Optional newLines` - `Optional newStart` - `Optional oldLines` - `Optional oldStart` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class ToolSearchToolResultBlockParam` - `JsonValue type = "tool_search_tool_result"` - `Content content` - `class ToolSearchToolResultErrorParam` - `JsonValue type = "tool_search_tool_result_error"` - `ToolSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `Optional errorMessage` - `class ToolSearchToolSearchResultBlockParam` - `JsonValue type = "tool_search_tool_search_result"` - `List toolReferences` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class ContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `JsonValue type = "container_upload"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. ### Content Block Source - `class ContentBlockSource` - `JsonValue type = "content"` - `Content content` - `String` - `List` - `class TextBlockParam` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional> citations` - `class CitationCharLocationParam` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endCharIndex` - `long startCharIndex` minimum: 0 - `class CitationPageLocationParam` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endPageNumber` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocationParam` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationWebSearchResultLocationParam` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` minLength: 1, maxLength: 512 - `String url` minLength: 1 - `class CitationSearchResultLocationParam` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `class ImageBlockParam` - `JsonValue type = "image"` - `Source source` - `class Base64ImageSource` - `JsonValue type = "base64"` - `String data` format: byte - `MediaType mediaType` - `IMAGE_JPEG("image/jpeg")` - `IMAGE_PNG("image/png")` - `IMAGE_GIF("image/gif")` - `IMAGE_WEBP("image/webp")` - `class UrlImageSource` - `JsonValue type = "url"` - `String url` - `class FileImageSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional transformations` 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. - `Optional oversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `DOWNSIZE("downsize")` - `ERROR("error")` ### Content Block Source Content - `class ContentBlockSourceContent: union` - `class TextBlockParam` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional> citations` - `class CitationCharLocationParam` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endCharIndex` - `long startCharIndex` minimum: 0 - `class CitationPageLocationParam` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endPageNumber` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocationParam` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationWebSearchResultLocationParam` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` minLength: 1, maxLength: 512 - `String url` minLength: 1 - `class CitationSearchResultLocationParam` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `class ImageBlockParam` - `JsonValue type = "image"` - `Source source` - `class Base64ImageSource` - `JsonValue type = "base64"` - `String data` format: byte - `MediaType mediaType` - `IMAGE_JPEG("image/jpeg")` - `IMAGE_PNG("image/png")` - `IMAGE_GIF("image/gif")` - `IMAGE_WEBP("image/webp")` - `class UrlImageSource` - `JsonValue type = "url"` - `String url` - `class FileImageSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional transformations` 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. - `Optional oversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `DOWNSIZE("downsize")` - `ERROR("error")` ### Diagnostics - `class Diagnostics` Request-level diagnostics: why the prompt cache could not fully reuse the prefix of the request named by `diagnostics.previous_message_id`. - `Optional cacheMissReason` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `class CacheMissModelChanged` - `JsonValue type = "model_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissSystemChanged` - `JsonValue type = "system_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissToolsChanged` - `JsonValue type = "tools_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissMessagesChanged` - `JsonValue type = "messages_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissPreviousMessageNotFound` - `JsonValue type = "previous_message_not_found"` - `class CacheMissUnavailable` - `JsonValue type = "unavailable"` ### Diagnostics Param - `class DiagnosticsParam` Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting. - `Optional previousMessageId` The `id` (`msg_...`) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns `diagnostics.cache_miss_reason` when the prompt-cache prefix could not be reused. Pass `null` on the first turn to opt in without a prior message to compare. maxLength: 256 ### Direct Caller - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` ### Document Block - `class DocumentBlock` - `JsonValue type = "document"` - `Optional citations` Citation configuration for the document - `boolean enabled` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `Optional title` The title of the document ### Document Block Param - `class DocumentBlockParam` - `JsonValue type = "document"` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `class ContentBlockSource` - `JsonValue type = "content"` - `Content content` - `String` - `List` - `class TextBlockParam` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional> citations` - `class CitationCharLocationParam` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endCharIndex` - `long startCharIndex` minimum: 0 - `class CitationPageLocationParam` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endPageNumber` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocationParam` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationWebSearchResultLocationParam` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` minLength: 1, maxLength: 512 - `String url` minLength: 1 - `class CitationSearchResultLocationParam` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `class ImageBlockParam` - `JsonValue type = "image"` - `Source source` - `class Base64ImageSource` - `JsonValue type = "base64"` - `String data` format: byte - `MediaType mediaType` - `IMAGE_JPEG("image/jpeg")` - `IMAGE_PNG("image/png")` - `IMAGE_GIF("image/gif")` - `IMAGE_WEBP("image/webp")` - `class UrlImageSource` - `JsonValue type = "url"` - `String url` - `class FileImageSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional transformations` 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. - `Optional oversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `DOWNSIZE("downsize")` - `ERROR("error")` - `class UrlPdfSource` - `JsonValue type = "url"` - `String url` - `class FileDocumentSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` - `Optional enabled` - `Optional context` minLength: 1 - `Optional title` minLength: 1, maxLength: 500 ### Encrypted Code Execution Result Block - `class EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` ### Encrypted Code Execution Result Block Param - `class EncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` ### File Document Source - `class FileDocumentSource` - `JsonValue type = "file"` - `String fileId` ### File Image Source - `class FileImageSource` - `JsonValue type = "file"` - `String fileId` ### Image Block Param - `class ImageBlockParam` - `JsonValue type = "image"` - `Source source` - `class Base64ImageSource` - `JsonValue type = "base64"` - `String data` format: byte - `MediaType mediaType` - `IMAGE_JPEG("image/jpeg")` - `IMAGE_PNG("image/png")` - `IMAGE_GIF("image/gif")` - `IMAGE_WEBP("image/webp")` - `class UrlImageSource` - `JsonValue type = "url"` - `String url` - `class FileImageSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional transformations` 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. - `Optional oversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `DOWNSIZE("downsize")` - `ERROR("error")` ### Image Transformations Param - `class ImageTransformationsParam` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `Optional oversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `DOWNSIZE("downsize")` - `ERROR("error")` ### Input JSON Delta - `class InputJsonDelta` - `JsonValue type = "input_json_delta"` - `String partialJson` ### JSON Output Format - `class JsonOutputFormat` - `JsonValue type = "json_schema"` - `Schema schema` The JSON schema of the format ### Memory Tool 20250818 - `class MemoryTool20250818` - `JsonValue type = "memory_20250818"` - `JsonValue name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs ### Message - `class Message` - `JsonValue type = "message"` Object type. For Messages, this is always `"message"`. - `String id` Unique object identifier. The format and length of IDs may change over time. - `Optional container` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `String id` Identifier for the container used in this request - `LocalDateTime expiresAt` The time at which the container will expire. format: date-time - `Optional> skills` Skills loaded in the container - `Type type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `ANTHROPIC("anthropic")` - `CUSTOM("custom")` - `String skillId` Skill ID minLength: 1, maxLength: 64 - `String version` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `List content` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `class TextBlock` - `JsonValue type = "text"` - `Optional> citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class CitationCharLocation` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endCharIndex` - `Optional fileId` - `long startCharIndex` minimum: 0 - `class CitationPageLocation` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endPageNumber` - `Optional fileId` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocation` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `Optional fileId` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationsWebSearchResultLocation` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` maxLength: 512 - `String url` - `class CitationsSearchResultLocation` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `String text` - `class ThinkingBlock` - `JsonValue type = "thinking"` - `String signature` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java) for details. - `String thinking` The text of Claude's thinking process for this block. - `class RedactedThinkingBlock` - `JsonValue type = "redacted_thinking"` - `String data` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java#redacted-thinking-blocks) for details. - `class ToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input input` - `String name` minLength: 1 - `Optional toolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ServerToolUseBlock` - `JsonValue type = "server_tool_use"` - `String id` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `Input input` - `Name name` - `WEB_SEARCH("web_search")` - `WEB_FETCH("web_fetch")` - `CODE_EXECUTION("code_execution")` - `BASH_CODE_EXECUTION("bash_code_execution")` - `TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `class WebSearchToolResultBlock` - `JsonValue type = "web_search_tool_result"` - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `WebSearchToolResultBlockContent content` - `class WebSearchToolResultError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` - `List` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `Optional pageAge` - `String title` - `String url` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class WebFetchToolResultBlock` - `JsonValue type = "web_fetch_tool_result"` - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `Content content` - `class WebFetchToolResultErrorBlock` - `JsonValue type = "web_fetch_tool_result_error"` - `WebFetchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` - `class WebFetchBlock` - `JsonValue type = "web_fetch_result"` - `DocumentBlock content` - `JsonValue type = "document"` - `Optional citations` Citation configuration for the document - `boolean enabled` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `Optional title` The title of the document - `Optional retrievedAt` ISO 8601 timestamp when the content was retrieved - `String url` Fetched content URL - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class CodeExecutionToolResultBlock` - `JsonValue type = "code_execution_tool_result"` - `CodeExecutionToolResultBlockContent content` - `class CodeExecutionToolResultError` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `class CodeExecutionResultBlock` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `class EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BashCodeExecutionToolResultBlock` - `JsonValue type = "bash_code_execution_tool_result"` - `Content content` - `class BashCodeExecutionToolResultError` - `JsonValue type = "bash_code_execution_tool_result_error"` - `BashCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` - `class BashCodeExecutionResultBlock` - `JsonValue type = "bash_code_execution_result"` - `List content` - `JsonValue type = "bash_code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class TextEditorCodeExecutionToolResultBlock` - `JsonValue type = "text_editor_code_execution_tool_result"` - `Content content` - `class TextEditorCodeExecutionToolResultError` - `JsonValue type = "text_editor_code_execution_tool_result_error"` - `TextEditorCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` - `Optional errorMessage` - `class TextEditorCodeExecutionViewResultBlock` - `JsonValue type = "text_editor_code_execution_view_result"` - `String content` - `FileType fileType` - `TEXT("text")` - `IMAGE("image")` - `PDF("pdf")` - `Optional numLines` - `Optional startLine` - `Optional totalLines` - `class TextEditorCodeExecutionCreateResultBlock` - `JsonValue type = "text_editor_code_execution_create_result"` - `boolean isFileUpdate` - `class TextEditorCodeExecutionStrReplaceResultBlock` - `JsonValue type = "text_editor_code_execution_str_replace_result"` - `Optional> lines` - `Optional newLines` - `Optional newStart` - `Optional oldLines` - `Optional oldStart` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ToolSearchToolResultBlock` - `JsonValue type = "tool_search_tool_result"` - `Content content` - `class ToolSearchToolResultError` - `JsonValue type = "tool_search_tool_result_error"` - `ToolSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `Optional errorMessage` - `class ToolSearchToolSearchResultBlock` - `JsonValue type = "tool_search_tool_search_result"` - `List toolReferences` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ContainerUploadBlock` Response model for a file uploaded to the container. - `JsonValue type = "container_upload"` - `String fileId` - `Optional diagnostics` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `Optional cacheMissReason` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `class CacheMissModelChanged` - `JsonValue type = "model_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissSystemChanged` - `JsonValue type = "system_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissToolsChanged` - `JsonValue type = "tools_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissMessagesChanged` - `JsonValue type = "messages_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissPreviousMessageNotFound` - `JsonValue type = "previous_message_not_found"` - `class CacheMissUnavailable` - `JsonValue type = "unavailable"` - `Model model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `CLAUDE_HAIKU_5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `CLAUDE_SONNET_5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `CLAUDE_FABLE_5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `CLAUDE_OPUS_5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `CLAUDE_MYTHOS_5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `CLAUDE_SONNET_5("claude-sonnet-5")` Efficient model for coding and agents - `CLAUDE_FABLE_5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `CLAUDE_MYTHOS_5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `CLAUDE_OPUS_5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `CLAUDE_SONNET_4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `CLAUDE_HAIKU_4_5("claude-haiku-4-5")` - `CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")` - `CLAUDE_OPUS_4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `CLAUDE_MYTHOS_PREVIEW("claude-mythos-preview")` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `CLAUDE_SONNET_4_5("claude-sonnet-4-5")` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `JsonValue role = "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `Optional stopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `JsonValue type = "refusal"` - `Optional category` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `CYBER("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `BIO("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FRONTIER_LLM("frontier_llm")` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `REASONING_EXTRACTION("reasoning_extraction")` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=java). - `GENERAL_HARMS("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `Optional explanation` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `Optional stopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations * `"model_context_window_exceeded"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `END_TURN("end_turn")` - `MAX_TOKENS("max_tokens")` - `STOP_SEQUENCE("stop_sequence")` - `TOOL_USE("tool_use")` - `PAUSE_TURN("pause_turn")` - `REFUSAL("refusal")` - `MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")` - `Optional stopSequence` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Usage usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `Optional cacheCreation` Breakdown of cached tokens by TTL - `long ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `long ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `Optional cacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `Optional cacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `Optional inferenceGeo` The geographic region where inference was performed for this request. - `long inputTokens` The number of input tokens which were used. minimum: 0 - `long outputTokens` The number of output tokens which were used. minimum: 0 - `Optional outputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `long thinkingTokens` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. minimum: 0 - `Optional serverToolUse` The number of server tool requests. - `long webFetchRequests` The number of web fetch tool requests. minimum: 0 - `long webSearchRequests` The number of web search tool requests. minimum: 0 - `Optional serviceTier` If the request used the priority, standard, or batch tier. - `STANDARD("standard")` - `PRIORITY("priority")` - `BATCH("batch")` - `Optional speed` The inference speed mode used for this request. - `STANDARD("standard")` - `FAST("fast")` ### Message Count Tokens Tool - `class MessageCountTokensTool: union` - `class Tool` - `Optional type` - `InputSchema inputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `JsonValue type = "object"` - `Optional properties` - `Optional> required` - `String name` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional description` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `Optional eagerInputStreaming` 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. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolBash20250124` - `JsonValue type = "bash_20250124"` - `JsonValue name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20250522` - `JsonValue type = "code_execution_20250522"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20250825` - `JsonValue type = "code_execution_20250825"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `JsonValue type = "code_execution_20260120"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonValue type = "code_execution_20260521"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class BrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonValue type = "browser_toolset_20260801"` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Optional type` `type`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional closeTab` `close_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional doubleClick` `double_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional fileUpload` `file_upload`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional find` `find`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional formInput` `form_input`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional getPageText` `get_page_text`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional holdKey` `hold_key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional hover` `hover`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional javascriptExec` `javascript_exec`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional key` `key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClick` `left_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClickDrag` `left_click_drag`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseDown` `left_mouse_down`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseUp` `left_mouse_up`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional listTabs` `list_tabs`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional middleClick` `middle_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional mouseMove` `mouse_move`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional navigate` `navigate`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional newTab` `new_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readConsole` `read_console`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readNetwork` `read_network`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readPage` `read_page`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional rightClick` `right_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional screenshot` `screenshot`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scroll` `scroll`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scrollTo` `scroll_to`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional switchTab` `switch_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional tripleClick` `triple_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional wait` `wait`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional zoom` `zoom`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class MemoryTool20250818` - `JsonValue type = "memory_20250818"` - `JsonValue name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonValue type = "computer_toolset_20260801"` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Optional type` `type`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional cursorPosition` `cursor_position`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional doubleClick` `double_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional holdKey` `hold_key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional key` `key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClick` `left_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClickDrag` `left_click_drag`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseDown` `left_mouse_down`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseUp` `left_mouse_up`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional middleClick` `middle_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional mouseMove` `mouse_move`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional rightClick` `right_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional screenshot` `screenshot`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scroll` `scroll`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional tripleClick` `triple_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional wait` `wait`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional zoom` `zoom`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class ToolTextEditor20250124` - `JsonValue type = "text_editor_20250124"` - `JsonValue name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolTextEditor20250429` - `JsonValue type = "text_editor_20250429"` - `JsonValue name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolTextEditor20250728` - `JsonValue type = "text_editor_20250728"` - `JsonValue name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional maxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class WebSearchTool20250305` - `JsonValue type = "web_search_20250305"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonValue type = "approximate"` - `Optional city` The city of the user. minLength: 1, maxLength: 255 - `Optional country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Optional region` The region of the user. minLength: 1, maxLength: 255 - `Optional timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class WebFetchTool20250910` - `JsonValue type = "web_fetch_20250910"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional enabled` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional clientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonValue type = "all"` - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonValue type = "none"` - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonValue type = "only"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonValue type = "except"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `Optional serverToolResults` 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. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Optional userInput` Whether URLs in user messages are fetchable: "all" or "none". - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class WebSearchTool20260209` - `JsonValue type = "web_search_20260209"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `class WebFetchTool20260209` - `JsonValue type = "web_fetch_20260209"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class WebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonValue type = "web_fetch_20260309"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional useCache` 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. - `class WebSearchTool20260318` - `JsonValue type = "web_search_20260318"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional responseInclusion` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `FULL("full")` - `EXCLUDED("excluded")` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `class WebFetchTool20260318` - `JsonValue type = "web_fetch_20260318"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional responseInclusion` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `FULL("full")` - `EXCLUDED("excluded")` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional useCache` 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. - `class ToolSearchToolBm25_20251119` - `Type type` - `TOOL_SEARCH_TOOL_BM25_20251119("tool_search_tool_bm25_20251119")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `JsonValue name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolSearchToolRegex20251119` - `Type type` - `TOOL_SEARCH_TOOL_REGEX_20251119("tool_search_tool_regex_20251119")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `JsonValue name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs ### Message Create Params Container - `class MessageCreateParamsContainer: union` Container identifier for reuse across requests. - `class ContainerParams` Container parameters with skills to be loaded. - `Optional id` Container id - `Optional> skills` List of skills to load in the container maxItems: 20 - `Type type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `ANTHROPIC("anthropic")` - `CUSTOM("custom")` - `String skillId` Skill ID minLength: 1, maxLength: 64 - `Optional version` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 - `String` ### Message Delta Usage - `class MessageDeltaUsage` - `Optional cacheCreationInputTokens` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `Optional cacheReadInputTokens` The cumulative number of input tokens read from the cache. minimum: 0 - `Optional inputTokens` The cumulative number of input tokens which were used. minimum: 0 - `long outputTokens` The cumulative number of output tokens which were used. - `Optional outputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `long thinkingTokens` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. minimum: 0 - `Optional serverToolUse` The number of server tool requests. - `long webFetchRequests` The number of web fetch tool requests. minimum: 0 - `long webSearchRequests` The number of web search tool requests. minimum: 0 ### Message Param - `class MessageParam` - `Content content` - `String` - `List` - `class TextBlockParam` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional> citations` - `class CitationCharLocationParam` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endCharIndex` - `long startCharIndex` minimum: 0 - `class CitationPageLocationParam` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endPageNumber` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocationParam` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationWebSearchResultLocationParam` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` minLength: 1, maxLength: 512 - `String url` minLength: 1 - `class CitationSearchResultLocationParam` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `class ImageBlockParam` - `JsonValue type = "image"` - `Source source` - `class Base64ImageSource` - `JsonValue type = "base64"` - `String data` format: byte - `MediaType mediaType` - `IMAGE_JPEG("image/jpeg")` - `IMAGE_PNG("image/png")` - `IMAGE_GIF("image/gif")` - `IMAGE_WEBP("image/webp")` - `class UrlImageSource` - `JsonValue type = "url"` - `String url` - `class FileImageSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional transformations` 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. - `Optional oversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `DOWNSIZE("downsize")` - `ERROR("error")` - `class DocumentBlockParam` - `JsonValue type = "document"` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `class ContentBlockSource` - `JsonValue type = "content"` - `Content content` - `String` - `List` - `class TextBlockParam` - `class ImageBlockParam` - `class UrlPdfSource` - `JsonValue type = "url"` - `String url` - `class FileDocumentSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` - `Optional enabled` - `Optional context` minLength: 1 - `Optional title` minLength: 1, maxLength: 500 - `class SearchResultBlockParam` - `JsonValue type = "search_result"` - `List content` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional> citations` - `String source` - `String title` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` - `class ThinkingBlockParam` - `JsonValue type = "thinking"` - `String signature` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `String thinking` The `thinking` text of this block as returned by the API. - `class RedactedThinkingBlockParam` - `JsonValue type = "redacted_thinking"` - `String data` 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. - `class ToolUseBlockParam` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `Input input` - `String name` minLength: 1, maxLength: 200 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional toolsetName` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ToolResultBlockParam` - `JsonValue type = "tool_result"` - `String toolUseId` pattern: ^[a-zA-Z0-9_-]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional content` - `String` - `List` - `class TextBlockParam` - `class ImageBlockParam` - `class SearchResultBlockParam` - `class DocumentBlockParam` - `class ToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class BrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonValue type = "browser_state"` - `List tabs` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `String tabId` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional> stateChanges` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `class BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonValue type = "tab_opened"` - `String tabId` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonValue type = "download_started"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonValue type = "download_completed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional sizeBytes` The completed download's size. minimum: 0 - `class BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonValue type = "download_failed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional isError` - `Optional toolsetName` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ServerToolUseBlockParam` - `JsonValue type = "server_tool_use"` - `String id` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input input` - `Name name` - `WEB_SEARCH("web_search")` - `WEB_FETCH("web_fetch")` - `CODE_EXECUTION("code_execution")` - `BASH_CODE_EXECUTION("bash_code_execution")` - `TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `class WebSearchToolResultBlockParam` - `JsonValue type = "web_search_tool_result"` - `WebSearchToolResultBlockParamContent content` - `List` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `String title` - `String url` - `Optional pageAge` - `class WebSearchToolRequestError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `class WebFetchToolResultBlockParam` - `JsonValue type = "web_fetch_tool_result"` - `Content content` - `class WebFetchToolResultErrorBlockParam` - `JsonValue type = "web_fetch_tool_result_error"` - `WebFetchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` - `class WebFetchBlockParam` - `JsonValue type = "web_fetch_result"` - `DocumentBlockParam content` - `String url` Fetched content URL - `Optional retrievedAt` ISO 8601 timestamp when the content was retrieved - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `class CodeExecutionToolResultBlockParam` - `JsonValue type = "code_execution_tool_result"` - `CodeExecutionToolResultBlockParamContent content` - `class CodeExecutionToolResultErrorParam` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `class CodeExecutionResultBlockParam` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `class EncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class BashCodeExecutionToolResultBlockParam` - `JsonValue type = "bash_code_execution_tool_result"` - `Content content` - `class BashCodeExecutionToolResultErrorParam` - `JsonValue type = "bash_code_execution_tool_result_error"` - `BashCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` - `class BashCodeExecutionResultBlockParam` - `JsonValue type = "bash_code_execution_result"` - `List content` - `JsonValue type = "bash_code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class TextEditorCodeExecutionToolResultBlockParam` - `JsonValue type = "text_editor_code_execution_tool_result"` - `Content content` - `class TextEditorCodeExecutionToolResultErrorParam` - `JsonValue type = "text_editor_code_execution_tool_result_error"` - `TextEditorCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` - `Optional errorMessage` - `class TextEditorCodeExecutionViewResultBlockParam` - `JsonValue type = "text_editor_code_execution_view_result"` - `String content` - `FileType fileType` - `TEXT("text")` - `IMAGE("image")` - `PDF("pdf")` - `Optional numLines` - `Optional startLine` - `Optional totalLines` - `class TextEditorCodeExecutionCreateResultBlockParam` - `JsonValue type = "text_editor_code_execution_create_result"` - `boolean isFileUpdate` - `class TextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonValue type = "text_editor_code_execution_str_replace_result"` - `Optional> lines` - `Optional newLines` - `Optional newStart` - `Optional oldLines` - `Optional oldStart` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class ToolSearchToolResultBlockParam` - `JsonValue type = "tool_search_tool_result"` - `Content content` - `class ToolSearchToolResultErrorParam` - `JsonValue type = "tool_search_tool_result_error"` - `ToolSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `Optional errorMessage` - `class ToolSearchToolSearchResultBlockParam` - `JsonValue type = "tool_search_tool_search_result"` - `List toolReferences` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class ContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `JsonValue type = "container_upload"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Role role` - `USER("user")` - `ASSISTANT("assistant")` - `SYSTEM("system")` ### Message Tokens Count - `class MessageTokensCount` - `long inputTokens` The total number of tokens across the provided list of messages, system prompt, and tools. ### Metadata - `class Metadata` - `Optional userId` An external identifier for the user who is associated with the request. This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number. maxLength: 512 ### Model - `enum Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `CLAUDE_HAIKU_5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `CLAUDE_SONNET_5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `CLAUDE_FABLE_5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `CLAUDE_OPUS_5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `CLAUDE_MYTHOS_5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `CLAUDE_SONNET_5("claude-sonnet-5")` Efficient model for coding and agents - `CLAUDE_FABLE_5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `CLAUDE_MYTHOS_5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `CLAUDE_OPUS_5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `CLAUDE_SONNET_4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `CLAUDE_HAIKU_4_5("claude-haiku-4-5")` - `CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")` - `CLAUDE_OPUS_4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `CLAUDE_MYTHOS_PREVIEW("claude-mythos-preview")` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `CLAUDE_SONNET_4_5("claude-sonnet-4-5")` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding ### Output Config - `class OutputConfig` - `Optional effort` How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. - `LOW("low")` - `MEDIUM("medium")` - `HIGH("high")` - `XHIGH("xhigh")` - `MAX("max")` - `Optional format` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=java) - `JsonValue type = "json_schema"` - `Schema schema` The JSON schema of the format ### Output Tokens Details - `class OutputTokensDetails` - `long thinkingTokens` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. minimum: 0 ### Plain Text Source - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` ### Raw Content Block Delta - `class RawContentBlockDelta: union` - `class TextDelta` - `JsonValue type = "text_delta"` - `String text` - `class InputJsonDelta` - `JsonValue type = "input_json_delta"` - `String partialJson` - `class CitationsDelta` - `JsonValue type = "citations_delta"` - `Citation citation` - `class CitationCharLocation` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endCharIndex` - `Optional fileId` - `long startCharIndex` minimum: 0 - `class CitationPageLocation` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endPageNumber` - `Optional fileId` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocation` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `Optional fileId` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationsWebSearchResultLocation` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` maxLength: 512 - `String url` - `class CitationsSearchResultLocation` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `class ThinkingDelta` - `JsonValue type = "thinking_delta"` - `String thinking` 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. - `class SignatureDelta` - `JsonValue type = "signature_delta"` - `String signature` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. ### Raw Content Block Delta Event - `class RawContentBlockDeltaEvent` - `JsonValue type = "content_block_delta"` - `RawContentBlockDelta delta` - `class TextDelta` - `JsonValue type = "text_delta"` - `String text` - `class InputJsonDelta` - `JsonValue type = "input_json_delta"` - `String partialJson` - `class CitationsDelta` - `JsonValue type = "citations_delta"` - `Citation citation` - `class CitationCharLocation` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endCharIndex` - `Optional fileId` - `long startCharIndex` minimum: 0 - `class CitationPageLocation` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endPageNumber` - `Optional fileId` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocation` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `Optional fileId` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationsWebSearchResultLocation` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` maxLength: 512 - `String url` - `class CitationsSearchResultLocation` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `class ThinkingDelta` - `JsonValue type = "thinking_delta"` - `String thinking` 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. - `class SignatureDelta` - `JsonValue type = "signature_delta"` - `String signature` 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. - `long index` ### Raw Content Block Start Event - `class RawContentBlockStartEvent` - `JsonValue type = "content_block_start"` - `ContentBlock contentBlock` - `class TextBlock` - `JsonValue type = "text"` - `Optional> citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class CitationCharLocation` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endCharIndex` - `Optional fileId` - `long startCharIndex` minimum: 0 - `class CitationPageLocation` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endPageNumber` - `Optional fileId` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocation` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `Optional fileId` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationsWebSearchResultLocation` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` maxLength: 512 - `String url` - `class CitationsSearchResultLocation` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `String text` - `class ThinkingBlock` - `JsonValue type = "thinking"` - `String signature` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java) for details. - `String thinking` The text of Claude's thinking process for this block. - `class RedactedThinkingBlock` - `JsonValue type = "redacted_thinking"` - `String data` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java#redacted-thinking-blocks) for details. - `class ToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input input` - `String name` minLength: 1 - `Optional toolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ServerToolUseBlock` - `JsonValue type = "server_tool_use"` - `String id` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `Input input` - `Name name` - `WEB_SEARCH("web_search")` - `WEB_FETCH("web_fetch")` - `CODE_EXECUTION("code_execution")` - `BASH_CODE_EXECUTION("bash_code_execution")` - `TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `class WebSearchToolResultBlock` - `JsonValue type = "web_search_tool_result"` - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `WebSearchToolResultBlockContent content` - `class WebSearchToolResultError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` - `List` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `Optional pageAge` - `String title` - `String url` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class WebFetchToolResultBlock` - `JsonValue type = "web_fetch_tool_result"` - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `Content content` - `class WebFetchToolResultErrorBlock` - `JsonValue type = "web_fetch_tool_result_error"` - `WebFetchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` - `class WebFetchBlock` - `JsonValue type = "web_fetch_result"` - `DocumentBlock content` - `JsonValue type = "document"` - `Optional citations` Citation configuration for the document - `boolean enabled` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `Optional title` The title of the document - `Optional retrievedAt` ISO 8601 timestamp when the content was retrieved - `String url` Fetched content URL - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class CodeExecutionToolResultBlock` - `JsonValue type = "code_execution_tool_result"` - `CodeExecutionToolResultBlockContent content` - `class CodeExecutionToolResultError` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `class CodeExecutionResultBlock` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `class EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BashCodeExecutionToolResultBlock` - `JsonValue type = "bash_code_execution_tool_result"` - `Content content` - `class BashCodeExecutionToolResultError` - `JsonValue type = "bash_code_execution_tool_result_error"` - `BashCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` - `class BashCodeExecutionResultBlock` - `JsonValue type = "bash_code_execution_result"` - `List content` - `JsonValue type = "bash_code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class TextEditorCodeExecutionToolResultBlock` - `JsonValue type = "text_editor_code_execution_tool_result"` - `Content content` - `class TextEditorCodeExecutionToolResultError` - `JsonValue type = "text_editor_code_execution_tool_result_error"` - `TextEditorCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` - `Optional errorMessage` - `class TextEditorCodeExecutionViewResultBlock` - `JsonValue type = "text_editor_code_execution_view_result"` - `String content` - `FileType fileType` - `TEXT("text")` - `IMAGE("image")` - `PDF("pdf")` - `Optional numLines` - `Optional startLine` - `Optional totalLines` - `class TextEditorCodeExecutionCreateResultBlock` - `JsonValue type = "text_editor_code_execution_create_result"` - `boolean isFileUpdate` - `class TextEditorCodeExecutionStrReplaceResultBlock` - `JsonValue type = "text_editor_code_execution_str_replace_result"` - `Optional> lines` - `Optional newLines` - `Optional newStart` - `Optional oldLines` - `Optional oldStart` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ToolSearchToolResultBlock` - `JsonValue type = "tool_search_tool_result"` - `Content content` - `class ToolSearchToolResultError` - `JsonValue type = "tool_search_tool_result_error"` - `ToolSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `Optional errorMessage` - `class ToolSearchToolSearchResultBlock` - `JsonValue type = "tool_search_tool_search_result"` - `List toolReferences` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ContainerUploadBlock` Response model for a file uploaded to the container. - `JsonValue type = "container_upload"` - `String fileId` - `long index` ### Raw Content Block Stop Event - `class RawContentBlockStopEvent` - `JsonValue type = "content_block_stop"` - `long index` ### Raw Message Delta Event - `class RawMessageDeltaEvent` - `JsonValue type = "message_delta"` - `Delta delta` - `Optional container` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `String id` Identifier for the container used in this request - `LocalDateTime expiresAt` The time at which the container will expire. format: date-time - `Optional> skills` Skills loaded in the container - `Type type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `ANTHROPIC("anthropic")` - `CUSTOM("custom")` - `String skillId` Skill ID minLength: 1, maxLength: 64 - `String version` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `Optional stopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `JsonValue type = "refusal"` - `Optional category` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `CYBER("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `BIO("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FRONTIER_LLM("frontier_llm")` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `REASONING_EXTRACTION("reasoning_extraction")` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=java). - `GENERAL_HARMS("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `Optional explanation` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `Optional stopReason` - `END_TURN("end_turn")` - `MAX_TOKENS("max_tokens")` - `STOP_SEQUENCE("stop_sequence")` - `TOOL_USE("tool_use")` - `PAUSE_TURN("pause_turn")` - `REFUSAL("refusal")` - `MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")` - `Optional stopSequence` - `MessageDeltaUsage usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `Optional cacheCreationInputTokens` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `Optional cacheReadInputTokens` The cumulative number of input tokens read from the cache. minimum: 0 - `Optional inputTokens` The cumulative number of input tokens which were used. minimum: 0 - `long outputTokens` The cumulative number of output tokens which were used. - `Optional outputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `long thinkingTokens` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. minimum: 0 - `Optional serverToolUse` The number of server tool requests. - `long webFetchRequests` The number of web fetch tool requests. minimum: 0 - `long webSearchRequests` The number of web search tool requests. minimum: 0 ### Raw Message Start Event - `class RawMessageStartEvent` - `JsonValue type = "message_start"` - `Message message` - `JsonValue type = "message"` Object type. For Messages, this is always `"message"`. - `String id` Unique object identifier. The format and length of IDs may change over time. - `Optional container` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `String id` Identifier for the container used in this request - `LocalDateTime expiresAt` The time at which the container will expire. format: date-time - `Optional> skills` Skills loaded in the container - `Type type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `ANTHROPIC("anthropic")` - `CUSTOM("custom")` - `String skillId` Skill ID minLength: 1, maxLength: 64 - `String version` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `List content` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `class TextBlock` - `JsonValue type = "text"` - `Optional> citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class CitationCharLocation` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endCharIndex` - `Optional fileId` - `long startCharIndex` minimum: 0 - `class CitationPageLocation` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endPageNumber` - `Optional fileId` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocation` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `Optional fileId` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationsWebSearchResultLocation` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` maxLength: 512 - `String url` - `class CitationsSearchResultLocation` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `String text` - `class ThinkingBlock` - `JsonValue type = "thinking"` - `String signature` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java) for details. - `String thinking` The text of Claude's thinking process for this block. - `class RedactedThinkingBlock` - `JsonValue type = "redacted_thinking"` - `String data` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java#redacted-thinking-blocks) for details. - `class ToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input input` - `String name` minLength: 1 - `Optional toolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ServerToolUseBlock` - `JsonValue type = "server_tool_use"` - `String id` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `Input input` - `Name name` - `WEB_SEARCH("web_search")` - `WEB_FETCH("web_fetch")` - `CODE_EXECUTION("code_execution")` - `BASH_CODE_EXECUTION("bash_code_execution")` - `TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `class WebSearchToolResultBlock` - `JsonValue type = "web_search_tool_result"` - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `WebSearchToolResultBlockContent content` - `class WebSearchToolResultError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` - `List` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `Optional pageAge` - `String title` - `String url` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class WebFetchToolResultBlock` - `JsonValue type = "web_fetch_tool_result"` - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `Content content` - `class WebFetchToolResultErrorBlock` - `JsonValue type = "web_fetch_tool_result_error"` - `WebFetchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` - `class WebFetchBlock` - `JsonValue type = "web_fetch_result"` - `DocumentBlock content` - `JsonValue type = "document"` - `Optional citations` Citation configuration for the document - `boolean enabled` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `Optional title` The title of the document - `Optional retrievedAt` ISO 8601 timestamp when the content was retrieved - `String url` Fetched content URL - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class CodeExecutionToolResultBlock` - `JsonValue type = "code_execution_tool_result"` - `CodeExecutionToolResultBlockContent content` - `class CodeExecutionToolResultError` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `class CodeExecutionResultBlock` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `class EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BashCodeExecutionToolResultBlock` - `JsonValue type = "bash_code_execution_tool_result"` - `Content content` - `class BashCodeExecutionToolResultError` - `JsonValue type = "bash_code_execution_tool_result_error"` - `BashCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` - `class BashCodeExecutionResultBlock` - `JsonValue type = "bash_code_execution_result"` - `List content` - `JsonValue type = "bash_code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class TextEditorCodeExecutionToolResultBlock` - `JsonValue type = "text_editor_code_execution_tool_result"` - `Content content` - `class TextEditorCodeExecutionToolResultError` - `JsonValue type = "text_editor_code_execution_tool_result_error"` - `TextEditorCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` - `Optional errorMessage` - `class TextEditorCodeExecutionViewResultBlock` - `JsonValue type = "text_editor_code_execution_view_result"` - `String content` - `FileType fileType` - `TEXT("text")` - `IMAGE("image")` - `PDF("pdf")` - `Optional numLines` - `Optional startLine` - `Optional totalLines` - `class TextEditorCodeExecutionCreateResultBlock` - `JsonValue type = "text_editor_code_execution_create_result"` - `boolean isFileUpdate` - `class TextEditorCodeExecutionStrReplaceResultBlock` - `JsonValue type = "text_editor_code_execution_str_replace_result"` - `Optional> lines` - `Optional newLines` - `Optional newStart` - `Optional oldLines` - `Optional oldStart` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ToolSearchToolResultBlock` - `JsonValue type = "tool_search_tool_result"` - `Content content` - `class ToolSearchToolResultError` - `JsonValue type = "tool_search_tool_result_error"` - `ToolSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `Optional errorMessage` - `class ToolSearchToolSearchResultBlock` - `JsonValue type = "tool_search_tool_search_result"` - `List toolReferences` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ContainerUploadBlock` Response model for a file uploaded to the container. - `JsonValue type = "container_upload"` - `String fileId` - `Optional diagnostics` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `Optional cacheMissReason` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `class CacheMissModelChanged` - `JsonValue type = "model_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissSystemChanged` - `JsonValue type = "system_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissToolsChanged` - `JsonValue type = "tools_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissMessagesChanged` - `JsonValue type = "messages_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissPreviousMessageNotFound` - `JsonValue type = "previous_message_not_found"` - `class CacheMissUnavailable` - `JsonValue type = "unavailable"` - `Model model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `CLAUDE_HAIKU_5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `CLAUDE_SONNET_5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `CLAUDE_FABLE_5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `CLAUDE_OPUS_5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `CLAUDE_MYTHOS_5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `CLAUDE_SONNET_5("claude-sonnet-5")` Efficient model for coding and agents - `CLAUDE_FABLE_5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `CLAUDE_MYTHOS_5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `CLAUDE_OPUS_5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `CLAUDE_SONNET_4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `CLAUDE_HAIKU_4_5("claude-haiku-4-5")` - `CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")` - `CLAUDE_OPUS_4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `CLAUDE_MYTHOS_PREVIEW("claude-mythos-preview")` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `CLAUDE_SONNET_4_5("claude-sonnet-4-5")` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `JsonValue role = "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `Optional stopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `JsonValue type = "refusal"` - `Optional category` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `CYBER("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `BIO("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FRONTIER_LLM("frontier_llm")` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `REASONING_EXTRACTION("reasoning_extraction")` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=java). - `GENERAL_HARMS("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `Optional explanation` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `Optional stopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations * `"model_context_window_exceeded"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `END_TURN("end_turn")` - `MAX_TOKENS("max_tokens")` - `STOP_SEQUENCE("stop_sequence")` - `TOOL_USE("tool_use")` - `PAUSE_TURN("pause_turn")` - `REFUSAL("refusal")` - `MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")` - `Optional stopSequence` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Usage usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `Optional cacheCreation` Breakdown of cached tokens by TTL - `long ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `long ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `Optional cacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `Optional cacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `Optional inferenceGeo` The geographic region where inference was performed for this request. - `long inputTokens` The number of input tokens which were used. minimum: 0 - `long outputTokens` The number of output tokens which were used. minimum: 0 - `Optional outputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `long thinkingTokens` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. minimum: 0 - `Optional serverToolUse` The number of server tool requests. - `long webFetchRequests` The number of web fetch tool requests. minimum: 0 - `long webSearchRequests` The number of web search tool requests. minimum: 0 - `Optional serviceTier` If the request used the priority, standard, or batch tier. - `STANDARD("standard")` - `PRIORITY("priority")` - `BATCH("batch")` - `Optional speed` The inference speed mode used for this request. - `STANDARD("standard")` - `FAST("fast")` ### Raw Message Stop Event - `class RawMessageStopEvent` - `JsonValue type = "message_stop"` ### Raw Message Stream Event - `class RawMessageStreamEvent: union` - `class RawMessageStartEvent` - `JsonValue type = "message_start"` - `Message message` - `JsonValue type = "message"` Object type. For Messages, this is always `"message"`. - `String id` Unique object identifier. The format and length of IDs may change over time. - `Optional container` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `String id` Identifier for the container used in this request - `LocalDateTime expiresAt` The time at which the container will expire. format: date-time - `Optional> skills` Skills loaded in the container - `Type type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `ANTHROPIC("anthropic")` - `CUSTOM("custom")` - `String skillId` Skill ID minLength: 1, maxLength: 64 - `String version` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `List content` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `class TextBlock` - `JsonValue type = "text"` - `Optional> citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class CitationCharLocation` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endCharIndex` - `Optional fileId` - `long startCharIndex` minimum: 0 - `class CitationPageLocation` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endPageNumber` - `Optional fileId` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocation` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `Optional fileId` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationsWebSearchResultLocation` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` maxLength: 512 - `String url` - `class CitationsSearchResultLocation` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `String text` - `class ThinkingBlock` - `JsonValue type = "thinking"` - `String signature` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java) for details. - `String thinking` The text of Claude's thinking process for this block. - `class RedactedThinkingBlock` - `JsonValue type = "redacted_thinking"` - `String data` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java#redacted-thinking-blocks) for details. - `class ToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input input` - `String name` minLength: 1 - `Optional toolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ServerToolUseBlock` - `JsonValue type = "server_tool_use"` - `String id` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `Input input` - `Name name` - `WEB_SEARCH("web_search")` - `WEB_FETCH("web_fetch")` - `CODE_EXECUTION("code_execution")` - `BASH_CODE_EXECUTION("bash_code_execution")` - `TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `class WebSearchToolResultBlock` - `JsonValue type = "web_search_tool_result"` - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `WebSearchToolResultBlockContent content` - `class WebSearchToolResultError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` - `List` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `Optional pageAge` - `String title` - `String url` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class WebFetchToolResultBlock` - `JsonValue type = "web_fetch_tool_result"` - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `Content content` - `class WebFetchToolResultErrorBlock` - `JsonValue type = "web_fetch_tool_result_error"` - `WebFetchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` - `class WebFetchBlock` - `JsonValue type = "web_fetch_result"` - `DocumentBlock content` - `JsonValue type = "document"` - `Optional citations` Citation configuration for the document - `boolean enabled` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `Optional title` The title of the document - `Optional retrievedAt` ISO 8601 timestamp when the content was retrieved - `String url` Fetched content URL - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class CodeExecutionToolResultBlock` - `JsonValue type = "code_execution_tool_result"` - `CodeExecutionToolResultBlockContent content` - `class CodeExecutionToolResultError` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `class CodeExecutionResultBlock` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `class EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BashCodeExecutionToolResultBlock` - `JsonValue type = "bash_code_execution_tool_result"` - `Content content` - `class BashCodeExecutionToolResultError` - `JsonValue type = "bash_code_execution_tool_result_error"` - `BashCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` - `class BashCodeExecutionResultBlock` - `JsonValue type = "bash_code_execution_result"` - `List content` - `JsonValue type = "bash_code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class TextEditorCodeExecutionToolResultBlock` - `JsonValue type = "text_editor_code_execution_tool_result"` - `Content content` - `class TextEditorCodeExecutionToolResultError` - `JsonValue type = "text_editor_code_execution_tool_result_error"` - `TextEditorCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` - `Optional errorMessage` - `class TextEditorCodeExecutionViewResultBlock` - `JsonValue type = "text_editor_code_execution_view_result"` - `String content` - `FileType fileType` - `TEXT("text")` - `IMAGE("image")` - `PDF("pdf")` - `Optional numLines` - `Optional startLine` - `Optional totalLines` - `class TextEditorCodeExecutionCreateResultBlock` - `JsonValue type = "text_editor_code_execution_create_result"` - `boolean isFileUpdate` - `class TextEditorCodeExecutionStrReplaceResultBlock` - `JsonValue type = "text_editor_code_execution_str_replace_result"` - `Optional> lines` - `Optional newLines` - `Optional newStart` - `Optional oldLines` - `Optional oldStart` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ToolSearchToolResultBlock` - `JsonValue type = "tool_search_tool_result"` - `Content content` - `class ToolSearchToolResultError` - `JsonValue type = "tool_search_tool_result_error"` - `ToolSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `Optional errorMessage` - `class ToolSearchToolSearchResultBlock` - `JsonValue type = "tool_search_tool_search_result"` - `List toolReferences` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ContainerUploadBlock` Response model for a file uploaded to the container. - `JsonValue type = "container_upload"` - `String fileId` - `Optional diagnostics` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `Optional cacheMissReason` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `class CacheMissModelChanged` - `JsonValue type = "model_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissSystemChanged` - `JsonValue type = "system_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissToolsChanged` - `JsonValue type = "tools_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissMessagesChanged` - `JsonValue type = "messages_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissPreviousMessageNotFound` - `JsonValue type = "previous_message_not_found"` - `class CacheMissUnavailable` - `JsonValue type = "unavailable"` - `Model model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `CLAUDE_HAIKU_5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `CLAUDE_SONNET_5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `CLAUDE_FABLE_5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `CLAUDE_OPUS_5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `CLAUDE_MYTHOS_5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `CLAUDE_SONNET_5("claude-sonnet-5")` Efficient model for coding and agents - `CLAUDE_FABLE_5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `CLAUDE_MYTHOS_5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `CLAUDE_OPUS_5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `CLAUDE_SONNET_4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `CLAUDE_HAIKU_4_5("claude-haiku-4-5")` - `CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")` - `CLAUDE_OPUS_4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `CLAUDE_MYTHOS_PREVIEW("claude-mythos-preview")` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `CLAUDE_SONNET_4_5("claude-sonnet-4-5")` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `JsonValue role = "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `Optional stopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `JsonValue type = "refusal"` - `Optional category` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `CYBER("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `BIO("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FRONTIER_LLM("frontier_llm")` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `REASONING_EXTRACTION("reasoning_extraction")` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=java). - `GENERAL_HARMS("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `Optional explanation` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `Optional stopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations * `"model_context_window_exceeded"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `END_TURN("end_turn")` - `MAX_TOKENS("max_tokens")` - `STOP_SEQUENCE("stop_sequence")` - `TOOL_USE("tool_use")` - `PAUSE_TURN("pause_turn")` - `REFUSAL("refusal")` - `MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")` - `Optional stopSequence` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Usage usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `Optional cacheCreation` Breakdown of cached tokens by TTL - `long ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `long ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `Optional cacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `Optional cacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `Optional inferenceGeo` The geographic region where inference was performed for this request. - `long inputTokens` The number of input tokens which were used. minimum: 0 - `long outputTokens` The number of output tokens which were used. minimum: 0 - `Optional outputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `long thinkingTokens` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. minimum: 0 - `Optional serverToolUse` The number of server tool requests. - `long webFetchRequests` The number of web fetch tool requests. minimum: 0 - `long webSearchRequests` The number of web search tool requests. minimum: 0 - `Optional serviceTier` If the request used the priority, standard, or batch tier. - `STANDARD("standard")` - `PRIORITY("priority")` - `BATCH("batch")` - `Optional speed` The inference speed mode used for this request. - `STANDARD("standard")` - `FAST("fast")` - `class RawMessageDeltaEvent` - `JsonValue type = "message_delta"` - `Delta delta` - `Optional container` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `Optional stopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `Optional stopReason` - `Optional stopSequence` - `MessageDeltaUsage usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `Optional cacheCreationInputTokens` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `Optional cacheReadInputTokens` The cumulative number of input tokens read from the cache. minimum: 0 - `Optional inputTokens` The cumulative number of input tokens which were used. minimum: 0 - `long outputTokens` The cumulative number of output tokens which were used. - `Optional outputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `Optional serverToolUse` The number of server tool requests. - `class RawMessageStopEvent` - `JsonValue type = "message_stop"` - `class RawContentBlockStartEvent` - `JsonValue type = "content_block_start"` - `ContentBlock contentBlock` - `class TextBlock` - `class ThinkingBlock` - `class RedactedThinkingBlock` - `class ToolUseBlock` - `class ServerToolUseBlock` - `class WebSearchToolResultBlock` - `class WebFetchToolResultBlock` - `class CodeExecutionToolResultBlock` - `class BashCodeExecutionToolResultBlock` - `class TextEditorCodeExecutionToolResultBlock` - `class ToolSearchToolResultBlock` - `class ContainerUploadBlock` Response model for a file uploaded to the container. - `long index` - `class RawContentBlockDeltaEvent` - `JsonValue type = "content_block_delta"` - `RawContentBlockDelta delta` - `class TextDelta` - `JsonValue type = "text_delta"` - `String text` - `class InputJsonDelta` - `JsonValue type = "input_json_delta"` - `String partialJson` - `class CitationsDelta` - `JsonValue type = "citations_delta"` - `Citation citation` - `class CitationCharLocation` - `class CitationPageLocation` - `class CitationContentBlockLocation` - `class CitationsWebSearchResultLocation` - `class CitationsSearchResultLocation` - `class ThinkingDelta` - `JsonValue type = "thinking_delta"` - `String thinking` 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. - `class SignatureDelta` - `JsonValue type = "signature_delta"` - `String signature` 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. - `long index` - `class RawContentBlockStopEvent` - `JsonValue type = "content_block_stop"` - `long index` ### Redacted Thinking Block - `class RedactedThinkingBlock` - `JsonValue type = "redacted_thinking"` - `String data` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java#redacted-thinking-blocks) for details. ### Redacted Thinking Block Param - `class RedactedThinkingBlockParam` - `JsonValue type = "redacted_thinking"` - `String data` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. ### Refusal Stop Details - `class RefusalStopDetails` Structured information about a refusal. - `JsonValue type = "refusal"` - `Optional category` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `CYBER("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `BIO("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FRONTIER_LLM("frontier_llm")` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `REASONING_EXTRACTION("reasoning_extraction")` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=java). - `GENERAL_HARMS("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `Optional explanation` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. ### Search Result Block Param - `class SearchResultBlockParam` - `JsonValue type = "search_result"` - `List content` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional> citations` - `class CitationCharLocationParam` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endCharIndex` - `long startCharIndex` minimum: 0 - `class CitationPageLocationParam` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endPageNumber` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocationParam` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationWebSearchResultLocationParam` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` minLength: 1, maxLength: 512 - `String url` minLength: 1 - `class CitationSearchResultLocationParam` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `String source` - `String title` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` - `Optional enabled` ### Server Tool Caller - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Server Tool Caller 20260120 - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Server Tool Usage - `class ServerToolUsage` - `long webFetchRequests` The number of web fetch tool requests. minimum: 0 - `long webSearchRequests` The number of web search tool requests. minimum: 0 ### Server Tool Use Block - `class ServerToolUseBlock` - `JsonValue type = "server_tool_use"` - `String id` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input input` - `Name name` - `WEB_SEARCH("web_search")` - `WEB_FETCH("web_fetch")` - `CODE_EXECUTION("code_execution")` - `BASH_CODE_EXECUTION("bash_code_execution")` - `TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` ### Server Tool Use Block Param - `class ServerToolUseBlockParam` - `JsonValue type = "server_tool_use"` - `String id` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input input` - `Name name` - `WEB_SEARCH("web_search")` - `WEB_FETCH("web_fetch")` - `CODE_EXECUTION("code_execution")` - `BASH_CODE_EXECUTION("bash_code_execution")` - `TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Signature Delta - `class SignatureDelta` - `JsonValue type = "signature_delta"` - `String signature` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. ### Skill Params - `class SkillParams` Specification for a skill to be loaded in a container (request model). - `Type type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `ANTHROPIC("anthropic")` - `CUSTOM("custom")` - `String skillId` Skill ID minLength: 1, maxLength: 64 - `Optional version` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 ### Stop Reason - `enum StopReason` - `END_TURN("end_turn")` - `MAX_TOKENS("max_tokens")` - `STOP_SEQUENCE("stop_sequence")` - `TOOL_USE("tool_use")` - `PAUSE_TURN("pause_turn")` - `REFUSAL("refusal")` - `MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")` ### Text Block - `class TextBlock` - `JsonValue type = "text"` - `Optional> citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class CitationCharLocation` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endCharIndex` - `Optional fileId` - `long startCharIndex` minimum: 0 - `class CitationPageLocation` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endPageNumber` - `Optional fileId` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocation` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `Optional fileId` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationsWebSearchResultLocation` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` maxLength: 512 - `String url` - `class CitationsSearchResultLocation` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `String text` ### Text Block Param - `class TextBlockParam` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional> citations` - `class CitationCharLocationParam` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endCharIndex` - `long startCharIndex` minimum: 0 - `class CitationPageLocationParam` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endPageNumber` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocationParam` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationWebSearchResultLocationParam` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` minLength: 1, maxLength: 512 - `String url` minLength: 1 - `class CitationSearchResultLocationParam` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` ### Text Citation - `class TextCitation: union` - `class CitationCharLocation` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endCharIndex` - `Optional fileId` - `long startCharIndex` minimum: 0 - `class CitationPageLocation` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endPageNumber` - `Optional fileId` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocation` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `Optional fileId` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationsWebSearchResultLocation` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` maxLength: 512 - `String url` - `class CitationsSearchResultLocation` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` ### Text Citation Param - `class TextCitationParam: union` - `class CitationCharLocationParam` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endCharIndex` - `long startCharIndex` minimum: 0 - `class CitationPageLocationParam` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endPageNumber` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocationParam` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationWebSearchResultLocationParam` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` minLength: 1, maxLength: 512 - `String url` minLength: 1 - `class CitationSearchResultLocationParam` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` ### Text Delta - `class TextDelta` - `JsonValue type = "text_delta"` - `String text` ### Text Editor Code Execution Create Result Block - `class TextEditorCodeExecutionCreateResultBlock` - `JsonValue type = "text_editor_code_execution_create_result"` - `boolean isFileUpdate` ### Text Editor Code Execution Create Result Block Param - `class TextEditorCodeExecutionCreateResultBlockParam` - `JsonValue type = "text_editor_code_execution_create_result"` - `boolean isFileUpdate` ### Text Editor Code Execution Str Replace Result Block - `class TextEditorCodeExecutionStrReplaceResultBlock` - `JsonValue type = "text_editor_code_execution_str_replace_result"` - `Optional> lines` - `Optional newLines` - `Optional newStart` - `Optional oldLines` - `Optional oldStart` ### Text Editor Code Execution Str Replace Result Block Param - `class TextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonValue type = "text_editor_code_execution_str_replace_result"` - `Optional> lines` - `Optional newLines` - `Optional newStart` - `Optional oldLines` - `Optional oldStart` ### Text Editor Code Execution Tool Result Block - `class TextEditorCodeExecutionToolResultBlock` - `JsonValue type = "text_editor_code_execution_tool_result"` - `Content content` - `class TextEditorCodeExecutionToolResultError` - `JsonValue type = "text_editor_code_execution_tool_result_error"` - `TextEditorCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` - `Optional errorMessage` - `class TextEditorCodeExecutionViewResultBlock` - `JsonValue type = "text_editor_code_execution_view_result"` - `String content` - `FileType fileType` - `TEXT("text")` - `IMAGE("image")` - `PDF("pdf")` - `Optional numLines` - `Optional startLine` - `Optional totalLines` - `class TextEditorCodeExecutionCreateResultBlock` - `JsonValue type = "text_editor_code_execution_create_result"` - `boolean isFileUpdate` - `class TextEditorCodeExecutionStrReplaceResultBlock` - `JsonValue type = "text_editor_code_execution_str_replace_result"` - `Optional> lines` - `Optional newLines` - `Optional newStart` - `Optional oldLines` - `Optional oldStart` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Text Editor Code Execution Tool Result Block Param - `class TextEditorCodeExecutionToolResultBlockParam` - `JsonValue type = "text_editor_code_execution_tool_result"` - `Content content` - `class TextEditorCodeExecutionToolResultErrorParam` - `JsonValue type = "text_editor_code_execution_tool_result_error"` - `TextEditorCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` - `Optional errorMessage` - `class TextEditorCodeExecutionViewResultBlockParam` - `JsonValue type = "text_editor_code_execution_view_result"` - `String content` - `FileType fileType` - `TEXT("text")` - `IMAGE("image")` - `PDF("pdf")` - `Optional numLines` - `Optional startLine` - `Optional totalLines` - `class TextEditorCodeExecutionCreateResultBlockParam` - `JsonValue type = "text_editor_code_execution_create_result"` - `boolean isFileUpdate` - `class TextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonValue type = "text_editor_code_execution_str_replace_result"` - `Optional> lines` - `Optional newLines` - `Optional newStart` - `Optional oldLines` - `Optional oldStart` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` ### Text Editor Code Execution Tool Result Error - `class TextEditorCodeExecutionToolResultError` - `JsonValue type = "text_editor_code_execution_tool_result_error"` - `TextEditorCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` - `Optional errorMessage` ### Text Editor Code Execution Tool Result Error Code - `enum TextEditorCodeExecutionToolResultErrorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` ### Text Editor Code Execution Tool Result Error Param - `class TextEditorCodeExecutionToolResultErrorParam` - `JsonValue type = "text_editor_code_execution_tool_result_error"` - `TextEditorCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` - `Optional errorMessage` ### Text Editor Code Execution View Result Block - `class TextEditorCodeExecutionViewResultBlock` - `JsonValue type = "text_editor_code_execution_view_result"` - `String content` - `FileType fileType` - `TEXT("text")` - `IMAGE("image")` - `PDF("pdf")` - `Optional numLines` - `Optional startLine` - `Optional totalLines` ### Text Editor Code Execution View Result Block Param - `class TextEditorCodeExecutionViewResultBlockParam` - `JsonValue type = "text_editor_code_execution_view_result"` - `String content` - `FileType fileType` - `TEXT("text")` - `IMAGE("image")` - `PDF("pdf")` - `Optional numLines` - `Optional startLine` - `Optional totalLines` ### Thinking Block - `class ThinkingBlock` - `JsonValue type = "thinking"` - `String signature` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java) for details. - `String thinking` The text of Claude's thinking process for this block. ### Thinking Block Param - `class ThinkingBlockParam` - `JsonValue type = "thinking"` - `String signature` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `String thinking` The `thinking` text of this block as returned by the API. ### Thinking Config Adaptive - `class ThinkingConfigAdaptive` - `JsonValue type = "adaptive"` - `Optional display` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=java#controlling-thinking-display). - `SUMMARIZED("summarized")` - `OMITTED("omitted")` ### Thinking Config Between Tools - `class ThinkingConfigBetweenTools` - `JsonValue type = "between_tools"` ### Thinking Config Disabled - `class ThinkingConfigDisabled` - `JsonValue type = "disabled"` ### Thinking Config Enabled - `class ThinkingConfigEnabled` - `JsonValue type = "enabled"` - `long budgetTokens` Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java) for details. minimum: 1024 - `Optional display` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=java#controlling-thinking-display). - `SUMMARIZED("summarized")` - `OMITTED("omitted")` ### Thinking Config Param - `class ThinkingConfigParam: union` Configuration for Claude's thinking. With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit. Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=java#configuring-thinking) for each model's behavior. - `class ThinkingConfigEnabled` - `JsonValue type = "enabled"` - `long budgetTokens` Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java) for details. minimum: 1024 - `Optional display` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=java#controlling-thinking-display). - `SUMMARIZED("summarized")` - `OMITTED("omitted")` - `class ThinkingConfigDisabled` - `JsonValue type = "disabled"` - `class ThinkingConfigBetweenTools` - `JsonValue type = "between_tools"` - `class ThinkingConfigAdaptive` - `JsonValue type = "adaptive"` - `Optional display` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=java#controlling-thinking-display). - `SUMMARIZED("summarized")` - `OMITTED("omitted")` ### Thinking Delta - `class ThinkingDelta` - `JsonValue type = "thinking_delta"` - `String thinking` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. ### Tool - `class Tool` - `Optional type` - `InputSchema inputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `JsonValue type = "object"` - `Optional properties` - `Optional> required` - `String name` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional description` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `Optional eagerInputStreaming` 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. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs ### Tool Bash 20250124 - `class ToolBash20250124` - `JsonValue type = "bash_20250124"` - `JsonValue name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs ### Tool Choice - `class ToolChoice: union` 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. - `class ToolChoiceAuto` The model will automatically decide whether to use tools. - `JsonValue type = "auto"` - `Optional disableParallelToolUse` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `class ToolChoiceAny` The model will use any available tools. - `JsonValue type = "any"` - `Optional disableParallelToolUse` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `class ToolChoiceTool` The model will use the specified tool with `tool_choice.name`. - `JsonValue type = "tool"` - `String name` The name of the tool to use. - `Optional disableParallelToolUse` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `class ToolChoiceNone` The model will not be allowed to use tools. - `JsonValue type = "none"` ### Tool Choice Any - `class ToolChoiceAny` The model will use any available tools. - `JsonValue type = "any"` - `Optional disableParallelToolUse` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. ### Tool Choice Auto - `class ToolChoiceAuto` The model will automatically decide whether to use tools. - `JsonValue type = "auto"` - `Optional disableParallelToolUse` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. ### Tool Choice None - `class ToolChoiceNone` The model will not be allowed to use tools. - `JsonValue type = "none"` ### Tool Choice Tool - `class ToolChoiceTool` The model will use the specified tool with `tool_choice.name`. - `JsonValue type = "tool"` - `String name` The name of the tool to use. - `Optional disableParallelToolUse` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. ### Tool Reference Block - `class ToolReferenceBlock` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ ### Tool Reference Block Param - `class ToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` ### Tool Result Block Param - `class ToolResultBlockParam` - `JsonValue type = "tool_result"` - `String toolUseId` pattern: ^[a-zA-Z0-9_-]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional content` - `String` - `List` - `class TextBlockParam` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional> citations` - `class CitationCharLocationParam` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endCharIndex` - `long startCharIndex` minimum: 0 - `class CitationPageLocationParam` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endPageNumber` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocationParam` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationWebSearchResultLocationParam` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` minLength: 1, maxLength: 512 - `String url` minLength: 1 - `class CitationSearchResultLocationParam` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `class ImageBlockParam` - `JsonValue type = "image"` - `Source source` - `class Base64ImageSource` - `JsonValue type = "base64"` - `String data` format: byte - `MediaType mediaType` - `IMAGE_JPEG("image/jpeg")` - `IMAGE_PNG("image/png")` - `IMAGE_GIF("image/gif")` - `IMAGE_WEBP("image/webp")` - `class UrlImageSource` - `JsonValue type = "url"` - `String url` - `class FileImageSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional transformations` 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. - `Optional oversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `DOWNSIZE("downsize")` - `ERROR("error")` - `class SearchResultBlockParam` - `JsonValue type = "search_result"` - `List content` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional> citations` - `String source` - `String title` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` - `Optional enabled` - `class DocumentBlockParam` - `JsonValue type = "document"` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `class ContentBlockSource` - `JsonValue type = "content"` - `Content content` - `String` - `List` - `class TextBlockParam` - `class ImageBlockParam` - `class UrlPdfSource` - `JsonValue type = "url"` - `String url` - `class FileDocumentSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` - `Optional context` minLength: 1 - `Optional title` minLength: 1, maxLength: 500 - `class ToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class BrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonValue type = "browser_state"` - `List tabs` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `String tabId` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional> stateChanges` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `class BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonValue type = "tab_opened"` - `String tabId` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonValue type = "download_started"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonValue type = "download_completed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional sizeBytes` The completed download's size. minimum: 0 - `class BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonValue type = "download_failed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional isError` - `Optional toolsetName` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ ### Tool Search Tool Bm25 20251119 - `class ToolSearchToolBm25_20251119` - `Type type` - `TOOL_SEARCH_TOOL_BM25_20251119("tool_search_tool_bm25_20251119")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `JsonValue name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs ### Tool Search Tool Regex 20251119 - `class ToolSearchToolRegex20251119` - `Type type` - `TOOL_SEARCH_TOOL_REGEX_20251119("tool_search_tool_regex_20251119")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `JsonValue name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs ### Tool Search Tool Result Block - `class ToolSearchToolResultBlock` - `JsonValue type = "tool_search_tool_result"` - `Content content` - `class ToolSearchToolResultError` - `JsonValue type = "tool_search_tool_result_error"` - `ToolSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `Optional errorMessage` - `class ToolSearchToolSearchResultBlock` - `JsonValue type = "tool_search_tool_search_result"` - `List toolReferences` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Tool Search Tool Result Block Param - `class ToolSearchToolResultBlockParam` - `JsonValue type = "tool_search_tool_result"` - `Content content` - `class ToolSearchToolResultErrorParam` - `JsonValue type = "tool_search_tool_result_error"` - `ToolSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `Optional errorMessage` - `class ToolSearchToolSearchResultBlockParam` - `JsonValue type = "tool_search_tool_search_result"` - `List toolReferences` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. ### Tool Search Tool Result Error - `class ToolSearchToolResultError` - `JsonValue type = "tool_search_tool_result_error"` - `ToolSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `Optional errorMessage` ### Tool Search Tool Result Error Code - `enum ToolSearchToolResultErrorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` ### Tool Search Tool Result Error Param - `class ToolSearchToolResultErrorParam` - `JsonValue type = "tool_search_tool_result_error"` - `ToolSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `Optional errorMessage` ### Tool Search Tool Search Result Block - `class ToolSearchToolSearchResultBlock` - `JsonValue type = "tool_search_tool_search_result"` - `List toolReferences` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ ### Tool Search Tool Search Result Block Param - `class ToolSearchToolSearchResultBlockParam` - `JsonValue type = "tool_search_tool_search_result"` - `List toolReferences` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` ### Tool Text Editor 20250124 - `class ToolTextEditor20250124` - `JsonValue type = "text_editor_20250124"` - `JsonValue name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs ### Tool Text Editor 20250429 - `class ToolTextEditor20250429` - `JsonValue type = "text_editor_20250429"` - `JsonValue name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs ### Tool Text Editor 20250728 - `class ToolTextEditor20250728` - `JsonValue type = "text_editor_20250728"` - `JsonValue name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional maxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs ### Tool Union - `class ToolUnion: union` - `class Tool` - `Optional type` - `InputSchema inputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `JsonValue type = "object"` - `Optional properties` - `Optional> required` - `String name` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional description` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `Optional eagerInputStreaming` 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. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolBash20250124` - `JsonValue type = "bash_20250124"` - `JsonValue name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20250522` - `JsonValue type = "code_execution_20250522"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20250825` - `JsonValue type = "code_execution_20250825"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `JsonValue type = "code_execution_20260120"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonValue type = "code_execution_20260521"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class BrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonValue type = "browser_toolset_20260801"` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Optional type` `type`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional closeTab` `close_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional doubleClick` `double_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional fileUpload` `file_upload`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional find` `find`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional formInput` `form_input`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional getPageText` `get_page_text`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional holdKey` `hold_key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional hover` `hover`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional javascriptExec` `javascript_exec`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional key` `key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClick` `left_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClickDrag` `left_click_drag`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseDown` `left_mouse_down`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseUp` `left_mouse_up`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional listTabs` `list_tabs`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional middleClick` `middle_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional mouseMove` `mouse_move`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional navigate` `navigate`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional newTab` `new_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readConsole` `read_console`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readNetwork` `read_network`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readPage` `read_page`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional rightClick` `right_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional screenshot` `screenshot`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scroll` `scroll`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scrollTo` `scroll_to`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional switchTab` `switch_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional tripleClick` `triple_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional wait` `wait`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional zoom` `zoom`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class MemoryTool20250818` - `JsonValue type = "memory_20250818"` - `JsonValue name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonValue type = "computer_toolset_20260801"` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Optional type` `type`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional cursorPosition` `cursor_position`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional doubleClick` `double_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional holdKey` `hold_key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional key` `key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClick` `left_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClickDrag` `left_click_drag`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseDown` `left_mouse_down`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseUp` `left_mouse_up`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional middleClick` `middle_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional mouseMove` `mouse_move`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional rightClick` `right_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional screenshot` `screenshot`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scroll` `scroll`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional tripleClick` `triple_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional wait` `wait`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional zoom` `zoom`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class ToolTextEditor20250124` - `JsonValue type = "text_editor_20250124"` - `JsonValue name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolTextEditor20250429` - `JsonValue type = "text_editor_20250429"` - `JsonValue name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolTextEditor20250728` - `JsonValue type = "text_editor_20250728"` - `JsonValue name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional maxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class WebSearchTool20250305` - `JsonValue type = "web_search_20250305"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonValue type = "approximate"` - `Optional city` The city of the user. minLength: 1, maxLength: 255 - `Optional country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Optional region` The region of the user. minLength: 1, maxLength: 255 - `Optional timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class WebFetchTool20250910` - `JsonValue type = "web_fetch_20250910"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional enabled` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional clientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonValue type = "all"` - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonValue type = "none"` - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonValue type = "only"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonValue type = "except"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `Optional serverToolResults` 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. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Optional userInput` Whether URLs in user messages are fetchable: "all" or "none". - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class WebSearchTool20260209` - `JsonValue type = "web_search_20260209"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `class WebFetchTool20260209` - `JsonValue type = "web_fetch_20260209"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class WebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonValue type = "web_fetch_20260309"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional useCache` 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. - `class WebSearchTool20260318` - `JsonValue type = "web_search_20260318"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional responseInclusion` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `FULL("full")` - `EXCLUDED("excluded")` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `class WebFetchTool20260318` - `JsonValue type = "web_fetch_20260318"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional responseInclusion` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `FULL("full")` - `EXCLUDED("excluded")` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional useCache` 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. - `class ToolSearchToolBm25_20251119` - `Type type` - `TOOL_SEARCH_TOOL_BM25_20251119("tool_search_tool_bm25_20251119")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `JsonValue name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolSearchToolRegex20251119` - `Type type` - `TOOL_SEARCH_TOOL_REGEX_20251119("tool_search_tool_regex_20251119")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `JsonValue name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs ### Tool Use Block - `class ToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input input` - `String name` minLength: 1 - `Optional toolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ ### Tool Use Block Param - `class ToolUseBlockParam` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `Input input` - `String name` minLength: 1, maxLength: 200 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional toolsetName` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ ### Tool Use Caller - `class ToolUseCaller: union` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Toolset Tool Use Block - `class ToolsetToolUseBlock: union` - `class BrowserToolUseBlock: union` - `class BrowserNavigateToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BrowserNavigateInput input` Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://). - `String url` The URL to navigate to, or "back" / "forward" / "reload" for history navigation. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "navigate"` - `JsonValue toolsetName = "browser"` - `class BrowserListTabsToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserListTabsInput input` List all open tabs with each tab's tab_id, title, and URL. - `JsonValue name = "list_tabs"` - `JsonValue toolsetName = "browser"` - `class BrowserNewTabToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserNewTabInput input` Open a new empty tab and return its tab_id. - `JsonValue name = "new_tab"` - `JsonValue toolsetName = "browser"` - `class BrowserSwitchTabToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserSwitchTabInput input` Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to. - `String tabId` The tab to switch to. - `JsonValue name = "switch_tab"` - `JsonValue toolsetName = "browser"` - `class BrowserCloseTabToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserCloseTabInput input` Close the tab with the given tab_id. - `String tabId` The tab to close. - `JsonValue name = "close_tab"` - `JsonValue toolsetName = "browser"` - `class BrowserReadPageToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserReadPageInput input` Return a structured accessibility tree of the page (or the subtree rooted at `ref`), with element references like [ref_7] that can be used as targets on later actions. Output is capped at 50,000 characters — narrow with `ref` or a smaller `depth` when exceeded. - `Optional depth` Maximum tree depth. Default 15. minimum: 1 - `Optional filter` Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements. - `ALL("all")` - `INTERACTIVE("interactive")` - `Optional ref` Element reference to read a subtree from. Omit to read from the page root. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "read_page"` - `JsonValue toolsetName = "browser"` - `class BrowserGetPageTextToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserGetPageTextInput input` Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "get_page_text"` - `JsonValue toolsetName = "browser"` - `class BrowserReadConsoleToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserReadConsoleInput input` Return console output (log entries, errors, warnings) accumulated since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "read_console"` - `JsonValue toolsetName = "browser"` - `class BrowserReadNetworkToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserReadNetworkInput input` Return the network requests (method, URL, status, MIME type, timing) recorded since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "read_network"` - `JsonValue toolsetName = "browser"` - `class BrowserFindToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserFindInput input` Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references. - `String query` Natural-language description of the element(s) to find. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "find"` - `JsonValue toolsetName = "browser"` - `class BrowserFormInputToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserFormInputInput input` Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects. - `BrowserRefTarget target` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `JsonValue type = "ref"` - `String ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `BrowserFormInputValue value` The value to set. - `String` - `double` - `boolean` - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "form_input"` - `JsonValue toolsetName = "browser"` - `class BrowserFileUploadToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserFileUploadInput input` Set the value of a file-input element to one or more files. The target must be an element reference; at least one of paths or document_ids is required. - `BrowserRefTarget target` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `Optional> documentIds` References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem. minItems: 1 - `Optional> paths` File paths on the browser executor's filesystem. minItems: 1 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "file_upload"` - `JsonValue toolsetName = "browser"` - `class BrowserScrollToToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserScrollToInput input` Scroll an element into view. - `BrowserRefTarget target` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "scroll_to"` - `JsonValue toolsetName = "browser"` - `class BrowserScreenshotToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserScreenshotInput input` Capture the current browser viewport. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "screenshot"` - `JsonValue toolsetName = "browser"` - `class BrowserZoomToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserZoomInput input` Return a cropped screenshot of the given viewport region, scaled up for closer inspection — useful for small icons, buttons, or text. Coordinates are in the same viewport-pixel space as a full screenshot. - `List region` [x0, y0, x1, y1] in viewport pixels. minItems: 4, maxItems: 4 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "zoom"` - `JsonValue toolsetName = "browser"` - `class BrowserLeftClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserLeftClickInput input` Left-click at a viewport coordinate or on an element by reference. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `class BrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonValue type = "coordinate"` - `long x` Pixels from the left edge of the viewport. minimum: 0 - `long y` Pixels from the top edge of the viewport. minimum: 0 - `class BrowserRefTarget` An element on the page, identified by a reference from a prior `read_page` or `find` result. References are scoped to the tab that produced them and become stale after navigation or a major re-render. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "left_click"` - `JsonValue toolsetName = "browser"` - `class BrowserRightClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserRightClickInput input` Right-click at a viewport coordinate or on an element by reference. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "right_click"` - `JsonValue toolsetName = "browser"` - `class BrowserMiddleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserMiddleClickInput input` Middle-click at a viewport coordinate or on an element by reference. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "middle_click"` - `JsonValue toolsetName = "browser"` - `class BrowserDoubleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserDoubleClickInput input` Double left-click at a viewport coordinate or on an element by reference. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "double_click"` - `JsonValue toolsetName = "browser"` - `class BrowserTripleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserTripleClickInput input` Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph). - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `Optional modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "triple_click"` - `JsonValue toolsetName = "browser"` - `class BrowserHoverToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserHoverInput input` Move the cursor to a coordinate or element without clicking. - `BrowserClickTarget target` Where to act: either a viewport coordinate or an element reference. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "hover"` - `JsonValue toolsetName = "browser"` - `class BrowserLeftClickDragToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserLeftClickDragInput input` Press at `from`, drag to `target`, release. Both must be coordinate targets. - `BrowserCoordinateTarget from` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "left_click_drag"` - `JsonValue toolsetName = "browser"` - `class BrowserLeftMouseDownToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserLeftMouseDownInput input` Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag. - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "left_mouse_down"` - `JsonValue toolsetName = "browser"` - `class BrowserLeftMouseUpToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserLeftMouseUpInput input` Release the left mouse button at a viewport coordinate. - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "left_mouse_up"` - `JsonValue toolsetName = "browser"` - `class BrowserMouseMoveToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserMouseMoveInput input` Move the pointer to a viewport coordinate without clicking. - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "mouse_move"` - `JsonValue toolsetName = "browser"` - `class BrowserScrollToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserScrollInput input` Scroll at a viewport position. `target` must be a coordinate target. - `BrowserScrollDirection scrollDirection` - `UP("up")` - `DOWN("down")` - `LEFT("left")` - `RIGHT("right")` - `BrowserCoordinateTarget target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Optional scrollAmount` Scroll-wheel notches (1–10). Default 3. minimum: 1, maximum: 10 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "scroll"` - `JsonValue toolsetName = "browser"` - `class BrowserTypeToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserTypeInput input` Type a literal string at the current focus. - `String text` The text to type. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "type"` - `JsonValue toolsetName = "browser"` - `class BrowserKeyToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserKeyInput input` Press a key or key chord. Use "+" to combine modifiers with a key (e.g. "ctrl+a", "cmd+shift+p") and space to sequence presses (e.g. "Backspace Backspace Delete"). Common names like "Return", "Tab", "Escape", "BackSpace" are supported. - `String text` The key, chord, or space-separated sequence to press. - `Optional repeat` Number of times to repeat. Default 1. minimum: 1, maximum: 100 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "key"` - `JsonValue toolsetName = "browser"` - `class BrowserHoldKeyToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserHoldKeyInput input` Hold a key or key chord down for a duration, then release it. Uses the same key names and "+" chord syntax as the key action. - `double duration` Seconds to hold the key down (maximum 30). minimum: 0, maximum: 30 - `String text` The key or chord to hold. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "hold_key"` - `JsonValue toolsetName = "browser"` - `class BrowserWaitToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserWaitInput input` Pause for the given duration. - `double duration` Seconds to wait (maximum 30). minimum: 0, maximum: 30 - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "wait"` - `JsonValue toolsetName = "browser"` - `class BrowserJavascriptExecToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `BrowserJavascriptExecInput input` Execute JavaScript in the page context and return the value of the last expression. The code runs with access to the DOM, `window`, and page variables. Write the expression you want evaluated — do NOT use `return`. - `String text` JavaScript to execute in the page context. - `Optional tabId` Tab to act on. Defaults to the active tab when omitted. - `JsonValue name = "javascript_exec"` - `JsonValue toolsetName = "browser"` - `class ComputerToolUseBlock: union` - `class ComputerKeyToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerKeyInput input` Press a key or key-combination on the keyboard. Use "+" to combine modifiers with a key (e.g. "ctrl+s", "alt+Tab", "ctrl+shift+Escape"). Key names are case-insensitive; common names like "Return", "Tab", "Escape", "Up", "Down", "Left", "Right", "Home", "End", "Page_Up", "Page_Down", "Delete", "BackSpace" are supported. - `String text` The key or key-combination to press. - `Optional repeat` Number of times to repeat the key press. Default is 1. minimum: 1, maximum: 100 - `JsonValue name = "key"` - `JsonValue toolsetName = "computer"` - `class ComputerHoldKeyToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerHoldKeyInput input` Hold down a key or key-combination for a specified duration. Uses the same key syntax as `key`. - `long duration` Duration to hold the key, in seconds. maximum: 300 - `String text` The key or key-combination to hold. - `JsonValue name = "hold_key"` - `JsonValue toolsetName = "computer"` - `class ComputerTypeToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerTypeInput input` Type a string of text on the keyboard. - `String text` The text to type. - `JsonValue name = "type"` - `JsonValue toolsetName = "computer"` - `class ComputerCursorPositionToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerCursorPositionInput input` Get the current (x, y) pixel coordinate of the cursor. - `JsonValue name = "cursor_position"` - `JsonValue toolsetName = "computer"` - `class ComputerMouseMoveToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerMouseMoveInput input` Move the cursor to a specified (x, y) pixel coordinate. Use this ONLY to hover without clicking; otherwise use a click action directly. - `List coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `JsonValue name = "mouse_move"` - `JsonValue toolsetName = "computer"` - `class ComputerLeftMouseDownToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerLeftMouseDownInput input` Press and hold the left mouse button at the current cursor position. - `JsonValue name = "left_mouse_down"` - `JsonValue toolsetName = "computer"` - `class ComputerLeftMouseUpToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerLeftMouseUpInput input` Release the left mouse button. - `JsonValue name = "left_mouse_up"` - `JsonValue toolsetName = "computer"` - `class ComputerLeftClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerLeftClickInput input` Click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "left_click"` - `JsonValue toolsetName = "computer"` - `class ComputerLeftClickDragToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerLeftClickDragInput input` Click and drag the cursor from `start_coordinate` to `coordinate`. - `List coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `List startCoordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "left_click_drag"` - `JsonValue toolsetName = "computer"` - `class ComputerRightClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerRightClickInput input` Click the right mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "right_click"` - `JsonValue toolsetName = "computer"` - `class ComputerMiddleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerMiddleClickInput input` Click the middle mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "middle_click"` - `JsonValue toolsetName = "computer"` - `class ComputerDoubleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerDoubleClickInput input` Double-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "double_click"` - `JsonValue toolsetName = "computer"` - `class ComputerTripleClickToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerTripleClickInput input` Triple-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "triple_click"` - `JsonValue toolsetName = "computer"` - `class ComputerScrollToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerScrollInput input` Scroll the screen at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. Do NOT use PageUp/PageDown to scroll. - `long scrollAmount` Number of 'clicks' of the scroll wheel. - `ComputerScrollDirection scrollDirection` - `UP("up")` - `DOWN("down")` - `LEFT("left")` - `RIGHT("right")` - `Optional> coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Optional text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonValue name = "scroll"` - `JsonValue toolsetName = "computer"` - `class ComputerWaitToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerWaitInput input` Wait for a specified duration. - `long duration` Duration to wait, in seconds. maximum: 300 - `JsonValue name = "wait"` - `JsonValue toolsetName = "computer"` - `class ComputerScreenshotToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerScreenshotInput input` Take a screenshot of the screen. - `JsonValue name = "screenshot"` - `JsonValue toolsetName = "computer"` - `class ComputerZoomToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `ToolUseCaller caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `ComputerZoomInput input` Take a screenshot of a rectangular region. Region coordinates are in the full-screenshot space (not physical display pixels). The crop is scaled up to fill the image budget so fine details become legible. - `List region` (x0, y0, x1, y1): The region to capture. minItems: 4, maxItems: 4 - `JsonValue name = "zoom"` - `JsonValue toolsetName = "computer"` - `class ToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `Input input` - `String name` minLength: 1 - `Optional toolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ ### URL Image Source - `class UrlImageSource` - `JsonValue type = "url"` - `String url` ### URL PDF Source - `class UrlPdfSource` - `JsonValue type = "url"` - `String url` ### Usage - `class Usage` - `Optional cacheCreation` Breakdown of cached tokens by TTL - `long ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `long ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `Optional cacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `Optional cacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `Optional inferenceGeo` The geographic region where inference was performed for this request. - `long inputTokens` The number of input tokens which were used. minimum: 0 - `long outputTokens` The number of output tokens which were used. minimum: 0 - `Optional outputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `long thinkingTokens` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. minimum: 0 - `Optional serverToolUse` The number of server tool requests. - `long webFetchRequests` The number of web fetch tool requests. minimum: 0 - `long webSearchRequests` The number of web search tool requests. minimum: 0 - `Optional serviceTier` If the request used the priority, standard, or batch tier. - `STANDARD("standard")` - `PRIORITY("priority")` - `BATCH("batch")` - `Optional speed` The inference speed mode used for this request. - `STANDARD("standard")` - `FAST("fast")` ### User Location - `class UserLocation` - `JsonValue type = "approximate"` - `Optional city` The city of the user. minLength: 1, maxLength: 255 - `Optional country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Optional region` The region of the user. minLength: 1, maxLength: 255 - `Optional timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 ### Web Fetch Block - `class WebFetchBlock` - `JsonValue type = "web_fetch_result"` - `DocumentBlock content` - `JsonValue type = "document"` - `Optional citations` Citation configuration for the document - `boolean enabled` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `Optional title` The title of the document - `Optional retrievedAt` ISO 8601 timestamp when the content was retrieved - `String url` Fetched content URL ### Web Fetch Block Param - `class WebFetchBlockParam` - `JsonValue type = "web_fetch_result"` - `DocumentBlockParam content` - `JsonValue type = "document"` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `class ContentBlockSource` - `JsonValue type = "content"` - `Content content` - `String` - `List` - `class TextBlockParam` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional> citations` - `class CitationCharLocationParam` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endCharIndex` - `long startCharIndex` minimum: 0 - `class CitationPageLocationParam` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endPageNumber` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocationParam` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationWebSearchResultLocationParam` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` minLength: 1, maxLength: 512 - `String url` minLength: 1 - `class CitationSearchResultLocationParam` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `class ImageBlockParam` - `JsonValue type = "image"` - `Source source` - `class Base64ImageSource` - `JsonValue type = "base64"` - `String data` format: byte - `MediaType mediaType` - `IMAGE_JPEG("image/jpeg")` - `IMAGE_PNG("image/png")` - `IMAGE_GIF("image/gif")` - `IMAGE_WEBP("image/webp")` - `class UrlImageSource` - `JsonValue type = "url"` - `String url` - `class FileImageSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional transformations` 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. - `Optional oversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `DOWNSIZE("downsize")` - `ERROR("error")` - `class UrlPdfSource` - `JsonValue type = "url"` - `String url` - `class FileDocumentSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` - `Optional enabled` - `Optional context` minLength: 1 - `Optional title` minLength: 1, maxLength: 500 - `String url` Fetched content URL - `Optional retrievedAt` ISO 8601 timestamp when the content was retrieved ### Web Fetch Tool 20250910 - `class WebFetchTool20250910` - `JsonValue type = "web_fetch_20250910"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional enabled` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional clientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonValue type = "all"` - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonValue type = "none"` - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonValue type = "only"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonValue type = "except"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `Optional serverToolResults` 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. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Optional userInput` Whether URLs in user messages are fetchable: "all" or "none". - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. ### Web Fetch Tool 20260209 - `class WebFetchTool20260209` - `JsonValue type = "web_fetch_20260209"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional enabled` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional clientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonValue type = "all"` - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonValue type = "none"` - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonValue type = "only"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonValue type = "except"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `Optional serverToolResults` 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. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Optional userInput` Whether URLs in user messages are fetchable: "all" or "none". - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. ### Web Fetch Tool 20260309 - `class WebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonValue type = "web_fetch_20260309"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional enabled` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional clientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonValue type = "all"` - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonValue type = "none"` - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonValue type = "only"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonValue type = "except"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `Optional serverToolResults` 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. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Optional userInput` Whether URLs in user messages are fetchable: "all" or "none". - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Optional useCache` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. ### Web Fetch Tool 20260318 - `class WebFetchTool20260318` - `JsonValue type = "web_fetch_20260318"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional enabled` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional responseInclusion` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `FULL("full")` - `EXCLUDED("excluded")` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional clientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonValue type = "all"` - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonValue type = "none"` - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonValue type = "only"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonValue type = "except"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `Optional serverToolResults` 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. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Optional userInput` Whether URLs in user messages are fetchable: "all" or "none". - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Optional useCache` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. ### Web Fetch Tool Result Block - `class WebFetchToolResultBlock` - `JsonValue type = "web_fetch_tool_result"` - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Content content` - `class WebFetchToolResultErrorBlock` - `JsonValue type = "web_fetch_tool_result_error"` - `WebFetchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` - `class WebFetchBlock` - `JsonValue type = "web_fetch_result"` - `DocumentBlock content` - `JsonValue type = "document"` - `Optional citations` Citation configuration for the document - `boolean enabled` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `Optional title` The title of the document - `Optional retrievedAt` ISO 8601 timestamp when the content was retrieved - `String url` Fetched content URL - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Web Fetch Tool Result Block Param - `class WebFetchToolResultBlockParam` - `JsonValue type = "web_fetch_tool_result"` - `Content content` - `class WebFetchToolResultErrorBlockParam` - `JsonValue type = "web_fetch_tool_result_error"` - `WebFetchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` - `class WebFetchBlockParam` - `JsonValue type = "web_fetch_result"` - `DocumentBlockParam content` - `JsonValue type = "document"` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `class ContentBlockSource` - `JsonValue type = "content"` - `Content content` - `String` - `List` - `class TextBlockParam` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional> citations` - `class CitationCharLocationParam` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endCharIndex` - `long startCharIndex` minimum: 0 - `class CitationPageLocationParam` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endPageNumber` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocationParam` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationWebSearchResultLocationParam` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` minLength: 1, maxLength: 512 - `String url` minLength: 1 - `class CitationSearchResultLocationParam` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `class ImageBlockParam` - `JsonValue type = "image"` - `Source source` - `class Base64ImageSource` - `JsonValue type = "base64"` - `String data` format: byte - `MediaType mediaType` - `IMAGE_JPEG("image/jpeg")` - `IMAGE_PNG("image/png")` - `IMAGE_GIF("image/gif")` - `IMAGE_WEBP("image/webp")` - `class UrlImageSource` - `JsonValue type = "url"` - `String url` - `class FileImageSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional transformations` 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. - `Optional oversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `DOWNSIZE("downsize")` - `ERROR("error")` - `class UrlPdfSource` - `JsonValue type = "url"` - `String url` - `class FileDocumentSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` - `Optional enabled` - `Optional context` minLength: 1 - `Optional title` minLength: 1, maxLength: 500 - `String url` Fetched content URL - `Optional retrievedAt` ISO 8601 timestamp when the content was retrieved - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Web Fetch Tool Result Error Block - `class WebFetchToolResultErrorBlock` - `JsonValue type = "web_fetch_tool_result_error"` - `WebFetchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` ### Web Fetch Tool Result Error Block Param - `class WebFetchToolResultErrorBlockParam` - `JsonValue type = "web_fetch_tool_result_error"` - `WebFetchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` ### Web Fetch Tool Result Error Code - `enum WebFetchToolResultErrorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` ### Web Fetch URL Source All - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonValue type = "all"` ### Web Fetch URL Source Except - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonValue type = "except"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` ### Web Fetch URL Source None - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonValue type = "none"` ### Web Fetch URL Source Only - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonValue type = "only"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` ### Web Fetch URL Source Tool Reference - `class WebFetchUrlSourceToolReference` One entry of a tool filter's `tools`: it must name a tool declared in this request's `tools[]`. - `JsonValue type = "tool_reference"` - `String name` ### Web Fetch URL Sources - `class WebFetchUrlSources` Which sources contribute to the set of URLs web fetch may fetch. Each key is a tagged variant: `user_input` is `all` or `none`; the two tool filters are `all`, `none`, `only` (only the named tools' results) or `except` (every result but the named tools'). A named tool must be declared in this request's `tools[]`. - `Optional clientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonValue type = "all"` - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonValue type = "none"` - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonValue type = "only"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonValue type = "except"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `Optional serverToolResults` 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. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Optional userInput` Whether URLs in user messages are fetchable: "all" or "none". - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. ### Web Search Result Block - `class WebSearchResultBlock` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `Optional pageAge` - `String title` - `String url` ### Web Search Result Block Param - `class WebSearchResultBlockParam` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `String title` - `String url` - `Optional pageAge` ### Web Search Tool 20250305 - `class WebSearchTool20250305` - `JsonValue type = "web_search_20250305"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonValue type = "approximate"` - `Optional city` The city of the user. minLength: 1, maxLength: 255 - `Optional country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Optional region` The region of the user. minLength: 1, maxLength: 255 - `Optional timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 ### Web Search Tool 20260209 - `class WebSearchTool20260209` - `JsonValue type = "web_search_20260209"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonValue type = "approximate"` - `Optional city` The city of the user. minLength: 1, maxLength: 255 - `Optional country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Optional region` The region of the user. minLength: 1, maxLength: 255 - `Optional timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 ### Web Search Tool 20260318 - `class WebSearchTool20260318` - `JsonValue type = "web_search_20260318"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional responseInclusion` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `FULL("full")` - `EXCLUDED("excluded")` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonValue type = "approximate"` - `Optional city` The city of the user. minLength: 1, maxLength: 255 - `Optional country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Optional region` The region of the user. minLength: 1, maxLength: 255 - `Optional timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 ### Web Search Tool Request Error - `class WebSearchToolRequestError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` ### Web Search Tool Result Block - `class WebSearchToolResultBlock` - `JsonValue type = "web_search_tool_result"` - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `WebSearchToolResultBlockContent content` - `class WebSearchToolResultError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` - `List` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `Optional pageAge` - `String title` - `String url` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Web Search Tool Result Block Content - `class WebSearchToolResultBlockContent: union` - `class WebSearchToolResultError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` - `List` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `Optional pageAge` - `String title` - `String url` ### Web Search Tool Result Block Param - `class WebSearchToolResultBlockParam` - `JsonValue type = "web_search_tool_result"` - `WebSearchToolResultBlockParamContent content` - `List` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `String title` - `String url` - `Optional pageAge` - `class WebSearchToolRequestError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Web Search Tool Result Block Param Content - `class WebSearchToolResultBlockParamContent: union` - `List` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `String title` - `String url` - `Optional pageAge` - `class WebSearchToolRequestError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` ### Web Search Tool Result Error - `class WebSearchToolResultError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` ### Web Search Tool Result Error Code - `enum WebSearchToolResultErrorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` ## Messages › Batches ### Create a Message Batch `MessageBatch messages().batches().create(params, requestOptions = RequestOptions.none())` **POST** `/v1/messages/batches` Send a batch of Message creation requests. The Message Batches API can be used to process multiple Messages API requests at once. Once a Message Batch is created, it begins processing immediately. Batches can take up to 24 hours to complete. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=java) #### Parameters - `BatchCreateParams params` - `Optional userProfileId` (header parameter) The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. - `List requests` List of requests for prompt completion. Each is an individual request to create a Message. minItems: 1, maxItems: 100000 - `String customId` Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order. Must be unique for each request within the Message Batch. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]{1,64}$ - `Params params` Messages API creation parameters for the individual request. See the [Messages API reference](https://platform.claude.com/docs/en/api/messages?sdk_languages=java) for full documentation on available parameters. - `long maxTokens` The maximum number of tokens to generate before stopping. Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=java) for details. minimum: 0 - `List messages` Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=java#prefill-not-supported). Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude, for models that support prefill: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=java). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=java#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `Content content` - `String` - `List` - `class TextBlockParam` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `JsonValue type = "ephemeral"` - `Optional ttl` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=java) for details. - `TTL_5M("5m")` - `TTL_1H("1h")` - `Optional> citations` - `class CitationCharLocationParam` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endCharIndex` - `long startCharIndex` minimum: 0 - `class CitationPageLocationParam` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endPageNumber` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocationParam` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` minLength: 1, maxLength: 500 - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationWebSearchResultLocationParam` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` minLength: 1, maxLength: 512 - `String url` minLength: 1 - `class CitationSearchResultLocationParam` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `class ImageBlockParam` - `JsonValue type = "image"` - `Source source` - `class Base64ImageSource` - `JsonValue type = "base64"` - `String data` format: byte - `MediaType mediaType` - `IMAGE_JPEG("image/jpeg")` - `IMAGE_PNG("image/png")` - `IMAGE_GIF("image/gif")` - `IMAGE_WEBP("image/webp")` - `class UrlImageSource` - `JsonValue type = "url"` - `String url` - `class FileImageSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional transformations` 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. - `Optional oversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `DOWNSIZE("downsize")` - `ERROR("error")` - `class DocumentBlockParam` - `JsonValue type = "document"` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `class ContentBlockSource` - `JsonValue type = "content"` - `Content content` - `String` - `List` - `class TextBlockParam` - `class ImageBlockParam` - `class UrlPdfSource` - `JsonValue type = "url"` - `String url` - `class FileDocumentSource` - `JsonValue type = "file"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` - `Optional enabled` - `Optional context` minLength: 1 - `Optional title` minLength: 1, maxLength: 500 - `class SearchResultBlockParam` - `JsonValue type = "search_result"` - `List content` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional> citations` - `String source` - `String title` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` - `class ThinkingBlockParam` - `JsonValue type = "thinking"` - `String signature` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `String thinking` The `thinking` text of this block as returned by the API. - `class RedactedThinkingBlockParam` - `JsonValue type = "redacted_thinking"` - `String data` 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. - `class ToolUseBlockParam` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `Input input` - `String name` minLength: 1, maxLength: 200 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional toolsetName` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ToolResultBlockParam` - `JsonValue type = "tool_result"` - `String toolUseId` pattern: ^[a-zA-Z0-9_-]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional content` - `String` - `List` - `class TextBlockParam` - `class ImageBlockParam` - `class SearchResultBlockParam` - `class DocumentBlockParam` - `class ToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class BrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonValue type = "browser_state"` - `List tabs` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `String tabId` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional> stateChanges` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `class BrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonValue type = "tab_opened"` - `String tabId` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonValue type = "download_started"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonValue type = "download_completed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional sizeBytes` The completed download's size. minimum: 0 - `class BrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonValue type = "download_failed"` - `String downloadId` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `String url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Optional isError` - `Optional toolsetName` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ServerToolUseBlockParam` - `JsonValue type = "server_tool_use"` - `String id` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input input` - `Name name` - `WEB_SEARCH("web_search")` - `WEB_FETCH("web_fetch")` - `CODE_EXECUTION("code_execution")` - `BASH_CODE_EXECUTION("bash_code_execution")` - `TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `class WebSearchToolResultBlockParam` - `JsonValue type = "web_search_tool_result"` - `WebSearchToolResultBlockParamContent content` - `List` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `String title` - `String url` - `Optional pageAge` - `class WebSearchToolRequestError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `class WebFetchToolResultBlockParam` - `JsonValue type = "web_fetch_tool_result"` - `Content content` - `class WebFetchToolResultErrorBlockParam` - `JsonValue type = "web_fetch_tool_result_error"` - `WebFetchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` - `class WebFetchBlockParam` - `JsonValue type = "web_fetch_result"` - `DocumentBlockParam content` - `String url` Fetched content URL - `Optional retrievedAt` ISO 8601 timestamp when the content was retrieved - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `class CodeExecutionToolResultBlockParam` - `JsonValue type = "code_execution_tool_result"` - `CodeExecutionToolResultBlockParamContent content` - `class CodeExecutionToolResultErrorParam` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `class CodeExecutionResultBlockParam` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `class EncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class BashCodeExecutionToolResultBlockParam` - `JsonValue type = "bash_code_execution_tool_result"` - `Content content` - `class BashCodeExecutionToolResultErrorParam` - `JsonValue type = "bash_code_execution_tool_result_error"` - `BashCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` - `class BashCodeExecutionResultBlockParam` - `JsonValue type = "bash_code_execution_result"` - `List content` - `JsonValue type = "bash_code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class TextEditorCodeExecutionToolResultBlockParam` - `JsonValue type = "text_editor_code_execution_tool_result"` - `Content content` - `class TextEditorCodeExecutionToolResultErrorParam` - `JsonValue type = "text_editor_code_execution_tool_result_error"` - `TextEditorCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` - `Optional errorMessage` - `class TextEditorCodeExecutionViewResultBlockParam` - `JsonValue type = "text_editor_code_execution_view_result"` - `String content` - `FileType fileType` - `TEXT("text")` - `IMAGE("image")` - `PDF("pdf")` - `Optional numLines` - `Optional startLine` - `Optional totalLines` - `class TextEditorCodeExecutionCreateResultBlockParam` - `JsonValue type = "text_editor_code_execution_create_result"` - `boolean isFileUpdate` - `class TextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonValue type = "text_editor_code_execution_str_replace_result"` - `Optional> lines` - `Optional newLines` - `Optional newStart` - `Optional oldLines` - `Optional oldStart` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class ToolSearchToolResultBlockParam` - `JsonValue type = "tool_search_tool_result"` - `Content content` - `class ToolSearchToolResultErrorParam` - `JsonValue type = "tool_search_tool_result_error"` - `ToolSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `Optional errorMessage` - `class ToolSearchToolSearchResultBlockParam` - `JsonValue type = "tool_search_tool_search_result"` - `List toolReferences` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Optional cacheControl` Create a cache control breakpoint at this content block. - `class ContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `JsonValue type = "container_upload"` - `String fileId` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Role role` - `USER("user")` - `ASSISTANT("assistant")` - `SYSTEM("system")` - `Model model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `CLAUDE_HAIKU_5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `CLAUDE_SONNET_5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `CLAUDE_FABLE_5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `CLAUDE_OPUS_5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `CLAUDE_MYTHOS_5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `CLAUDE_SONNET_5("claude-sonnet-5")` Efficient model for coding and agents - `CLAUDE_FABLE_5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `CLAUDE_MYTHOS_5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `CLAUDE_OPUS_5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `CLAUDE_SONNET_4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `CLAUDE_HAIKU_4_5("claude-haiku-4-5")` - `CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")` - `CLAUDE_OPUS_4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `CLAUDE_MYTHOS_PREVIEW("claude-mythos-preview")` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `CLAUDE_SONNET_4_5("claude-sonnet-4-5")` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Optional cacheControl` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `Optional container` Container identifier for reuse across requests. - `class ContainerParams` Container parameters with skills to be loaded. - `Optional id` Container id - `Optional> skills` List of skills to load in the container maxItems: 20 - `Type type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `ANTHROPIC("anthropic")` - `CUSTOM("custom")` - `String skillId` Skill ID minLength: 1, maxLength: 64 - `Optional version` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 - `String` - `Optional diagnostics` Request-level diagnostics. Supply `previous_message_id` to have the response include `diagnostics.cache_miss_reason` explaining any prompt-cache divergence from that prior request. - `Optional previousMessageId` The `id` (`msg_...`) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns `diagnostics.cache_miss_reason` when the prompt-cache prefix could not be reused. Pass `null` on the first turn to opt in without a prior message to compare. maxLength: 256 - `Optional inferenceGeo` Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. - `Optional metadata` An object describing metadata about the request. - `Optional userId` An external identifier for the user who is associated with the request. This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number. maxLength: 512 - `Optional outputConfig` Configuration options for the model's output, such as the output format. - `Optional effort` How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. - `LOW("low")` - `MEDIUM("medium")` - `HIGH("high")` - `XHIGH("xhigh")` - `MAX("max")` - `Optional format` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=java) - `JsonValue type = "json_schema"` - `Schema schema` The JSON schema of the format - `Optional serviceTier` Determines whether to use priority capacity (if available) or standard capacity for this request. Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers?sdk_languages=java) for details. - `AUTO("auto")` - `STANDARD_ONLY("standard_only")` - `Optional speed` The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. Some models require the `fast-mode-2026-02-01` beta header for any `speed` value. See [fast mode](https://platform.claude.com/docs/en/build-with-claude/fast-mode?sdk_languages=java) for which models. - `STANDARD("standard")` - `FAST("fast")` - `Optional> stopSequences` Custom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`. If you want the model to stop generating when it encounters custom strings of text, you can use the `stop_sequences` parameter. If the model encounters one of the custom sequences, the response `stop_reason` value will be `"stop_sequence"` and the response `stop_sequence` value will contain the matched stop sequence. - `Optional stream` Whether to incrementally stream the response using server-sent events. When `true`, SDKs return a raw event stream. In the TypeScript, Python and Ruby SDKs, the recommended way to stream is `messages.stream()`. It sets `stream` for you and accumulates the events into the final message. See [Streaming with SDKs](https://platform.claude.com/docs/en/build-with-claude/streaming?sdk_languages=java#streaming-with-sdks) for an example in each language. - `Optional system` System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=java#give-claude-a-role). - `String` - `List` - `JsonValue type = "text"` - `String text` minLength: 1 - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional> citations` - `Optional thinking` Configuration for Claude's thinking. With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit. Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=java#configuring-thinking) for each model's behavior. - `class ThinkingConfigEnabled` - `JsonValue type = "enabled"` - `long budgetTokens` Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java) for details. minimum: 1024 - `Optional display` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=java#controlling-thinking-display). - `SUMMARIZED("summarized")` - `OMITTED("omitted")` - `class ThinkingConfigDisabled` - `JsonValue type = "disabled"` - `class ThinkingConfigBetweenTools` - `JsonValue type = "between_tools"` - `class ThinkingConfigAdaptive` - `JsonValue type = "adaptive"` - `Optional display` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=java#controlling-thinking-display). - `SUMMARIZED("summarized")` - `OMITTED("omitted")` - `Optional toolChoice` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. - `class ToolChoiceAuto` The model will automatically decide whether to use tools. - `JsonValue type = "auto"` - `Optional disableParallelToolUse` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `class ToolChoiceAny` The model will use any available tools. - `JsonValue type = "any"` - `Optional disableParallelToolUse` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `class ToolChoiceTool` The model will use the specified tool with `tool_choice.name`. - `JsonValue type = "tool"` - `String name` The name of the tool to use. - `Optional disableParallelToolUse` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `class ToolChoiceNone` The model will not be allowed to use tools. - `JsonValue type = "none"` - `Optional> tools` Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=java), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=java)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And then asked the model "What's the S&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=java) for more details. - `class Tool` - `Optional type` - `InputSchema inputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `JsonValue type = "object"` - `Optional properties` - `Optional> required` - `String name` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional description` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `Optional eagerInputStreaming` 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. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolBash20250124` - `JsonValue type = "bash_20250124"` - `JsonValue name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20250522` - `JsonValue type = "code_execution_20250522"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20250825` - `JsonValue type = "code_execution_20250825"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `JsonValue type = "code_execution_20260120"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class CodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonValue type = "code_execution_20260521"` - `JsonValue name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class BrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonValue type = "browser_toolset_20260801"` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Optional type` `type`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional closeTab` `close_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional doubleClick` `double_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional fileUpload` `file_upload`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional find` `find`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional formInput` `form_input`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional getPageText` `get_page_text`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional holdKey` `hold_key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional hover` `hover`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional javascriptExec` `javascript_exec`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional key` `key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClick` `left_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClickDrag` `left_click_drag`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseDown` `left_mouse_down`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseUp` `left_mouse_up`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional listTabs` `list_tabs`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional middleClick` `middle_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional mouseMove` `mouse_move`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional navigate` `navigate`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional newTab` `new_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readConsole` `read_console`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readNetwork` `read_network`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional readPage` `read_page`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional rightClick` `right_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional screenshot` `screenshot`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scroll` `scroll`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scrollTo` `scroll_to`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional switchTab` `switch_tab`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional tripleClick` `triple_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional wait` `wait`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional zoom` `zoom`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class MemoryTool20250818` - `JsonValue type = "memory_20250818"` - `JsonValue name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonValue type = "computer_toolset_20260801"` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Optional type` `type`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional cursorPosition` `cursor_position`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional doubleClick` `double_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional holdKey` `hold_key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional key` `key`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClick` `left_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftClickDrag` `left_click_drag`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseDown` `left_mouse_down`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional leftMouseUp` `left_mouse_up`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional middleClick` `middle_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional mouseMove` `mouse_move`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional rightClick` `right_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional screenshot` `screenshot`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional scroll` `scroll`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional tripleClick` `triple_click`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional wait` `wait`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `Optional zoom` `zoom`'s config overrides. - `Optional deferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Optional enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class ToolTextEditor20250124` - `JsonValue type = "text_editor_20250124"` - `JsonValue name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolTextEditor20250429` - `JsonValue type = "text_editor_20250429"` - `JsonValue name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolTextEditor20250728` - `JsonValue type = "text_editor_20250728"` - `JsonValue name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional> inputExamples` - `Optional maxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class WebSearchTool20250305` - `JsonValue type = "web_search_20250305"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonValue type = "approximate"` - `Optional city` The city of the user. minLength: 1, maxLength: 255 - `Optional country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Optional region` The region of the user. minLength: 1, maxLength: 255 - `Optional timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class WebFetchTool20250910` - `JsonValue type = "web_fetch_20250910"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional clientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonValue type = "all"` - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonValue type = "none"` - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonValue type = "only"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonValue type = "except"` - `List tools` - `JsonValue type = "tool_reference"` - `String name` - `Optional serverToolResults` 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. - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class WebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class WebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Optional userInput` Whether URLs in user messages are fetchable: "all" or "none". - `class WebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class WebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class WebSearchTool20260209` - `JsonValue type = "web_search_20260209"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `class WebFetchTool20260209` - `JsonValue type = "web_fetch_20260209"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class WebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonValue type = "web_fetch_20260309"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional useCache` 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. - `class WebSearchTool20260318` - `JsonValue type = "web_search_20260318"` - `JsonValue name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `Optional> blockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional responseInclusion` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `FULL("full")` - `EXCLUDED("excluded")` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional userLocation` Parameters for the user's location. Used to provide more relevant search results. - `class WebFetchTool20260318` - `JsonValue type = "web_fetch_20260318"` - `JsonValue name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional> allowedDomains` List of domains to allow fetching from - `Optional> blockedDomains` List of domains to block fetching from - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional citations` Citations configuration for fetched documents. Citations are disabled by default. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional maxContentTokens` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `Optional maxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `Optional responseInclusion` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `FULL("full")` - `EXCLUDED("excluded")` - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional urlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `Optional useCache` 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. - `class ToolSearchToolBm25_20251119` - `Type type` - `TOOL_SEARCH_TOOL_BM25_20251119("tool_search_tool_bm25_20251119")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `JsonValue name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `class ToolSearchToolRegex20251119` - `Type type` - `TOOL_SEARCH_TOOL_REGEX_20251119("tool_search_tool_regex_20251119")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `JsonValue name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `Optional> allowedCallers` - `DIRECT("direct")` - `CODE_EXECUTION_20250825("code_execution_20250825")` - `CODE_EXECUTION_20260120("code_execution_20260120")` - `CODE_EXECUTION_20260521("code_execution_20260521")` - `Optional cacheControl` Create a cache control breakpoint at this content block. - `Optional deferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Optional strict` When true, guarantees schema validation on tool names and inputs - `Optional temperature` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. Amount of randomness injected into the response. Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks. Note that even with `temperature` of `0.0`, the results will not be fully deterministic. minimum: 0, maximum: 1 - `Optional topK` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error. Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). Recommended for advanced use cases only. minimum: 0 - `Optional topP` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting top_p. A value >= 0.99 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. Use nucleus sampling. In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`. Recommended for advanced use cases only. minimum: 0, maximum: 1 #### Returns - `class MessageBatch` - `JsonValue type = "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. - `String id` Unique object identifier. The format and length of IDs may change over time. - `Optional archivedAt` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `Optional cancelInitiatedAt` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. format: date-time - `LocalDateTime createdAt` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `Optional endedAt` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. format: date-time - `LocalDateTime expiresAt` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. format: date-time - `ProcessingStatus processingStatus` Processing status of the Message Batch. - `IN_PROGRESS("in_progress")` - `CANCELING("canceling")` - `ENDED("ended")` - `MessageBatchRequestCounts requestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `long canceled` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `long errored` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `long expired` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `long processing` Number of requests in the Message Batch that are processing. - `long succeeded` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `Optional resultsUrl` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.messages.Model; import com.anthropic.models.messages.batches.BatchCreateParams; import com.anthropic.models.messages.batches.MessageBatch; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); BatchCreateParams params = BatchCreateParams.builder() .addRequest(BatchCreateParams.Request.builder() .customId("my-custom-id-1") .params(BatchCreateParams.Request.Params.builder() .maxTokens(1024L) .addUserMessage("Hello, world") .model(Model.CLAUDE_OPUS_5_5) .build()) .build()) .build(); MessageBatch messageBatch = client.messages().batches().create(params); } } ``` ##### Response (200) ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ### Retrieve a Message Batch `MessageBatch messages().batches().retrieve(params = BatchRetrieveParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/messages/batches/{message_batch_id}` This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the `results_url` field in the response. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=java) #### Parameters - `BatchRetrieveParams params` - `Optional messageBatchId` (path parameter) ID of the Message Batch. - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `class MessageBatch` - `JsonValue type = "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. - `String id` Unique object identifier. The format and length of IDs may change over time. - `Optional archivedAt` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `Optional cancelInitiatedAt` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. format: date-time - `LocalDateTime createdAt` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `Optional endedAt` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. format: date-time - `LocalDateTime expiresAt` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. format: date-time - `ProcessingStatus processingStatus` Processing status of the Message Batch. - `IN_PROGRESS("in_progress")` - `CANCELING("canceling")` - `ENDED("ended")` - `MessageBatchRequestCounts requestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `long canceled` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `long errored` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `long expired` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `long processing` Number of requests in the Message Batch that are processing. - `long succeeded` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `Optional resultsUrl` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.messages.batches.BatchRetrieveParams; import com.anthropic.models.messages.batches.MessageBatch; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); MessageBatch messageBatch = client.messages().batches().retrieve("message_batch_id"); } } ``` ##### Response (200) ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ### List Message Batches `BatchListPage messages().batches().list(params = BatchListParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/messages/batches` List all Message Batches within a Workspace. Most recently created batches are returned first. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=java) #### Parameters - `BatchListParams params` - `Optional afterId` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `Optional beforeId` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `Optional limit` (query parameter) Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. minimum: 1, maximum: 1000 - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `class MessageBatch` - `JsonValue type = "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. - `String id` Unique object identifier. The format and length of IDs may change over time. - `Optional archivedAt` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `Optional cancelInitiatedAt` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. format: date-time - `LocalDateTime createdAt` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `Optional endedAt` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. format: date-time - `LocalDateTime expiresAt` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. format: date-time - `ProcessingStatus processingStatus` Processing status of the Message Batch. - `IN_PROGRESS("in_progress")` - `CANCELING("canceling")` - `ENDED("ended")` - `MessageBatchRequestCounts requestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `long canceled` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `long errored` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `long expired` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `long processing` Number of requests in the Message Batch that are processing. - `long succeeded` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `Optional resultsUrl` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.messages.batches.BatchListPage; import com.anthropic.models.messages.batches.BatchListParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); BatchListPage page = client.messages().batches().list(); } } ``` ##### Response (200) ```json { "data": [ { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ### Cancel a Message Batch `MessageBatch messages().batches().cancel(params = BatchCancelParams.none(), requestOptions = RequestOptions.none())` **POST** `/v1/messages/batches/{message_batch_id}/cancel` Batches may be canceled any time before processing ends. Once cancellation is initiated, the batch enters a `canceling` state, at which time the system may complete any in-progress, non-interruptible requests before finalizing cancellation. The number of canceled requests is specified in `request_counts`. To determine which requests were canceled, check the individual results within the batch. Note that cancellation may not result in any canceled requests if they were non-interruptible. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=java) #### Parameters - `BatchCancelParams params` - `Optional messageBatchId` (path parameter) ID of the Message Batch. - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `class MessageBatch` - `JsonValue type = "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. - `String id` Unique object identifier. The format and length of IDs may change over time. - `Optional archivedAt` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `Optional cancelInitiatedAt` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. format: date-time - `LocalDateTime createdAt` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `Optional endedAt` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. format: date-time - `LocalDateTime expiresAt` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. format: date-time - `ProcessingStatus processingStatus` Processing status of the Message Batch. - `IN_PROGRESS("in_progress")` - `CANCELING("canceling")` - `ENDED("ended")` - `MessageBatchRequestCounts requestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `long canceled` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `long errored` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `long expired` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `long processing` Number of requests in the Message Batch that are processing. - `long succeeded` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `Optional resultsUrl` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.messages.batches.BatchCancelParams; import com.anthropic.models.messages.batches.MessageBatch; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); MessageBatch messageBatch = client.messages().batches().cancel("message_batch_id"); } } ``` ##### Response (200) ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ### Delete a Message Batch `DeletedMessageBatch messages().batches().delete(params = BatchDeleteParams.none(), requestOptions = RequestOptions.none())` **DELETE** `/v1/messages/batches/{message_batch_id}` Delete a Message Batch. Message Batches can only be deleted once they've finished processing. If you'd like to delete an in-progress batch, you must first cancel it. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=java) #### Parameters - `BatchDeleteParams params` - `Optional messageBatchId` (path parameter) ID of the Message Batch. - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `class DeletedMessageBatch` - `JsonValue type = "message_batch_deleted"` Deleted object type. For Message Batches, this is always `"message_batch_deleted"`. - `String id` ID of the Message Batch. #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.messages.batches.BatchDeleteParams; import com.anthropic.models.messages.batches.DeletedMessageBatch; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); DeletedMessageBatch deletedMessageBatch = client.messages().batches().delete("message_batch_id"); } } ``` ##### Response (200) ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "type": "message_batch_deleted" } ``` ### Retrieve Message Batch results `StreamResponse messages().batches().resultsStreaming(params = BatchResultsParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/messages/batches/{message_batch_id}/results` Streams the results of a Message Batch as a `.jsonl` file. Each line in the file is a JSON object containing the result of a single request in the Message Batch. Results are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=java) #### Parameters - `BatchResultsParams params` - `Optional messageBatchId` (path parameter) ID of the Message Batch. - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `class MessageBatchIndividualResponse` This is a single line in the response `.jsonl` file and does not represent the response as a whole. - `String customId` Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order. Must be unique for each request within the Message Batch. - `MessageBatchResult result` Processing result for this request. Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration. - `class MessageBatchSucceededResult` - `JsonValue type = "succeeded"` - `Message message` - `JsonValue type = "message"` Object type. For Messages, this is always `"message"`. - `String id` Unique object identifier. The format and length of IDs may change over time. - `Optional container` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `String id` Identifier for the container used in this request - `LocalDateTime expiresAt` The time at which the container will expire. format: date-time - `Optional> skills` Skills loaded in the container - `Type type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `ANTHROPIC("anthropic")` - `CUSTOM("custom")` - `String skillId` Skill ID minLength: 1, maxLength: 64 - `String version` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `List content` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `class TextBlock` - `JsonValue type = "text"` - `Optional> citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class CitationCharLocation` - `JsonValue type = "char_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endCharIndex` - `Optional fileId` - `long startCharIndex` minimum: 0 - `class CitationPageLocation` - `JsonValue type = "page_location"` - `String citedText` - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endPageNumber` - `Optional fileId` - `long startPageNumber` minimum: 1 - `class CitationContentBlockLocation` - `JsonValue type = "content_block_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long documentIndex` minimum: 0 - `Optional documentTitle` - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `Optional fileId` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class CitationsWebSearchResultLocation` - `JsonValue type = "web_search_result_location"` - `String citedText` - `String encryptedIndex` - `Optional title` maxLength: 512 - `String url` - `class CitationsSearchResultLocation` - `JsonValue type = "search_result_location"` - `String citedText` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `long endBlockIndex` Exclusive 0-based end index of the cited block range in the source's `content` array. Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - `long searchResultIndex` 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. Counted separately from `document_index`; server-side web search results are not included in this count. minimum: 0 - `String source` - `long startBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Optional title` - `String text` - `class ThinkingBlock` - `JsonValue type = "thinking"` - `String signature` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java) for details. - `String thinking` The text of Claude's thinking process for this block. - `class RedactedThinkingBlock` - `JsonValue type = "redacted_thinking"` - `String data` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=java#redacted-thinking-blocks) for details. - `class ToolUseBlock` - `JsonValue type = "tool_use"` - `String id` pattern: ^[a-zA-Z0-9_-]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `JsonValue type = "direct"` - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `JsonValue type = "code_execution_20250825"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ServerToolCaller20260120` - `JsonValue type = "code_execution_20260120"` - `String toolId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input input` - `String name` minLength: 1 - `Optional toolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class ServerToolUseBlock` - `JsonValue type = "server_tool_use"` - `String id` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `Input input` - `Name name` - `WEB_SEARCH("web_search")` - `WEB_FETCH("web_fetch")` - `CODE_EXECUTION("code_execution")` - `BASH_CODE_EXECUTION("bash_code_execution")` - `TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")` - `TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")` - `TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")` - `class WebSearchToolResultBlock` - `JsonValue type = "web_search_tool_result"` - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `WebSearchToolResultBlockContent content` - `class WebSearchToolResultError` - `JsonValue type = "web_search_tool_result_error"` - `WebSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `TOO_MANY_REQUESTS("too_many_requests")` - `QUERY_TOO_LONG("query_too_long")` - `REQUEST_TOO_LARGE("request_too_large")` - `List` - `JsonValue type = "web_search_result"` - `String encryptedContent` - `Optional pageAge` - `String title` - `String url` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class WebFetchToolResultBlock` - `JsonValue type = "web_fetch_tool_result"` - `Caller caller` - `class DirectCaller` Tool invocation directly from the model. - `class ServerToolCaller` Tool invocation generated by a server-side tool. - `class ServerToolCaller20260120` - `Content content` - `class WebFetchToolResultErrorBlock` - `JsonValue type = "web_fetch_tool_result_error"` - `WebFetchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `URL_TOO_LONG("url_too_long")` - `URL_NOT_ALLOWED("url_not_allowed")` - `URL_NOT_IN_PRIOR_CONTEXT("url_not_in_prior_context")` - `URL_NOT_ACCESSIBLE("url_not_accessible")` - `UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")` - `TOO_MANY_REQUESTS("too_many_requests")` - `MAX_USES_EXCEEDED("max_uses_exceeded")` - `UNAVAILABLE("unavailable")` - `CONTENT_TOO_LARGE("content_too_large")` - `class WebFetchBlock` - `JsonValue type = "web_fetch_result"` - `DocumentBlock content` - `JsonValue type = "document"` - `Optional citations` Citation configuration for the document - `boolean enabled` - `Source source` - `class Base64PdfSource` - `JsonValue type = "base64"` - `String data` format: byte - `JsonValue mediaType = "application/pdf"` - `class PlainTextSource` - `JsonValue type = "text"` - `String data` - `JsonValue mediaType = "text/plain"` - `Optional title` The title of the document - `Optional retrievedAt` ISO 8601 timestamp when the content was retrieved - `String url` Fetched content URL - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class CodeExecutionToolResultBlock` - `JsonValue type = "code_execution_tool_result"` - `CodeExecutionToolResultBlockContent content` - `class CodeExecutionToolResultError` - `JsonValue type = "code_execution_tool_result_error"` - `CodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `class CodeExecutionResultBlock` - `JsonValue type = "code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `class EncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `JsonValue type = "encrypted_code_execution_result"` - `List content` - `JsonValue type = "code_execution_output"` - `String fileId` - `String encryptedStdout` - `long returnCode` - `String stderr` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BashCodeExecutionToolResultBlock` - `JsonValue type = "bash_code_execution_tool_result"` - `Content content` - `class BashCodeExecutionToolResultError` - `JsonValue type = "bash_code_execution_tool_result_error"` - `BashCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `OUTPUT_FILE_TOO_LARGE("output_file_too_large")` - `class BashCodeExecutionResultBlock` - `JsonValue type = "bash_code_execution_result"` - `List content` - `JsonValue type = "bash_code_execution_output"` - `String fileId` - `long returnCode` - `String stderr` - `String stdout` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class TextEditorCodeExecutionToolResultBlock` - `JsonValue type = "text_editor_code_execution_tool_result"` - `Content content` - `class TextEditorCodeExecutionToolResultError` - `JsonValue type = "text_editor_code_execution_tool_result_error"` - `TextEditorCodeExecutionToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `FILE_NOT_FOUND("file_not_found")` - `Optional errorMessage` - `class TextEditorCodeExecutionViewResultBlock` - `JsonValue type = "text_editor_code_execution_view_result"` - `String content` - `FileType fileType` - `TEXT("text")` - `IMAGE("image")` - `PDF("pdf")` - `Optional numLines` - `Optional startLine` - `Optional totalLines` - `class TextEditorCodeExecutionCreateResultBlock` - `JsonValue type = "text_editor_code_execution_create_result"` - `boolean isFileUpdate` - `class TextEditorCodeExecutionStrReplaceResultBlock` - `JsonValue type = "text_editor_code_execution_str_replace_result"` - `Optional> lines` - `Optional newLines` - `Optional newStart` - `Optional oldLines` - `Optional oldStart` - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ToolSearchToolResultBlock` - `JsonValue type = "tool_search_tool_result"` - `Content content` - `class ToolSearchToolResultError` - `JsonValue type = "tool_search_tool_result_error"` - `ToolSearchToolResultErrorCode errorCode` - `INVALID_TOOL_INPUT("invalid_tool_input")` - `UNAVAILABLE("unavailable")` - `TOO_MANY_REQUESTS("too_many_requests")` - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")` - `Optional errorMessage` - `class ToolSearchToolSearchResultBlock` - `JsonValue type = "tool_search_tool_search_result"` - `List toolReferences` - `JsonValue type = "tool_reference"` - `String toolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `String toolUseId` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class ContainerUploadBlock` Response model for a file uploaded to the container. - `JsonValue type = "container_upload"` - `String fileId` - `Optional diagnostics` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `Optional cacheMissReason` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `class CacheMissModelChanged` - `JsonValue type = "model_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissSystemChanged` - `JsonValue type = "system_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissToolsChanged` - `JsonValue type = "tools_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissMessagesChanged` - `JsonValue type = "messages_changed"` - `long cacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class CacheMissPreviousMessageNotFound` - `JsonValue type = "previous_message_not_found"` - `class CacheMissUnavailable` - `JsonValue type = "unavailable"` - `Model model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `CLAUDE_HAIKU_5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `CLAUDE_SONNET_5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `CLAUDE_FABLE_5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `CLAUDE_OPUS_5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `CLAUDE_MYTHOS_5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `CLAUDE_SONNET_5("claude-sonnet-5")` Efficient model for coding and agents - `CLAUDE_FABLE_5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `CLAUDE_MYTHOS_5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `CLAUDE_OPUS_5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `CLAUDE_SONNET_4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `CLAUDE_HAIKU_4_5("claude-haiku-4-5")` - `CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")` - `CLAUDE_OPUS_4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `CLAUDE_OPUS_4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `CLAUDE_MYTHOS_PREVIEW("claude-mythos-preview")` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `CLAUDE_SONNET_4_5("claude-sonnet-4-5")` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `JsonValue role = "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `Optional stopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `JsonValue type = "refusal"` - `Optional category` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `CYBER("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `BIO("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FRONTIER_LLM("frontier_llm")` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `REASONING_EXTRACTION("reasoning_extraction")` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=java). - `GENERAL_HARMS("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `Optional explanation` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `Optional stopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations * `"model_context_window_exceeded"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `END_TURN("end_turn")` - `MAX_TOKENS("max_tokens")` - `STOP_SEQUENCE("stop_sequence")` - `TOOL_USE("tool_use")` - `PAUSE_TURN("pause_turn")` - `REFUSAL("refusal")` - `MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")` - `Optional stopSequence` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Usage usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `Optional cacheCreation` Breakdown of cached tokens by TTL - `long ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `long ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `Optional cacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `Optional cacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `Optional inferenceGeo` The geographic region where inference was performed for this request. - `long inputTokens` The number of input tokens which were used. minimum: 0 - `long outputTokens` The number of output tokens which were used. minimum: 0 - `Optional outputTokensDetails` Breakdown of output tokens by category. `output_tokens` remains the inclusive, authoritative total used for billing. This object provides a read-only decomposition for observability — for example, how many of the billed output tokens were spent on internal reasoning that may have been summarized before being returned to you. - `long thinkingTokens` Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens. Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. minimum: 0 - `Optional serverToolUse` The number of server tool requests. - `long webFetchRequests` The number of web fetch tool requests. minimum: 0 - `long webSearchRequests` The number of web search tool requests. minimum: 0 - `Optional serviceTier` If the request used the priority, standard, or batch tier. - `STANDARD("standard")` - `PRIORITY("priority")` - `BATCH("batch")` - `Optional speed` The inference speed mode used for this request. - `STANDARD("standard")` - `FAST("fast")` - `class MessageBatchErroredResult` - `JsonValue type = "errored"` - `ErrorResponse error` - `JsonValue type = "error"` - `ErrorObject error` - `class InvalidRequestError` - `JsonValue type = "invalid_request_error"` - `String message` - `class AuthenticationError` - `JsonValue type = "authentication_error"` - `String message` - `class BillingError` - `JsonValue type = "billing_error"` - `String message` - `class PermissionError` - `JsonValue type = "permission_error"` - `String message` - `class NotFoundError` - `JsonValue type = "not_found_error"` - `String message` - `class RateLimitError` - `JsonValue type = "rate_limit_error"` - `String message` - `class GatewayTimeoutError` - `JsonValue type = "timeout_error"` - `String message` - `class ApiErrorObject` - `JsonValue type = "api_error"` - `String message` - `class OverloadedError` - `JsonValue type = "overloaded_error"` - `String message` - `Optional requestId` - `class MessageBatchCanceledResult` - `JsonValue type = "canceled"` - `class MessageBatchExpiredResult` - `JsonValue type = "expired"` #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.core.http.StreamResponse; import com.anthropic.models.messages.batches.BatchResultsParams; import com.anthropic.models.messages.batches.MessageBatchIndividualResponse; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); StreamResponse messageBatchIndividualResponse = client.messages().batches().resultsStreaming("message_batch_id"); } } ```