---
title: Messages
url: https://platform.claude.com/docs/en/api/java/beta/messages
---

# Messages

## Create a Message

`BetaMessage beta().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<List<AnthropicBeta>> betas` (header parameter)

    Optional header to specify the beta version(s) you want to use.

    - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")`

    - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")`

    - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")`

    - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")`

    - `PDFS_2024_09_25("pdfs-2024-09-25")`

    - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")`

    - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")`

    - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")`

    - `FILES_API_2025_04_14("files-api-2025-04-14")`

    - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")`

    - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")`

    - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")`

    - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")`

    - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")`

    - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")`

    - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")`

    - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")`

    - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")`

    - `SKILLS_2025_10_02("skills-2025-10-02")`

    - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")`

    - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")`

    - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")`

    - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")`

    - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")`

    - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")`

    - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")`

    - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")`

    - `DREAMING_2026_04_21("dreaming-2026-04-21")`

    - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")`

    - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")`

    - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")`

    - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")`

    - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")`

    - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")`

    - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")`

    - `COMPACT_2026_01_12("compact-2026-01-12")`

    - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")`

    - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")`

    - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")`

    - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")`

    - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")`

    - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")`

    - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")`

    - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")`

    - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")`

    - `COMPACT_2026_09_04("compact-2026-09-04")`

    - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")`

    - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")`

    - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")`

    - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")`

    - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")`

  - `Optional<String> 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<String> 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<BetaMessageParam> 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<BetaContentBlockParam>`

        - `class BetaTextBlockParam`

          - `JsonValue type = "text"`

          - `String text`

            minLength: 1

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

            - `JsonValue type = "ephemeral"`

            - `Optional<Ttl> 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<List<BetaTextCitationParam>> citations`

            - `class BetaCitationCharLocationParam`

              - `JsonValue type = "char_location"`

              - `String citedText`

              - `long documentIndex`

                minimum: 0

              - `Optional<String> documentTitle`

                minLength: 1, maxLength: 500

              - `long endCharIndex`

              - `long startCharIndex`

                minimum: 0

            - `class BetaCitationPageLocationParam`

              - `JsonValue type = "page_location"`

              - `String citedText`

              - `long documentIndex`

                minimum: 0

              - `Optional<String> documentTitle`

                minLength: 1, maxLength: 500

              - `long endPageNumber`

              - `long startPageNumber`

                minimum: 1

            - `class BetaCitationContentBlockLocationParam`

              - `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<String> 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 BetaCitationWebSearchResultLocationParam`

              - `JsonValue type = "web_search_result_location"`

              - `String citedText`

              - `String encryptedIndex`

              - `Optional<String> title`

                minLength: 1, maxLength: 512

              - `String url`

                minLength: 1

            - `class BetaCitationSearchResultLocationParam`

              - `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<String> title`

        - `class BetaImageBlockParam`

          - `JsonValue type = "image"`

          - `Source source`

            - `class BetaBase64ImageSource`

              - `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 BetaUrlImageSource`

              - `JsonValue type = "url"`

              - `String url`

            - `class BetaFileImageSource`

              - `JsonValue type = "file"`

              - `String fileId`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaImageTransformationsParam> 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> 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 BetaRequestDocumentBlock`

          - `JsonValue type = "document"`

          - `Source source`

            - `class BetaBase64PdfSource`

              - `JsonValue type = "base64"`

              - `String data`

                format: byte

              - `JsonValue mediaType = "application/pdf"`

            - `class BetaPlainTextSource`

              - `JsonValue type = "text"`

              - `String data`

              - `JsonValue mediaType = "text/plain"`

            - `class BetaContentBlockSource`

              - `JsonValue type = "content"`

              - `Content content`

                - `String`

                - `List<BetaContentBlockSourceContent>`

                  - `class BetaTextBlockParam`

                  - `class BetaImageBlockParam`

            - `class BetaUrlPdfSource`

              - `JsonValue type = "url"`

              - `String url`

            - `class BetaFileDocumentSource`

              - `JsonValue type = "file"`

              - `String fileId`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaCitationsConfigParam> citations`

            - `Optional<Boolean> enabled`

          - `Optional<String> context`

            minLength: 1

          - `Optional<String> title`

            minLength: 1, maxLength: 500

        - `class BetaSearchResultBlockParam`

          - `JsonValue type = "search_result"`

          - `List<BetaTextBlockParam> content`

            - `JsonValue type = "text"`

            - `String text`

              minLength: 1

            - `Optional<BetaCacheControlEphemeral> cacheControl`

              Create a cache control breakpoint at this content block.

            - `Optional<List<BetaTextCitationParam>> citations`

          - `String source`

          - `String title`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaCitationsConfigParam> citations`

        - `class BetaThinkingBlockParam`

          - `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 BetaRedactedThinkingBlockParam`

          - `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 BetaToolUseBlockParam`

          - `JsonValue type = "tool_use"`

          - `String id`

            pattern: ^[a-zA-Z0-9_-]+$

          - `Input input`

          - `String name`

            minLength: 1, maxLength: 200

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Caller> caller`

            - `class BetaDirectCaller`

              Tool invocation directly from the model.

              - `JsonValue type = "direct"`

            - `class BetaServerToolCaller`

              Tool invocation generated by a server-side tool.

              - `JsonValue type = "code_execution_20250825"`

              - `String toolId`

                pattern: ^srvtoolu_[a-zA-Z0-9_]+$

            - `class BetaServerToolCaller20260120`

              - `JsonValue type = "code_execution_20260120"`

              - `String toolId`

                pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<String> toolsetName`

            For a toolset member tool_use, the toolset family this member belongs to.

            minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$

        - `class BetaToolResultBlockParam`

          - `JsonValue type = "tool_result"`

          - `String toolUseId`

            pattern: ^[a-zA-Z0-9_-]+$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Content> content`

            - `String`

            - `List<Block>`

              - `class BetaTextBlockParam`

              - `class BetaImageBlockParam`

              - `class BetaSearchResultBlockParam`

              - `class BetaRequestDocumentBlock`

              - `class BetaToolReferenceBlockParam`

                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<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

              - `class BetaBrowserStateBlockParam`

                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<BetaBrowserStateTabEntry> 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<Boolean> active`

                    Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<List<BetaBrowserStateChange>> 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 BetaBrowserStateChangeTabOpened`

                    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 BetaBrowserStateChangeDownloadStarted`

                    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 BetaBrowserStateChangeDownloadCompleted`

                    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<String> 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<Long> sizeBytes`

                      The completed download's size.

                      minimum: 0

                  - `class BetaBrowserStateChangeDownloadFailed`

                    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<String> error`

                      The failure or cancellation detail, when known.

                      maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$

          - `Optional<Boolean> isError`

          - `Optional<String> 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 BetaServerToolUseBlockParam`

          - `JsonValue type = "server_tool_use"`

          - `String id`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Input input`

          - `Name name`

            - `ADVISOR("advisor")`

            - `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<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Caller> caller`

            - `class BetaDirectCaller`

              Tool invocation directly from the model.

            - `class BetaServerToolCaller`

              Tool invocation generated by a server-side tool.

            - `class BetaServerToolCaller20260120`

        - `class BetaWebSearchToolResultBlockParam`

          - `JsonValue type = "web_search_tool_result"`

          - `BetaWebSearchToolResultBlockParamContent content`

            - `List<BetaWebSearchResultBlockParam>`

              - `JsonValue type = "web_search_result"`

              - `String encryptedContent`

              - `String title`

              - `String url`

              - `Optional<String> pageAge`

            - `class BetaWebSearchToolRequestError`

              - `JsonValue type = "web_search_tool_result_error"`

              - `BetaWebSearchToolResultErrorCode 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<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Caller> caller`

            - `class BetaDirectCaller`

              Tool invocation directly from the model.

            - `class BetaServerToolCaller`

              Tool invocation generated by a server-side tool.

            - `class BetaServerToolCaller20260120`

        - `class BetaWebFetchToolResultBlockParam`

          - `JsonValue type = "web_fetch_tool_result"`

          - `Content content`

            - `class BetaWebFetchToolResultErrorBlockParam`

              - `JsonValue type = "web_fetch_tool_result_error"`

              - `BetaWebFetchToolResultErrorCode 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 BetaWebFetchBlockParam`

              - `JsonValue type = "web_fetch_result"`

              - `BetaRequestDocumentBlock content`

              - `String url`

                Fetched content URL

              - `Optional<String> retrievedAt`

                ISO 8601 timestamp when the content was retrieved

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Caller> caller`

            - `class BetaDirectCaller`

              Tool invocation directly from the model.

            - `class BetaServerToolCaller`

              Tool invocation generated by a server-side tool.

            - `class BetaServerToolCaller20260120`

        - `class BetaAdvisorToolResultBlockParam`

          - `JsonValue type = "advisor_tool_result"`

          - `Content content`

            - `class BetaAdvisorToolResultErrorParam`

              - `JsonValue type = "advisor_tool_result_error"`

              - `ErrorCode errorCode`

                - `MAX_USES_EXCEEDED("max_uses_exceeded")`

                - `PROMPT_TOO_LONG("prompt_too_long")`

                - `TOO_MANY_REQUESTS("too_many_requests")`

                - `OVERLOADED("overloaded")`

                - `UNAVAILABLE("unavailable")`

                - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

                - `MODEL_NOT_FOUND("model_not_found")`

            - `class BetaAdvisorResultBlockParam`

              - `JsonValue type = "advisor_result"`

              - `String text`

              - `Optional<String> stopReason`

            - `class BetaAdvisorRedactedResultBlockParam`

              - `JsonValue type = "advisor_redacted_result"`

              - `String encryptedContent`

                Opaque blob produced by a prior response; must be round-tripped verbatim.

              - `Optional<String> stopReason`

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

        - `class BetaCodeExecutionToolResultBlockParam`

          - `JsonValue type = "code_execution_tool_result"`

          - `BetaCodeExecutionToolResultBlockParamContent content`

            - `class BetaCodeExecutionToolResultErrorParam`

              - `JsonValue type = "code_execution_tool_result_error"`

              - `BetaCodeExecutionToolResultErrorCode errorCode`

                - `INVALID_TOOL_INPUT("invalid_tool_input")`

                - `UNAVAILABLE("unavailable")`

                - `TOO_MANY_REQUESTS("too_many_requests")`

                - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

            - `class BetaCodeExecutionResultBlockParam`

              - `JsonValue type = "code_execution_result"`

              - `List<BetaCodeExecutionOutputBlockParam> content`

                - `JsonValue type = "code_execution_output"`

                - `String fileId`

              - `long returnCode`

              - `String stderr`

              - `String stdout`

            - `class BetaEncryptedCodeExecutionResultBlockParam`

              Code execution result with encrypted stdout for PFC + web_search results.

              - `JsonValue type = "encrypted_code_execution_result"`

              - `List<BetaCodeExecutionOutputBlockParam> content`

                - `JsonValue type = "code_execution_output"`

                - `String fileId`

              - `String encryptedStdout`

              - `long returnCode`

              - `String stderr`

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

        - `class BetaBashCodeExecutionToolResultBlockParam`

          - `JsonValue type = "bash_code_execution_tool_result"`

          - `Content content`

            - `class BetaBashCodeExecutionToolResultErrorParam`

              - `JsonValue type = "bash_code_execution_tool_result_error"`

              - `ErrorCode 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 BetaBashCodeExecutionResultBlockParam`

              - `JsonValue type = "bash_code_execution_result"`

              - `List<BetaBashCodeExecutionOutputBlockParam> content`

                - `JsonValue type = "bash_code_execution_output"`

                - `String fileId`

              - `long returnCode`

              - `String stderr`

              - `String stdout`

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

        - `class BetaTextEditorCodeExecutionToolResultBlockParam`

          - `JsonValue type = "text_editor_code_execution_tool_result"`

          - `Content content`

            - `class BetaTextEditorCodeExecutionToolResultErrorParam`

              - `JsonValue type = "text_editor_code_execution_tool_result_error"`

              - `ErrorCode 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<String> errorMessage`

            - `class BetaTextEditorCodeExecutionViewResultBlockParam`

              - `JsonValue type = "text_editor_code_execution_view_result"`

              - `String content`

              - `FileType fileType`

                - `TEXT("text")`

                - `IMAGE("image")`

                - `PDF("pdf")`

              - `Optional<Long> numLines`

              - `Optional<Long> startLine`

              - `Optional<Long> totalLines`

            - `class BetaTextEditorCodeExecutionCreateResultBlockParam`

              - `JsonValue type = "text_editor_code_execution_create_result"`

              - `boolean isFileUpdate`

            - `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam`

              - `JsonValue type = "text_editor_code_execution_str_replace_result"`

              - `Optional<List<String>> lines`

              - `Optional<Long> newLines`

              - `Optional<Long> newStart`

              - `Optional<Long> oldLines`

              - `Optional<Long> oldStart`

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

        - `class BetaToolSearchToolResultBlockParam`

          - `JsonValue type = "tool_search_tool_result"`

          - `Content content`

            - `class BetaToolSearchToolResultErrorParam`

              - `JsonValue type = "tool_search_tool_result_error"`

              - `ErrorCode errorCode`

                - `INVALID_TOOL_INPUT("invalid_tool_input")`

                - `UNAVAILABLE("unavailable")`

                - `TOO_MANY_REQUESTS("too_many_requests")`

                - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

              - `Optional<String> errorMessage`

            - `class BetaToolSearchToolSearchResultBlockParam`

              - `JsonValue type = "tool_search_tool_search_result"`

              - `List<BetaToolReferenceBlockParam> toolReferences`

                - `JsonValue type = "tool_reference"`

                - `String toolName`

                  minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

        - `class BetaMcpToolUseBlockParam`

          - `JsonValue type = "mcp_tool_use"`

          - `String id`

            pattern: ^[a-zA-Z0-9_-]+$

          - `Input input`

          - `String name`

          - `String serverName`

            The name of the MCP server

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

        - `class BetaRequestMcpToolResultBlockParam`

          - `JsonValue type = "mcp_tool_result"`

          - `String toolUseId`

            pattern: ^[a-zA-Z0-9_-]+$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Content> content`

            - `String`

            - `List<BetaTextBlockParam>`

              - `JsonValue type = "text"`

              - `String text`

                minLength: 1

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<List<BetaTextCitationParam>> citations`

          - `Optional<Boolean> isError`

        - `class BetaContainerUploadBlockParam`

          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<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

        - `class BetaCompactionBlockParam`

          A compaction block containing summary of previous context.

          Users should round-trip these blocks from responses to subsequent requests
          to maintain context across compaction boundaries.

          When content is None, the block represents a failed compaction. The server
          treats these as no-ops. Empty string content is not allowed.

          - `JsonValue type = "compaction"`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<String> content`

            Summary of previously compacted content, or null if compaction failed

          - `Optional<String> encryptedContent`

            Opaque metadata from prior compaction, to be round-tripped verbatim

          - `Optional<String> signature`

            The block's signature as returned, to be sent back verbatim

          - `Optional<List<ToolChange>> toolChanges`

            The tool changes of the compacted range, as the server returned them on this block: the `tool_addition` and `tool_removal` entries that take the request's `tools` to the tool set in effect at the end of the range. Send them back unchanged with the block.

            - `class BetaRequestToolAdditionBlock`

              Mid-conversation directive to make a tool available.

              `tool` is a reference to a tool (or MCP toolset) declared in the
              request's `tools`. Under the `inline-tools-2026-09-15` beta it may
              instead be a reference to a tool defined earlier in `messages`, or a
              `tool_definition` object that carries an inline tool definition in
              `definition` (the same object a `tools` entry holds). An `mcp_toolset`
              definition also requires the `mcp-client-2026-09-15` beta. The tool is
              offered to the model from this point in the conversation onward.

              - `JsonValue type = "tool_addition"`

              - `Tool tool`

                - `class BetaToolChangeToolReference`

                  Reference to a single tool, by the name the model uses to call it: a
                  tool declared in `tools` or defined by an earlier `tool_addition`
                  block. Does not accept the composed `{server}_{name}` form the server
                  assigns to MCP-resolved tools; use `mcp_tool_reference` or
                  `mcp_toolset_reference` for those.

                  - `JsonValue type = "tool_reference"`

                  - `String name`

                    pattern: ^[a-zA-Z0-9_-]{1,128}$

                - `class BetaToolChangeMcpToolReference`

                  Reference to a single MCP tool by its server and remote name; the
                  same `server_name`/`name` pair `mcp_tool_use` carries.

                  - `JsonValue type = "mcp_tool_reference"`

                  - `String name`

                  - `String serverName`

                - `class BetaToolChangeMcpToolsetReference`

                  Reference to every tool in the named MCP server's toolset.

                  - `JsonValue type = "mcp_toolset_reference"`

                  - `String serverName`

                - `class BetaToolChangeToolDefinitionParam`

                  A tool defined by value: `definition` is a `tools` entry (any kind
                  `tools` accepts, an MCP toolset included). An `mcp_toolset` given here
                  also requires the `mcp-client-2026-09-15` beta.

                  - `JsonValue type = "tool_definition"`

                  - `BetaToolUnion definition`

                    - `class BetaTool`

                      - `Optional<Type> 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> properties`

                        - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolBash20241022`

                      - `JsonValue type = "bash_20241022"`

                      - `JsonValue name = "bash"`

                        Name of the tool.

                        This is how the tool will be called by the model and in `tool_use` blocks.

                      - `Optional<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolBash20250124`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaCodeExecutionTool20250522`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaCodeExecutionTool20250825`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaCodeExecutionTool20260120`

                      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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaCodeExecutionTool20260521`

                      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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaBrowserToolset20260801`

                      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<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

                          `type`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserCloseTabConfig> closeTab`

                          `close_tab`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

                          `double_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserFileUploadConfig> fileUpload`

                          `file_upload`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserFindConfig> find`

                          `find`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserFormInputConfig> formInput`

                          `form_input`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserGetPageTextConfig> getPageText`

                          `get_page_text`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserHoldKeyConfig> holdKey`

                          `hold_key`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserHoverConfig> hover`

                          `hover`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

                          `javascript_exec`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserKeyConfig> key`

                          `key`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserLeftClickConfig> leftClick`

                          `left_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

                          `left_click_drag`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

                          `left_mouse_down`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

                          `left_mouse_up`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserListTabsConfig> listTabs`

                          `list_tabs`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserMiddleClickConfig> middleClick`

                          `middle_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

                          `mouse_move`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserNavigateConfig> navigate`

                          `navigate`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserNewTabConfig> newTab`

                          `new_tab`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserReadConsoleConfig> readConsole`

                          `read_console`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

                          `read_network`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserReadPageConfig> readPage`

                          `read_page`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserRightClickConfig> rightClick`

                          `right_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserScreenshotConfig> screenshot`

                          `screenshot`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserScrollConfig> scroll`

                          `scroll`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserScrollToConfig> scrollTo`

                          `scroll_to`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserSwitchTabConfig> switchTab`

                          `switch_tab`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserTripleClickConfig> tripleClick`

                          `triple_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserWaitConfig> wait`

                          `wait`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserZoomConfig> zoom`

                          `zoom`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered 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 BetaToolComputerUse20241022`

                      - `JsonValue type = "computer_20241022"`

                      - `long displayHeightPx`

                        The height of the display in pixels.

                        minimum: 1

                      - `long displayWidthPx`

                        The width of the display in pixels.

                        minimum: 1

                      - `JsonValue name = "computer"`

                        Name of the tool.

                        This is how the tool will be called by the model and in `tool_use` blocks.

                      - `Optional<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> displayNumber`

                        The X11 display number (e.g. 0, 1) for the display.

                        minimum: 0

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaMemoryTool20250818`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolComputerUse20250124`

                      - `JsonValue type = "computer_20250124"`

                      - `long displayHeightPx`

                        The height of the display in pixels.

                        minimum: 1

                      - `long displayWidthPx`

                        The width of the display in pixels.

                        minimum: 1

                      - `JsonValue name = "computer"`

                        Name of the tool.

                        This is how the tool will be called by the model and in `tool_use` blocks.

                      - `Optional<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> displayNumber`

                        The X11 display number (e.g. 0, 1) for the display.

                        minimum: 0

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolTextEditor20241022`

                      - `JsonValue type = "text_editor_20241022"`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolComputerUse20251124`

                      - `JsonValue type = "computer_20251124"`

                      - `long displayHeightPx`

                        The height of the display in pixels.

                        minimum: 1

                      - `long displayWidthPx`

                        The width of the display in pixels.

                        minimum: 1

                      - `JsonValue name = "computer"`

                        Name of the tool.

                        This is how the tool will be called by the model and in `tool_use` blocks.

                      - `Optional<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> displayNumber`

                        The X11 display number (e.g. 0, 1) for the display.

                        minimum: 0

                      - `Optional<Boolean> enableZoom`

                        Whether to enable an action to take a zoomed-in screenshot of the screen.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaComputerToolset20260801`

                      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<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

                          `type`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

                          `cursor_position`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerDoubleClickConfig> doubleClick`

                          `double_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerHoldKeyConfig> holdKey`

                          `hold_key`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerKeyConfig> key`

                          `key`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerLeftClickConfig> leftClick`

                          `left_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

                          `left_click_drag`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

                          `left_mouse_down`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

                          `left_mouse_up`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerMiddleClickConfig> middleClick`

                          `middle_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerMouseMoveConfig> mouseMove`

                          `mouse_move`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerRightClickConfig> rightClick`

                          `right_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerScreenshotConfig> screenshot`

                          `screenshot`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerScrollConfig> scroll`

                          `scroll`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerTripleClickConfig> tripleClick`

                          `triple_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerWaitConfig> wait`

                          `wait`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerZoomConfig> zoom`

                          `zoom`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered 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 BetaToolTextEditor20250124`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolTextEditor20250429`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolTextEditor20250728`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Long> maxCharacters`

                        Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaWebSearchTool20250305`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                      - `Optional<List<String>> blockedDomains`

                        If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaUserLocation> userLocation`

                        Parameters for the user's location. Used to provide more relevant search results.

                        - `JsonValue type = "approximate"`

                        - `Optional<String> city`

                          The city of the user.

                          minLength: 1, maxLength: 255

                        - `Optional<String> 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<String> region`

                          The region of the user.

                          minLength: 1, maxLength: 255

                        - `Optional<String> timezone`

                          The [IANA timezone](https://nodatime.org/TimeZones) of the user.

                          minLength: 1, maxLength: 255

                    - `class BetaWebFetchTool20250910`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        List of domains to allow fetching from

                      - `Optional<List<String>> blockedDomains`

                        List of domains to block fetching from

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaCitationsConfigParam> citations`

                        Citations configuration for fetched documents. Citations are disabled by default.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> 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<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaWebFetchUrlSources> urlSources`

                        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                        - `Optional<ClientToolResults> clientToolResults`

                          Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

                          - `class BetaWebFetchUrlSourceAll`

                            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 BetaWebFetchUrlSourceNone`

                            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 BetaWebFetchUrlSourceOnly`

                            The tool filter variant under which only the named tools' results
                            contribute.

                            - `JsonValue type = "only"`

                            - `List<BetaWebFetchUrlSourceToolReference> tools`

                              - `JsonValue type = "tool_reference"`

                              - `String name`

                          - `class BetaWebFetchUrlSourceExcept`

                            The tool filter variant under which every result but the named
                            tools' contributes.

                            - `JsonValue type = "except"`

                            - `List<BetaWebFetchUrlSourceToolReference> tools`

                              - `JsonValue type = "tool_reference"`

                              - `String name`

                        - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

                            The `url_sources` variant under which a source contributes in
                            full: every result of the tool filter's source, or all user input.

                          - `class BetaWebFetchUrlSourceNone`

                            The `url_sources` variant under which a source contributes nothing:
                            no result of the tool filter's source, or no user input.

                          - `class BetaWebFetchUrlSourceOnly`

                            The tool filter variant under which only the named tools' results
                            contribute.

                          - `class BetaWebFetchUrlSourceExcept`

                            The tool filter variant under which every result but the named
                            tools' contributes.

                        - `Optional<UserInput> userInput`

                          Whether URLs in user messages are fetchable: "all" or "none".

                          - `class BetaWebFetchUrlSourceAll`

                            The `url_sources` variant under which a source contributes in
                            full: every result of the tool filter's source, or all user input.

                          - `class BetaWebFetchUrlSourceNone`

                            The `url_sources` variant under which a source contributes nothing:
                            no result of the tool filter's source, or no user input.

                    - `class BetaWebSearchTool20260209`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                      - `Optional<List<String>> blockedDomains`

                        If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaUserLocation> userLocation`

                        Parameters for the user's location. Used to provide more relevant search results.

                    - `class BetaWebFetchTool20260209`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        List of domains to allow fetching from

                      - `Optional<List<String>> blockedDomains`

                        List of domains to block fetching from

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaCitationsConfigParam> citations`

                        Citations configuration for fetched documents. Citations are disabled by default.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> 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<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaWebFetchUrlSources> urlSources`

                        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                    - `class BetaWebFetchTool20260309`

                      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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        List of domains to allow fetching from

                      - `Optional<List<String>> blockedDomains`

                        List of domains to block fetching from

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaCitationsConfigParam> citations`

                        Citations configuration for fetched documents. Citations are disabled by default.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> 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<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaWebFetchUrlSources> urlSources`

                        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                      - `Optional<Boolean> 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 BetaWebSearchTool20260318`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                      - `Optional<List<String>> blockedDomains`

                        If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<ResponseInclusion> 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<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaUserLocation> userLocation`

                        Parameters for the user's location. Used to provide more relevant search results.

                    - `class BetaWebFetchTool20260318`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        List of domains to allow fetching from

                      - `Optional<List<String>> blockedDomains`

                        List of domains to block fetching from

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaCitationsConfigParam> citations`

                        Citations configuration for fetched documents. Citations are disabled by default.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> 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<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<ResponseInclusion> 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<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaWebFetchUrlSources> urlSources`

                        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                      - `Optional<Boolean> 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 BetaAdvisorTool20260301`

                      - `JsonValue type = "advisor_20260301"`

                      - `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 name = "advisor"`

                        Name of the tool.

                        This is how the tool will be called by the model and in `tool_use` blocks.

                      - `Optional<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaCacheControlEphemeral> caching`

                        Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> maxTokens`

                        Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

                        minimum: 1024

                      - `Optional<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolSearchToolRegex20251119`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaMcpToolset`

                      Configuration for a group of tools from an MCP server.

                      Allows configuring enabled status and defer_loading for all tools
                      from an MCP server, with optional per-tool overrides.

                      - `JsonValue type = "mcp_toolset"`

                      - `String mcpServerName`

                        Name of the MCP server to configure tools for

                        minLength: 1, maxLength: 255

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Configs> configs`

                        Configuration overrides for specific tools, keyed by tool name

                        - `Optional<Boolean> deferLoading`

                        - `Optional<Boolean> enabled`

                      - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

                        Default configuration applied to all tools from this server

                        - `Optional<Boolean> deferLoading`

                        - `Optional<Boolean> enabled`

                      - `Optional<List<BetaMcpToolParam>> tools`

                        The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

                        - `InputSchema inputSchema`

                          The tool's input schema as the MCP server lists it, verbatim.

                        - `String name`

                          The tool's name as the MCP server lists it (not prefixed with the server name).

                          minLength: 1

                        - `Optional<String> description`

                          The tool's description as the MCP server lists it.

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

            - `class BetaRequestToolRemovalBlock`

              Mid-conversation directive to withdraw a tool.

              `tool` references a tool (or MCP toolset) by name: one declared in the
              request's `tools` or defined earlier in `messages`. It is no longer
              offered to the model from this point in the conversation onward.

              - `JsonValue type = "tool_removal"`

              - `Tool tool`

                - `class BetaToolChangeToolReference`

                  Reference to a single tool, by the name the model uses to call it: a
                  tool declared in `tools` or defined by an earlier `tool_addition`
                  block. Does not accept the composed `{server}_{name}` form the server
                  assigns to MCP-resolved tools; use `mcp_tool_reference` or
                  `mcp_toolset_reference` for those.

                - `class BetaToolChangeMcpToolReference`

                  Reference to a single MCP tool by its server and remote name; the
                  same `server_name`/`name` pair `mcp_tool_use` carries.

                - `class BetaToolChangeMcpToolsetReference`

                  Reference to every tool in the named MCP server's toolset.

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

        - `class BetaRequestToolAdditionBlock`

          Mid-conversation directive to make a tool available.

          `tool` is a reference to a tool (or MCP toolset) declared in the
          request's `tools`. Under the `inline-tools-2026-09-15` beta it may
          instead be a reference to a tool defined earlier in `messages`, or a
          `tool_definition` object that carries an inline tool definition in
          `definition` (the same object a `tools` entry holds). An `mcp_toolset`
          definition also requires the `mcp-client-2026-09-15` beta. The tool is
          offered to the model from this point in the conversation onward.

        - `class BetaRequestToolRemovalBlock`

          Mid-conversation directive to withdraw a tool.

          `tool` references a tool (or MCP toolset) by name: one declared in the
          request's `tools` or defined earlier in `messages`. It is no longer
          offered to the model from this point in the conversation onward.

        - `class BetaMcpToolListingBlockParam`

          The tool listing an MCP server returned while an earlier response was
          produced, as that response carried it. Send the assistant message back
          unchanged, this block included, and the server uses this listing for the
          matching `mcp_toolset` instead of asking the MCP server again.

          - `JsonValue type = "mcp_tool_listing"`

          - `String mcpServerName`

            The name of the MCP server this listing came from, as `mcp_servers` declares it.

            minLength: 1, maxLength: 255

          - `List<BetaMcpToolParam> tools`

            The server's tools, exactly as the response listed them.

            - `InputSchema inputSchema`

              The tool's input schema as the MCP server lists it, verbatim.

            - `String name`

              The tool's name as the MCP server lists it (not prefixed with the server name).

              minLength: 1

            - `Optional<String> description`

              The tool's description as the MCP server lists it.

        - `class BetaFallbackBlockParam`

          A `fallback` block echoed back from a prior response.

          Accepted in `messages[].content` and not rendered into the prompt; not
          validated against the request's `fallbacks` chain or top-level `model`.

          Echo the assistant turn back verbatim, including this block in its
          original position. The block marks the boundary between content produced
          before and after a fallback hop, and the server relies on that boundary
          to validate the turn: when thinking runs flank the boundary, omitting
          the block merges them into one span the server cannot validate (the
          request is rejected), and moving it into the middle of a single run is
          likewise rejected; between non-thinking blocks the block's placement has
          no validation effect.

          - `JsonValue type = "fallback"`

          - `BetaFallbackInfoParam from`

            Identifies one hop of a fallback transition.

            - `Model model`

              The model that will complete your prompt.

              See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

          - `BetaFallbackInfoParam to`

            Identifies one hop of a fallback transition.

          - `Optional<JsonValue> trigger`

            The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed.

    - `Role role`

      - `USER("user")`

      - `ASSISTANT("assistant")`

      - `SYSTEM("system")`

    - `Optional<ClearAt> clearAt`

      How long this system message's text stays in front of the model. `"never"` (the default) renders it on every request that includes it. `"next_user_message"` renders it only for the user turn it follows: once a later `role: "user"` message exists in `messages` the message stays in the array (send it unchanged) but is no longer shown to the model. Only permitted on `role: "system"` messages.

      - `NEXT_USER_MESSAGE("next_user_message")`

      - `NEVER("never")`

    - `Optional<BetaSystemMessageOutputConfig> outputConfig`

      Per-message output configuration on a role:"system" input message.

      Fields here apply per-turn; `format` remains top-level only. An
      empty `{}` is accepted on a message that carries content; a message
      with neither content nor output_config fields is rejected.

      - `Optional<Effort> 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")`

  - `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<BetaCacheControlEphemeral> cacheControl`

    Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.

  - `Optional<BetaCompactionConfig> compaction`

    Compaction configuration.

    When set on `POST /v1/messages`, the request is a compaction request: the conversation in `messages` is summarized and the response holds only the resulting `compaction` block (`stop_reason` `"compaction"`), which later requests send first in `messages` in place of the messages it summarizes. `POST /v1/messages/count_tokens` accepts this parameter and ignores it: the count it returns is for the conversation in `messages` as sent. Cannot be combined with `context_management`.

  - `Optional<Container> container`

    Container identifier for reuse across requests.

    - `class BetaContainerParams`

      Container parameters with skills to be loaded.

      - `Optional<String> id`

        Container id

      - `Optional<List<BetaSkillParams>> 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<String> version`

          Skill version or 'latest' for most recent version

          minLength: 1, maxLength: 64

    - `String`

  - `Optional<BetaContextManagementConfig> contextManagement`

    Context management configuration.

    This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not.

  - `Optional<BetaDiagnosticsParam> 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<FallbackCreditToken> fallbackCreditToken`

    The `fallback_credit_token` from a prior refusal's `stop_details`.

    When a preceding request was refused and returned a `fallback_credit_token`,
    pass that code here on the retry to have the retry's cache-creation tokens
    for the prefix that was warm on the refused model billed at the cache-read
    rate. Must be redeemed by the same organization and workspace, with the same
    request body (optionally extended by one appended `assistant` message whose
    content is the partial text — with any trailing whitespace stripped from
    the final text block — and paired server-tool blocks streamed before the
    refusal; the appended-assistant form is not available for requests with
    `output_format` set or forced `tool_choice`), on an eligible fallback
    model, on the same platform,
    and within 5 minutes of the refusal; a mismatch is a 400. A token minted
    mid-server-tool-loop whose partial content was continuable may only be
    redeemed with the appended-assistant form — if an exact-body retry is
    rejected with a 400 saying the token must be redeemed by continuing the
    partial response, retry with the appended-assistant form instead.

    When the appended-assistant form is used on a model that otherwise disallows
    assistant-turn prefill, this token also authorizes that one prefill.

    - `String`

    - `class BetaFallbackCreditTokenParam`

      Object form of `fallback_credit_token`: the token plus a redemption
      mode.

      Requires `anthropic-beta: fallback-credit-2026-07-01`; without that
      header the field accepts the bare string only. The bare string and the
      mode-less object are equivalent (both select `strict`), so wrapping
      an existing token changes nothing by itself.

      - `String token`

        The opaque `fallback_credit_token` from a prior refusal's `stop_details` — the same string the bare-string form carries.

        minLength: 1, maxLength: 2048

      - `Optional<Mode> mode`

        How a failing token affects the retry. `strict` (the default, and the bare-string behavior): a failing redemption is a 400 and the retry is not served. `best_effort`: the retry is served either way — a token-layer failure no longer rejects the request; the retry proceeds at normal price and the outcome is reported on the response's `usage.fallback_credit`. Two failures stay hard in both modes: a malformed token, and combining `fallback_credit_token` with `fallbacks`.

        - `STRICT("strict")`

        - `BEST_EFFORT("best_effort")`

  - `Optional<BetaFallbacksParam> fallbacks`

    Opt-in server-side retry on one or more substitute models when the requested model declines for policy reasons. Tried in order: if the first entry also declines, the second is tried, and so on. Some models don't support fallbacks; on those models, a list of fallback models returns a 400 error. See [Server-side fallback](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=java#server-side-fallback). The string "default" requests the requested model's server-defined default fallback configuration. On a model that doesn't support fallbacks, the request runs on the requested model alone, so a declined request stays declined.

  - `Optional<String> inferenceGeo`

    Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used.

  - `Optional<List<BetaRequestMcpServerUrlDefinition>> mcpServers`

    MCP servers to be utilized in this request

    maxItems: 20

    - `JsonValue type = "url"`

    - `String name`

    - `String url`

    - `Optional<String> authorizationToken`

    - `Optional<BetaRequestMcpServerToolConfiguration> toolConfiguration`

      - `Optional<List<String>> allowedTools`

      - `Optional<Boolean> enabled`

  - `Optional<BetaMetadata> metadata`

    An object describing metadata about the request.

  - `Optional<BetaOutputConfig> outputConfig`

    Configuration options for the model's output, such as the output format.

  - `Optional<ServiceTier> 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> 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<List<String>> 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`

    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<BetaTextBlockParam>`

      - `JsonValue type = "text"`

      - `String text`

        minLength: 1

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<List<BetaTextCitationParam>> citations`

  - `Optional<BetaThinkingConfigParam> 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<BetaToolChoice> 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<List<BetaToolUnion>> 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 BetaTool`

    - `class BetaToolBash20241022`

    - `class BetaToolBash20250124`

    - `class BetaCodeExecutionTool20250522`

    - `class BetaCodeExecutionTool20250825`

    - `class BetaCodeExecutionTool20260120`

      Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).

    - `class BetaCodeExecutionTool20260521`

      Code execution tool with REPL state persistence.

    - `class BetaBrowserToolset20260801`

      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.

    - `class BetaToolComputerUse20241022`

    - `class BetaMemoryTool20250818`

    - `class BetaToolComputerUse20250124`

    - `class BetaToolTextEditor20241022`

    - `class BetaToolComputerUse20251124`

    - `class BetaComputerToolset20260801`

      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`.

    - `class BetaToolTextEditor20250124`

    - `class BetaToolTextEditor20250429`

    - `class BetaToolTextEditor20250728`

    - `class BetaWebSearchTool20250305`

    - `class BetaWebFetchTool20250910`

    - `class BetaWebSearchTool20260209`

    - `class BetaWebFetchTool20260209`

    - `class BetaWebFetchTool20260309`

      Web fetch tool with use_cache parameter for bypassing cached content.

    - `class BetaWebSearchTool20260318`

    - `class BetaWebFetchTool20260318`

    - `class BetaAdvisorTool20260301`

    - `class BetaToolSearchToolBm25_20251119`

    - `class BetaToolSearchToolRegex20251119`

    - `class BetaMcpToolset`

      Configuration for a group of tools from an MCP server.

      Allows configuring enabled status and defer_loading for all tools
      from an MCP server, with optional per-tool overrides.

  - `Optional<BetaJsonOutputFormat> outputFormat`

    **Deprecated**

    Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=java)

    A schema to specify Claude's output format in responses. This parameter will be removed in a future release.

  - `Optional<Double> 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<Long> 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<Double> 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 BetaMessage`

  - `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<BetaContainer> 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<List<BetaContainerSkill>> 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<BetaContentBlock> 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 BetaTextBlock`

      - `JsonValue type = "text"`

      - `Optional<List<BetaTextCitation>> 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 BetaCitationCharLocation`

          - `JsonValue type = "char_location"`

          - `String citedText`

          - `long documentIndex`

            minimum: 0

          - `Optional<String> documentTitle`

          - `long endCharIndex`

          - `Optional<String> fileId`

          - `long startCharIndex`

            minimum: 0

        - `class BetaCitationPageLocation`

          - `JsonValue type = "page_location"`

          - `String citedText`

          - `long documentIndex`

            minimum: 0

          - `Optional<String> documentTitle`

          - `long endPageNumber`

          - `Optional<String> fileId`

          - `long startPageNumber`

            minimum: 1

        - `class BetaCitationContentBlockLocation`

          - `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<String> 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<String> fileId`

          - `long startBlockIndex`

            0-based index of the first cited block in the source's `content` array.

            minimum: 0

        - `class BetaCitationsWebSearchResultLocation`

          - `JsonValue type = "web_search_result_location"`

          - `String citedText`

          - `String encryptedIndex`

          - `Optional<String> title`

            maxLength: 512

          - `String url`

        - `class BetaCitationSearchResultLocation`

          - `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<String> title`

      - `String text`

    - `class BetaThinkingBlock`

      - `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 BetaRedactedThinkingBlock`

      - `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 BetaToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `Input input`

      - `String name`

        minLength: 1

      - `Optional<Caller> caller`

        - `class BetaDirectCaller`

          Tool invocation directly from the model.

          - `JsonValue type = "direct"`

        - `class BetaServerToolCaller`

          Tool invocation generated by a server-side tool.

          - `JsonValue type = "code_execution_20250825"`

          - `String toolId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `class BetaServerToolCaller20260120`

          - `JsonValue type = "code_execution_20260120"`

          - `String toolId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `Optional<String> toolsetName`

        For a toolset member tool_use, the toolset family.

        minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$

    - `class BetaServerToolUseBlock`

      - `JsonValue type = "server_tool_use"`

      - `String id`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `Input input`

      - `Name name`

        - `ADVISOR("advisor")`

        - `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<Caller> caller`

        - `class BetaDirectCaller`

          Tool invocation directly from the model.

        - `class BetaServerToolCaller`

          Tool invocation generated by a server-side tool.

        - `class BetaServerToolCaller20260120`

    - `class BetaWebSearchToolResultBlock`

      - `JsonValue type = "web_search_tool_result"`

      - `BetaWebSearchToolResultBlockContent content`

        - `class BetaWebSearchToolResultError`

          - `JsonValue type = "web_search_tool_result_error"`

          - `BetaWebSearchToolResultErrorCode 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<BetaWebSearchResultBlock>`

          - `JsonValue type = "web_search_result"`

          - `String encryptedContent`

          - `Optional<String> pageAge`

          - `String title`

          - `String url`

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `Optional<Caller> caller`

        - `class BetaDirectCaller`

          Tool invocation directly from the model.

        - `class BetaServerToolCaller`

          Tool invocation generated by a server-side tool.

        - `class BetaServerToolCaller20260120`

    - `class BetaWebFetchToolResultBlock`

      - `JsonValue type = "web_fetch_tool_result"`

      - `Content content`

        - `class BetaWebFetchToolResultErrorBlock`

          - `JsonValue type = "web_fetch_tool_result_error"`

          - `BetaWebFetchToolResultErrorCode 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 BetaWebFetchBlock`

          - `JsonValue type = "web_fetch_result"`

          - `BetaDocumentBlock content`

            - `JsonValue type = "document"`

            - `Optional<BetaCitationConfig> citations`

              Citation configuration for the document

              - `boolean enabled`

            - `Source source`

              - `class BetaBase64PdfSource`

                - `JsonValue type = "base64"`

                - `String data`

                  format: byte

                - `JsonValue mediaType = "application/pdf"`

              - `class BetaPlainTextSource`

                - `JsonValue type = "text"`

                - `String data`

                - `JsonValue mediaType = "text/plain"`

            - `Optional<String> title`

              The title of the document

          - `Optional<String> retrievedAt`

            ISO 8601 timestamp when the content was retrieved

          - `String url`

            Fetched content URL

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `Optional<Caller> caller`

        - `class BetaDirectCaller`

          Tool invocation directly from the model.

        - `class BetaServerToolCaller`

          Tool invocation generated by a server-side tool.

        - `class BetaServerToolCaller20260120`

    - `class BetaAdvisorToolResultBlock`

      - `JsonValue type = "advisor_tool_result"`

      - `Content content`

        - `class BetaAdvisorToolResultError`

          - `JsonValue type = "advisor_tool_result_error"`

          - `ErrorCode errorCode`

            - `MAX_USES_EXCEEDED("max_uses_exceeded")`

            - `PROMPT_TOO_LONG("prompt_too_long")`

            - `TOO_MANY_REQUESTS("too_many_requests")`

            - `OVERLOADED("overloaded")`

            - `UNAVAILABLE("unavailable")`

            - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

            - `MODEL_NOT_FOUND("model_not_found")`

        - `class BetaAdvisorResultBlock`

          - `JsonValue type = "advisor_result"`

          - `Optional<String> stopReason`

            The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap.

          - `String text`

        - `class BetaAdvisorRedactedResultBlock`

          - `JsonValue type = "advisor_redacted_result"`

          - `String encryptedContent`

            Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify.

          - `Optional<String> stopReason`

            The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`).

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaCodeExecutionToolResultBlock`

      - `JsonValue type = "code_execution_tool_result"`

      - `BetaCodeExecutionToolResultBlockContent content`

        - `class BetaCodeExecutionToolResultError`

          - `JsonValue type = "code_execution_tool_result_error"`

          - `BetaCodeExecutionToolResultErrorCode errorCode`

            - `INVALID_TOOL_INPUT("invalid_tool_input")`

            - `UNAVAILABLE("unavailable")`

            - `TOO_MANY_REQUESTS("too_many_requests")`

            - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

        - `class BetaCodeExecutionResultBlock`

          - `JsonValue type = "code_execution_result"`

          - `List<BetaCodeExecutionOutputBlock> content`

            - `JsonValue type = "code_execution_output"`

            - `String fileId`

          - `long returnCode`

          - `String stderr`

          - `String stdout`

        - `class BetaEncryptedCodeExecutionResultBlock`

          Code execution result with encrypted stdout for PFC + web_search results.

          - `JsonValue type = "encrypted_code_execution_result"`

          - `List<BetaCodeExecutionOutputBlock> content`

            - `JsonValue type = "code_execution_output"`

            - `String fileId`

          - `String encryptedStdout`

          - `long returnCode`

          - `String stderr`

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaBashCodeExecutionToolResultBlock`

      - `JsonValue type = "bash_code_execution_tool_result"`

      - `Content content`

        - `class BetaBashCodeExecutionToolResultError`

          - `JsonValue type = "bash_code_execution_tool_result_error"`

          - `ErrorCode 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 BetaBashCodeExecutionResultBlock`

          - `JsonValue type = "bash_code_execution_result"`

          - `List<BetaBashCodeExecutionOutputBlock> content`

            - `JsonValue type = "bash_code_execution_output"`

            - `String fileId`

          - `long returnCode`

          - `String stderr`

          - `String stdout`

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaTextEditorCodeExecutionToolResultBlock`

      - `JsonValue type = "text_editor_code_execution_tool_result"`

      - `Content content`

        - `class BetaTextEditorCodeExecutionToolResultError`

          - `JsonValue type = "text_editor_code_execution_tool_result_error"`

          - `ErrorCode 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<String> errorMessage`

        - `class BetaTextEditorCodeExecutionViewResultBlock`

          - `JsonValue type = "text_editor_code_execution_view_result"`

          - `String content`

          - `FileType fileType`

            - `TEXT("text")`

            - `IMAGE("image")`

            - `PDF("pdf")`

          - `Optional<Long> numLines`

          - `Optional<Long> startLine`

          - `Optional<Long> totalLines`

        - `class BetaTextEditorCodeExecutionCreateResultBlock`

          - `JsonValue type = "text_editor_code_execution_create_result"`

          - `boolean isFileUpdate`

        - `class BetaTextEditorCodeExecutionStrReplaceResultBlock`

          - `JsonValue type = "text_editor_code_execution_str_replace_result"`

          - `Optional<List<String>> lines`

          - `Optional<Long> newLines`

          - `Optional<Long> newStart`

          - `Optional<Long> oldLines`

          - `Optional<Long> oldStart`

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaToolSearchToolResultBlock`

      - `JsonValue type = "tool_search_tool_result"`

      - `Content content`

        - `class BetaToolSearchToolResultError`

          - `JsonValue type = "tool_search_tool_result_error"`

          - `ErrorCode errorCode`

            - `INVALID_TOOL_INPUT("invalid_tool_input")`

            - `UNAVAILABLE("unavailable")`

            - `TOO_MANY_REQUESTS("too_many_requests")`

            - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

          - `Optional<String> errorMessage`

        - `class BetaToolSearchToolSearchResultBlock`

          - `JsonValue type = "tool_search_tool_search_result"`

          - `List<BetaToolReferenceBlock> 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 BetaMcpToolUseBlock`

      - `JsonValue type = "mcp_tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `Input input`

      - `String name`

        The name of the MCP tool

      - `String serverName`

        The name of the MCP server

    - `class BetaMcpToolResultBlock`

      - `JsonValue type = "mcp_tool_result"`

      - `Content content`

        - `String`

        - `List<BetaTextBlock>`

          - `JsonValue type = "text"`

          - `Optional<List<BetaTextCitation>> 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`.

          - `String text`

      - `boolean isError`

      - `String toolUseId`

        pattern: ^[a-zA-Z0-9_-]+$

    - `class BetaContainerUploadBlock`

      Response model for a file uploaded to the container.

      - `JsonValue type = "container_upload"`

      - `String fileId`

    - `class BetaCompactionBlock`

      A compaction block returned when autocompact is triggered.

      When content is None, it indicates the compaction failed to produce a valid
      summary (e.g., malformed output from the model). Clients may round-trip
      compaction blocks with null content; the server treats them as no-ops.

      - `JsonValue type = "compaction"`

      - `Optional<String> content`

        Summary of compacted content, or null if compaction failed

      - `Optional<String> encryptedContent`

        Opaque metadata from prior compaction, to be round-tripped verbatim

      - `Optional<String> signature`

        Signature over the summary, to be sent back with the block verbatim

      - `Optional<List<ToolChange>> toolChanges`

        The tool changes of the compacted range: the `tool_addition` and `tool_removal` blocks that take the request's `tools` to the tool set in effect at the end of the range, or `[]` when the range changed no tool. Absent when the server did not compute them. Send the block back unchanged.

        - `class BetaResponseToolAdditionBlock`

          An entry of a `compaction` block's `tool_changes`: a tool the
          compacted range made available, as a reference to a `tools` entry or
          MCP toolset, or as the tool definition in effect at the end of the
          range, by value. Send it back unchanged.

          - `JsonValue type = "tool_addition"`

          - `Tool tool`

            The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value.

            - `class BetaResponseToolChangeToolReference`

              Reference to a single tool, by the name the model uses to call it, as
              a `compaction` block's `tool_changes` entry reports it: a tool
              declared in `tools` or defined by an earlier `tool_addition` block.
              Send it back unchanged with the block.

              - `JsonValue type = "tool_reference"`

              - `String name`

            - `class BetaResponseToolChangeMcpToolReference`

              Reference to a single MCP tool, by its server and its name on that
              server, as a `compaction` block's `tool_changes` entry reports it.
              Send it back unchanged with the block.

              - `JsonValue type = "mcp_tool_reference"`

              - `String name`

              - `String serverName`

            - `class BetaResponseToolChangeMcpToolsetReference`

              Reference to every tool in the named MCP server's toolset, as a
              `compaction` block's `tool_changes` entry reports it. Send it back
              unchanged with the block.

              - `JsonValue type = "mcp_toolset_reference"`

              - `String serverName`

            - `class BetaToolChangeToolDefinition`

              A tool defined by value, as a `compaction` block's `tool_changes` entry
              reports it: `definition` is the tool's definition as it was sent, in the
              form of a `tools` entry, without `cache_control`. Send it back unchanged
              with the block.

              - `JsonValue type = "tool_definition"`

              - `BetaResponseToolUnion definition`

                - `class BetaResponseTool`

                  A custom tool definition, as sent.

                  - `Optional<Type> type`

                  - `BetaResponseToolInputSchema 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> properties`

                    - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolBash20241022`

                  - `JsonValue type = "bash_20241022"`

                  - `JsonValue name = "bash"`

                    Name of the tool.

                    This is how the tool will be called by the model and in `tool_use` blocks.

                  - `Optional<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                    - `JsonValue type = "ephemeral"`

                    - `Optional<Ttl> 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<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolBash20250124`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaCodeExecutionTool20250522`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaCodeExecutionTool20250825`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaCodeExecutionTool20260120`

                  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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaCodeExecutionTool20260521`

                  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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaBrowserToolset20260801`

                  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<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

                      `type`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserCloseTabConfig> closeTab`

                      `close_tab`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

                      `double_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserFileUploadConfig> fileUpload`

                      `file_upload`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserFindConfig> find`

                      `find`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserFormInputConfig> formInput`

                      `form_input`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserGetPageTextConfig> getPageText`

                      `get_page_text`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserHoldKeyConfig> holdKey`

                      `hold_key`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserHoverConfig> hover`

                      `hover`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

                      `javascript_exec`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserKeyConfig> key`

                      `key`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserLeftClickConfig> leftClick`

                      `left_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

                      `left_click_drag`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

                      `left_mouse_down`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

                      `left_mouse_up`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserListTabsConfig> listTabs`

                      `list_tabs`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserMiddleClickConfig> middleClick`

                      `middle_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

                      `mouse_move`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserNavigateConfig> navigate`

                      `navigate`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserNewTabConfig> newTab`

                      `new_tab`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserReadConsoleConfig> readConsole`

                      `read_console`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

                      `read_network`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserReadPageConfig> readPage`

                      `read_page`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserRightClickConfig> rightClick`

                      `right_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserScreenshotConfig> screenshot`

                      `screenshot`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserScrollConfig> scroll`

                      `scroll`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserScrollToConfig> scrollTo`

                      `scroll_to`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserSwitchTabConfig> switchTab`

                      `switch_tab`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserTripleClickConfig> tripleClick`

                      `triple_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserWaitConfig> wait`

                      `wait`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserZoomConfig> zoom`

                      `zoom`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered 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 BetaToolComputerUse20241022`

                  - `JsonValue type = "computer_20241022"`

                  - `long displayHeightPx`

                    The height of the display in pixels.

                    minimum: 1

                  - `long displayWidthPx`

                    The width of the display in pixels.

                    minimum: 1

                  - `JsonValue name = "computer"`

                    Name of the tool.

                    This is how the tool will be called by the model and in `tool_use` blocks.

                  - `Optional<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> displayNumber`

                    The X11 display number (e.g. 0, 1) for the display.

                    minimum: 0

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaMemoryTool20250818`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolComputerUse20250124`

                  - `JsonValue type = "computer_20250124"`

                  - `long displayHeightPx`

                    The height of the display in pixels.

                    minimum: 1

                  - `long displayWidthPx`

                    The width of the display in pixels.

                    minimum: 1

                  - `JsonValue name = "computer"`

                    Name of the tool.

                    This is how the tool will be called by the model and in `tool_use` blocks.

                  - `Optional<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> displayNumber`

                    The X11 display number (e.g. 0, 1) for the display.

                    minimum: 0

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolTextEditor20241022`

                  - `JsonValue type = "text_editor_20241022"`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolComputerUse20251124`

                  - `JsonValue type = "computer_20251124"`

                  - `long displayHeightPx`

                    The height of the display in pixels.

                    minimum: 1

                  - `long displayWidthPx`

                    The width of the display in pixels.

                    minimum: 1

                  - `JsonValue name = "computer"`

                    Name of the tool.

                    This is how the tool will be called by the model and in `tool_use` blocks.

                  - `Optional<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> displayNumber`

                    The X11 display number (e.g. 0, 1) for the display.

                    minimum: 0

                  - `Optional<Boolean> enableZoom`

                    Whether to enable an action to take a zoomed-in screenshot of the screen.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaComputerToolset20260801`

                  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<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

                      `type`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

                      `cursor_position`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerDoubleClickConfig> doubleClick`

                      `double_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerHoldKeyConfig> holdKey`

                      `hold_key`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerKeyConfig> key`

                      `key`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerLeftClickConfig> leftClick`

                      `left_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

                      `left_click_drag`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

                      `left_mouse_down`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

                      `left_mouse_up`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerMiddleClickConfig> middleClick`

                      `middle_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerMouseMoveConfig> mouseMove`

                      `mouse_move`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerRightClickConfig> rightClick`

                      `right_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerScreenshotConfig> screenshot`

                      `screenshot`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerScrollConfig> scroll`

                      `scroll`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerTripleClickConfig> tripleClick`

                      `triple_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerWaitConfig> wait`

                      `wait`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerZoomConfig> zoom`

                      `zoom`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered 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 BetaToolTextEditor20250124`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolTextEditor20250429`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolTextEditor20250728`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Long> maxCharacters`

                    Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaWebSearchTool20250305`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                  - `Optional<List<String>> blockedDomains`

                    If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaUserLocation> userLocation`

                    Parameters for the user's location. Used to provide more relevant search results.

                    - `JsonValue type = "approximate"`

                    - `Optional<String> city`

                      The city of the user.

                      minLength: 1, maxLength: 255

                    - `Optional<String> 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<String> region`

                      The region of the user.

                      minLength: 1, maxLength: 255

                    - `Optional<String> timezone`

                      The [IANA timezone](https://nodatime.org/TimeZones) of the user.

                      minLength: 1, maxLength: 255

                - `class BetaWebFetchTool20250910`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    List of domains to allow fetching from

                  - `Optional<List<String>> blockedDomains`

                    List of domains to block fetching from

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaCitationsConfigParam> citations`

                    Citations configuration for fetched documents. Citations are disabled by default.

                    - `Optional<Boolean> enabled`

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> 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<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaWebFetchUrlSources> urlSources`

                    Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                    - `Optional<ClientToolResults> clientToolResults`

                      Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

                      - `class BetaWebFetchUrlSourceAll`

                        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 BetaWebFetchUrlSourceNone`

                        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 BetaWebFetchUrlSourceOnly`

                        The tool filter variant under which only the named tools' results
                        contribute.

                        - `JsonValue type = "only"`

                        - `List<BetaWebFetchUrlSourceToolReference> tools`

                          - `JsonValue type = "tool_reference"`

                          - `String name`

                      - `class BetaWebFetchUrlSourceExcept`

                        The tool filter variant under which every result but the named
                        tools' contributes.

                        - `JsonValue type = "except"`

                        - `List<BetaWebFetchUrlSourceToolReference> tools`

                          - `JsonValue type = "tool_reference"`

                          - `String name`

                    - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

                        The `url_sources` variant under which a source contributes in
                        full: every result of the tool filter's source, or all user input.

                      - `class BetaWebFetchUrlSourceNone`

                        The `url_sources` variant under which a source contributes nothing:
                        no result of the tool filter's source, or no user input.

                      - `class BetaWebFetchUrlSourceOnly`

                        The tool filter variant under which only the named tools' results
                        contribute.

                      - `class BetaWebFetchUrlSourceExcept`

                        The tool filter variant under which every result but the named
                        tools' contributes.

                    - `Optional<UserInput> userInput`

                      Whether URLs in user messages are fetchable: "all" or "none".

                      - `class BetaWebFetchUrlSourceAll`

                        The `url_sources` variant under which a source contributes in
                        full: every result of the tool filter's source, or all user input.

                      - `class BetaWebFetchUrlSourceNone`

                        The `url_sources` variant under which a source contributes nothing:
                        no result of the tool filter's source, or no user input.

                - `class BetaWebSearchTool20260209`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                  - `Optional<List<String>> blockedDomains`

                    If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaUserLocation> userLocation`

                    Parameters for the user's location. Used to provide more relevant search results.

                - `class BetaWebFetchTool20260209`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    List of domains to allow fetching from

                  - `Optional<List<String>> blockedDomains`

                    List of domains to block fetching from

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaCitationsConfigParam> citations`

                    Citations configuration for fetched documents. Citations are disabled by default.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> 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<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaWebFetchUrlSources> urlSources`

                    Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                - `class BetaWebFetchTool20260309`

                  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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    List of domains to allow fetching from

                  - `Optional<List<String>> blockedDomains`

                    List of domains to block fetching from

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaCitationsConfigParam> citations`

                    Citations configuration for fetched documents. Citations are disabled by default.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> 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<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaWebFetchUrlSources> urlSources`

                    Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                  - `Optional<Boolean> 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 BetaWebSearchTool20260318`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                  - `Optional<List<String>> blockedDomains`

                    If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<ResponseInclusion> 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<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaUserLocation> userLocation`

                    Parameters for the user's location. Used to provide more relevant search results.

                - `class BetaWebFetchTool20260318`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    List of domains to allow fetching from

                  - `Optional<List<String>> blockedDomains`

                    List of domains to block fetching from

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaCitationsConfigParam> citations`

                    Citations configuration for fetched documents. Citations are disabled by default.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> 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<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<ResponseInclusion> 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<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaWebFetchUrlSources> urlSources`

                    Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                  - `Optional<Boolean> 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 BetaAdvisorTool20260301`

                  - `JsonValue type = "advisor_20260301"`

                  - `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 name = "advisor"`

                    Name of the tool.

                    This is how the tool will be called by the model and in `tool_use` blocks.

                  - `Optional<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaCacheControlEphemeral> caching`

                    Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> maxTokens`

                    Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

                    minimum: 1024

                  - `Optional<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolSearchToolRegex20251119`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaMcpToolset`

                  Configuration for a group of tools from an MCP server.

                  Allows configuring enabled status and defer_loading for all tools
                  from an MCP server, with optional per-tool overrides.

                  - `JsonValue type = "mcp_toolset"`

                  - `String mcpServerName`

                    Name of the MCP server to configure tools for

                    minLength: 1, maxLength: 255

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Configs> configs`

                    Configuration overrides for specific tools, keyed by tool name

                    - `Optional<Boolean> deferLoading`

                    - `Optional<Boolean> enabled`

                  - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

                    Default configuration applied to all tools from this server

                    - `Optional<Boolean> deferLoading`

                    - `Optional<Boolean> enabled`

                  - `Optional<List<BetaMcpToolParam>> tools`

                    The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

                    - `InputSchema inputSchema`

                      The tool's input schema as the MCP server lists it, verbatim.

                    - `String name`

                      The tool's name as the MCP server lists it (not prefixed with the server name).

                      minLength: 1

                    - `Optional<String> description`

                      The tool's description as the MCP server lists it.

        - `class BetaResponseToolRemovalBlock`

          An entry of a `compaction` block's `tool_changes`: a tool of the
          request's `tools` (or an MCP tool or toolset) that the compacted range
          withdrew. Send it back unchanged.

          - `JsonValue type = "tool_removal"`

          - `Tool tool`

            A reference to the withdrawn `tools` entry, MCP tool or MCP toolset.

            - `class BetaResponseToolChangeToolReference`

              Reference to a single tool, by the name the model uses to call it, as
              a `compaction` block's `tool_changes` entry reports it: a tool
              declared in `tools` or defined by an earlier `tool_addition` block.
              Send it back unchanged with the block.

            - `class BetaResponseToolChangeMcpToolReference`

              Reference to a single MCP tool, by its server and its name on that
              server, as a `compaction` block's `tool_changes` entry reports it.
              Send it back unchanged with the block.

            - `class BetaResponseToolChangeMcpToolsetReference`

              Reference to every tool in the named MCP server's toolset, as a
              `compaction` block's `tool_changes` entry reports it. Send it back
              unchanged with the block.

    - `class BetaFallbackBlock`

      Marks the point in `content` where one model's output gives way to the next.

      One block appears per hop where a preceding model actually ran this turn and
      declined. A turn where no preceding model ran and declined has no such
      boundary and carries no block — the signal for whether a fallback model
      served the response is the presence of a `fallback_message` entry in
      `usage.iterations`, not this block.

      The block is treated like a server-tool content block for streaming: it
      arrives via the standard `content_block_start` / `content_block_stop`
      pair and carries no deltas.

      - `JsonValue type = "fallback"`

      - `BetaFallbackInfo from`

        The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id.

        - `Model model`

          The model that will complete your prompt.

          See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

      - `BetaFallbackInfo to`

        The fallback model producing the content that follows this block. Its `model` is always the canonical id.

      - `BetaFallbackRefusalTrigger trigger`

        What caused the `from` model to hand over at this hop.

        - `JsonValue type = "refusal"`

        - `Optional<Category> category`

          The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.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.

    - `class BetaMcpToolListingBlock`

      The tool listing the server fetched from an MCP server while producing
      this response. Send the assistant message back unchanged, this block
      included, so later requests use this listing instead of asking the MCP
      server again.

      - `JsonValue type = "mcp_tool_listing"`

      - `String mcpServerName`

      - `List<BetaMcpTool> tools`

        - `InputSchema inputSchema`

        - `String name`

        - `Optional<String> description`

  - `Optional<BetaContextManagementResponse> contextManagement`

    Context management response.

    Information about context management strategies applied during the request.

    - `List<AppliedEdit> appliedEdits`

      List of context management edits that were applied.

      - `class BetaClearToolUses20250919EditResponse`

        - `JsonValue type = "clear_tool_uses_20250919"`

          The type of context management edit applied.

        - `long clearedInputTokens`

          Number of input tokens cleared by this edit.

          minimum: 0

        - `long clearedToolUses`

          Number of tool uses that were cleared.

          minimum: 0

      - `class BetaClearThinking20251015EditResponse`

        - `JsonValue type = "clear_thinking_20251015"`

          The type of context management edit applied.

        - `long clearedInputTokens`

          Number of input tokens cleared by this edit.

          minimum: 0

        - `long clearedThinkingTurns`

          Number of thinking turns that were cleared.

          minimum: 0

  - `Optional<BetaDiagnostics> diagnostics`

    Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected.

    - `Optional<BetaCacheMissReason> 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 BetaCacheMissModelChanged`

        - `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 BetaCacheMissSystemChanged`

        - `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 BetaCacheMissToolsChanged`

        - `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 BetaCacheMissMessagesChanged`

        - `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 BetaCacheMissPreviousMessageNotFound`

        - `JsonValue type = "previous_message_not_found"`

      - `class BetaCacheMissUnavailable`

        - `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.

  - `JsonValue role = "assistant"`

    Conversational role of the generated message.

    This will always be `"assistant"`.

  - `Optional<BetaRefusalStopDetails> 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> 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<String> 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<String> fallbackCreditToken`

      Opaque code that refunds the cache-miss cost when retrying this refused
      request on the fallback model. Pass it as `fallback_credit_token` on the
      retry request. Expires 5 minutes after the refusal.

      The retry is sent either with the same request body (`system`, `messages`,
      `tools`, and other render-shaping fields), or with the same body plus one
      appended `assistant` message whose content is the partial text (with any
      trailing whitespace stripped from the final text block) and paired
      server-tool blocks from this refusal — which also authorizes that
      appended turn as an assistant-prefill continuation on models that otherwise
      disallow prefill. A token minted mid-server-tool-loop whose partial content
      was continuable may only be redeemed the second way — if a same-body retry
      is rejected with a 400 saying the token must be redeemed by continuing the
      partial response, retry the second way instead. Either way: same workspace,
      same platform; a mismatch is a 400. Resending a token for an already-warm
      prefix is permitted but yields no additional credit.

      `null` when the refused model isn't eligible for a fallback credit.

    - `Optional<Boolean> fallbackHasPrefillClaim`

      Whether the accompanying `fallback_credit_token` may be redeemed with the
      appended-assistant retry form. Only set when `fallback_credit_token` is
      present.

      `true`: retry by resending the same request body plus one appended
      `assistant` message whose content is this response's `content` with any
      trailing whitespace stripped from the final text block and unpaired
      `tool_use` blocks omitted (the same appended-turn shape described on
      `fallback_credit_token`), with the token attached. `false`: retry by
      resending the original request body unchanged, with the token attached —
      the appended-assistant form is not available for this refusal (no
      continuable partial content, or the request uses `output_format` or a
      `tool_choice` that forces tool use). One exception: when the request used
      `output_format` or a forced `tool_choice` and the refusal arrived after
      server tools (including MCP connector tools) had already executed, the
      token may not be redeemable by either retry form; if the exact-body retry
      is then rejected with a 400 saying the token must be redeemed by
      continuing the partial response, discard the token and retry without it.

      Advisory: if an appended-assistant retry is rejected with a 400 despite
      `true`, fall back to resending the original request body with the token.

    - `Optional<String> recommendedModel`

      The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise.

  - `Optional<BetaStopReason> 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")`

    - `COMPACTION("compaction")`

    - `REFUSAL("refusal")`

    - `MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")`

  - `Optional<String> 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.

  - `BetaUsage 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<BetaCacheCreation> 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<Long> cacheCreationInputTokens`

      The number of input tokens used to create the cache entry.

      minimum: 0

    - `Optional<Long> cacheReadInputTokens`

      The number of input tokens read from the cache.

      minimum: 0

    - `Optional<BetaFallbackCreditUsage> fallbackCredit`

      Outcome of the `fallback_credit_token` presented on this request.

      Present on every response to a non-batch request that carried a
      `fallback_credit_token`, in either redemption mode; absent otherwise (batch
      items accept and ignore the token and carry no outcome object).

      - `Status status`

        Whether the fallback-credit reprice was applied to this response's billing.

        A union discriminated on `type`. `redeemed`: the retry is billed as if
        the conversation had been on the retry model all along — including when the
        resulting shift is zero because there was nothing to move. `not_applied`:
        no reprice was applied; the arm's `reason` says why.

        - `class BetaFallbackCreditRedeemed`

          The reprice was applied: the retry is billed as if the conversation
          had been on the retry model all along.

          - `JsonValue type = "redeemed"`

        - `class BetaFallbackCreditNotApplied`

          No reprice was applied; `reason` says why.

          - `JsonValue type = "not_applied"`

          - `Reason reason`

            Why the reprice was not applied.

            A closed enum; additions to the redemption-check vocabulary arrive as
            deliberate schema updates.

            - `BODY_MISMATCH("body_mismatch")`

            - `CONTINUATION_EXCLUDED("continuation_excluded")`

            - `CONTINUATION_ONLY("continuation_only")`

            - `EXPIRED("expired")`

            - `INVALID_TARGET_MODEL("invalid_target_model")`

            - `NOT_ENABLED("not_enabled")`

            - `REPRICE_UNAVAILABLE("reprice_unavailable")`

            - `TEMPORARILY_UNAVAILABLE("temporarily_unavailable")`

            - `VARIANT_FIELDS_PRESENT("variant_fields_present")`

            - `WRONG_ORGANIZATION("wrong_organization")`

            - `WRONG_PLATFORM("wrong_platform")`

            - `WRONG_WORKSPACE("wrong_workspace")`

          - `Optional<List<String>> removeToRedeem`

            Request fields to remove before retrying, so the retry can redeem this
            token.

            Present exactly when `reason` is `variant_fields_present` — never null,
            never an empty array; absent otherwise. Fields are named only from your own request, and only after
            the sealed variant hash matched. A served best-effort retry has already
            been billed at normal price; nothing redeems retroactively, but a corrected
            re-send inside the token's five-minute window can still redeem.

    - `Optional<String> inferenceGeo`

      The geographic region where inference was performed for this request.

    - `long inputTokens`

      The number of input tokens which were used.

      minimum: 0

    - `Optional<List<Iteration>> iterations`

      Per-iteration token usage breakdown.

      Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to:

      - Calculate the context window size from the last `message` entry
      - Understand token accumulation across server-side tool use loops

      A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results.

      - `class BetaMessageIterationUsage`

        Token usage for a sampling iteration.

        - `JsonValue type = "message"`

          Usage for a sampling iteration

        - `Optional<BetaCacheCreation> cacheCreation`

          Breakdown of cached tokens by TTL

        - `long cacheCreationInputTokens`

          The number of input tokens used to create the cache entry.

          minimum: 0

        - `long cacheReadInputTokens`

          The number of input tokens read from the cache.

          minimum: 0

        - `long inputTokens`

          The number of input tokens which were used.

          minimum: 0

        - `Optional<Model> model`

          The model that will complete your prompt.

          See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

        - `long outputTokens`

          The number of output tokens which were used.

          minimum: 0

      - `class BetaCompactionIterationUsage`

        Token usage for a compaction iteration.

        - `JsonValue type = "compaction"`

          Usage for a compaction iteration

        - `Optional<BetaCacheCreation> cacheCreation`

          Breakdown of cached tokens by TTL

        - `long cacheCreationInputTokens`

          The number of input tokens used to create the cache entry.

          minimum: 0

        - `long cacheReadInputTokens`

          The number of input tokens read from the cache.

          minimum: 0

        - `long inputTokens`

          The number of input tokens which were used.

          minimum: 0

        - `long outputTokens`

          The number of output tokens which were used.

          minimum: 0

      - `class BetaAdvisorMessageIterationUsage`

        Token usage for an advisor sub-inference iteration.

        - `JsonValue type = "advisor_message"`

          Usage for an advisor sub-inference iteration

        - `Optional<BetaCacheCreation> cacheCreation`

          Breakdown of cached tokens by TTL

        - `long cacheCreationInputTokens`

          The number of input tokens used to create the cache entry.

          minimum: 0

        - `long cacheReadInputTokens`

          The number of input tokens read from the cache.

          minimum: 0

        - `long inputTokens`

          The number of input tokens which were used.

          minimum: 0

        - `Model model`

          The model that will complete your prompt.

          See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

        - `long outputTokens`

          The number of output tokens which were used.

          minimum: 0

      - `class BetaFallbackMessageIterationUsage`

        Token usage for the fallback-model attempt of a server-side fallback request.

        The terminal entry of a fallback-served turn: when a fallback hop's
        output is the returned message, the entry for the iteration that
        completed it carries this type in place of `message`. A declined hop
        and the serving hop's earlier tool-loop iterations produce `message`
        entries. Whether a fallback model served the response is signalled by
        the presence of this entry in `usage.iterations`.

        - `JsonValue type = "fallback_message"`

          Usage for the fallback-model attempt that served the response

        - `Optional<BetaCacheCreation> cacheCreation`

          Breakdown of cached tokens by TTL

        - `long cacheCreationInputTokens`

          The number of input tokens used to create the cache entry.

          minimum: 0

        - `long cacheReadInputTokens`

          The number of input tokens read from the cache.

          minimum: 0

        - `long inputTokens`

          The number of input tokens which were used.

          minimum: 0

        - `Model model`

          The model that will complete your prompt.

          See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

        - `long outputTokens`

          The number of output tokens which were used.

          minimum: 0

    - `long outputTokens`

      The number of output tokens which were used.

      minimum: 0

    - `Optional<BetaOutputTokensDetails> 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<BetaServerToolUsage> 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> serviceTier`

      If the request used the priority, standard, or batch tier.

      - `STANDARD("standard")`

      - `PRIORITY("priority")`

      - `BATCH("batch")`

    - `Optional<Speed> speed`

      The inference speed mode used for this request.

      - `STANDARD("standard")`

      - `FAST("fast")`

  - `Optional<List<BetaInputTransformation>> inputTransformations`

    Changes the API made to the request's input before showing it to the model,
    and blocks that failed a binding check but were left unchanged: one entry per
    block, in request order. Two entry types today. `thinking_dropped` — a
    `thinking`, `redacted_thinking` or `connector_text` block from the request's
    `messages` that was removed from the prompt instead of being shown to the
    model because it failed a binding check. `thinking_mismatch_allowed` — a
    `thinking` or `redacted_thinking` block that failed the conversation check
    (the conversation before it differs from the one it was created in, or it
    carries no record of one on a model that requires it) and was shown to the
    model all the same, because that check is not enforced for this request.
    More entry types may be added over time; ignore types you do not recognize.

    Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on
    every such response from a model that supports extended thinking, as `[]`
    when there is no entry to report; without the beta, blocks are removed or
    left in place all the same but nothing is reported. Removed blocks contribute
    nothing to `usage.input_tokens`; blocks left in place count as sent. When
    streaming, the array is final in `message_start`; the final `message_delta`
    event carries it only when a server-side model fallback happened mid-stream,
    in which case it holds the serving model's entries and replaces the one in
    `message_start`.

    - `class BetaThinkingDroppedInputTransformation`

      - `JsonValue type = "thinking_dropped"`

        Always `thinking_dropped` for this entry type.

      - `String path`

        Where the removed block was in your request, as `messages.{i}.content.{j}`:
        `i` indexes the `messages` array you sent and `j` that message's `content`
        array — the same form error messages use.

      - `Reason reason`

        Which binding check removed the block: `model_binding_mismatch` — it was
        created by a model whose reasoning the requested model may not read;
        `prefix_binding_mismatch` — the conversation before it differs from the
        conversation it was created in (the rest of that turn's consecutive thinking
        blocks are removed with it, each with this reason);
        `organization_binding_mismatch` — it was created under a different
        organization (an Anthropic organization, AWS account or Google Cloud project)
        and this organization is not one of its additional organizations;
        `end_user_binding_mismatch` — it was created for a different end user, or
        was removed by the consumer-organization binding. A block that would fail
        several checks reports one reason, in this order of precedence:
        `organization_binding_mismatch`, `end_user_binding_mismatch`,
        `model_binding_mismatch`, `prefix_binding_mismatch`.

        - `MODEL_BINDING_MISMATCH("model_binding_mismatch")`

        - `PREFIX_BINDING_MISMATCH("prefix_binding_mismatch")`

        - `ORGANIZATION_BINDING_MISMATCH("organization_binding_mismatch")`

        - `END_USER_BINDING_MISMATCH("end_user_binding_mismatch")`

    - `class BetaThinkingMismatchAllowedInputTransformation`

      - `JsonValue type = "thinking_mismatch_allowed"`

        Always `thinking_mismatch_allowed` for this entry type.

      - `String path`

        Where the block is in your request, as `messages.{i}.content.{j}`:
        `i` indexes the `messages` array you sent and `j` that message's `content`
        array — the same form error messages use.

      - `Reason reason`

        Which binding check the block failed; the block was shown to the model all
        the same. Always `prefix_binding_mismatch` today — the conversation before
        the block differs from the conversation it was created in, or the block
        carries no record of one on a model that requires it. Were the check
        enforced for this request, the block would have been removed or the request
        rejected (`thinking.block_binding.prefix_mismatch_behavior`). A removal also
        takes the rest of that turn's consecutive thinking blocks, whereas here each
        block is checked on its own, so `thinking_mismatch_allowed` entries are a
        lower bound on what enforcement would remove.

        - `MODEL_BINDING_MISMATCH("model_binding_mismatch")`

        - `PREFIX_BINDING_MISMATCH("prefix_binding_mismatch")`

        - `ORGANIZATION_BINDING_MISMATCH("organization_binding_mismatch")`

        - `END_USER_BINDING_MISMATCH("end_user_binding_mismatch")`

- `class BetaRawMessageStreamEvent: union`

  - `class BetaRawMessageStartEvent`

    - `JsonValue type = "message_start"`

    - `BetaMessage message`

  - `class BetaRawMessageDeltaEvent`

    - `JsonValue type = "message_delta"`

    - `Optional<BetaContextManagementResponse> contextManagement`

      Information about context management strategies applied during the request

    - `Delta delta`

      - `Optional<BetaContainer> 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<BetaRefusalStopDetails> stopDetails`

        Structured information about why model output stopped.

        This is `null` when the `stop_reason` has no additional detail to report.

      - `Optional<BetaStopReason> stopReason`

      - `Optional<String> stopSequence`

    - `BetaMessageDeltaUsage 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<Long> cacheCreationInputTokens`

        The cumulative number of input tokens used to create the cache entry.

        minimum: 0

      - `Optional<Long> cacheReadInputTokens`

        The cumulative number of input tokens read from the cache.

        minimum: 0

      - `Optional<BetaFallbackCreditUsage> fallbackCredit`

        Outcome of the `fallback_credit_token` presented on this request.

        Present on every response to a non-batch request that carried a
        `fallback_credit_token`, in either redemption mode; absent otherwise (batch
        items accept and ignore the token and carry no outcome object).

      - `Optional<Long> inputTokens`

        The cumulative number of input tokens which were used.

        minimum: 0

      - `Optional<List<Iteration>> iterations`

        Per-iteration token usage breakdown.

        Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to:

        - Calculate the context window size from the last `message` entry
        - Understand token accumulation across server-side tool use loops

        A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results.

        - `class BetaMessageIterationUsage`

          Token usage for a sampling iteration.

        - `class BetaCompactionIterationUsage`

          Token usage for a compaction iteration.

        - `class BetaAdvisorMessageIterationUsage`

          Token usage for an advisor sub-inference iteration.

        - `class BetaFallbackMessageIterationUsage`

          Token usage for the fallback-model attempt of a server-side fallback request.

          The terminal entry of a fallback-served turn: when a fallback hop's
          output is the returned message, the entry for the iteration that
          completed it carries this type in place of `message`. A declined hop
          and the serving hop's earlier tool-loop iterations produce `message`
          entries. Whether a fallback model served the response is signalled by
          the presence of this entry in `usage.iterations`.

      - `long outputTokens`

        The cumulative number of output tokens which were used.

      - `Optional<BetaOutputTokensDetails> 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<BetaServerToolUsage> serverToolUse`

        The number of server tool requests.

    - `Optional<List<BetaInputTransformation>> inputTransformations`

      Changes the API made to the request's input before showing it to the model,
      and blocks that failed a binding check but were left unchanged: one entry per
      block, in request order. Two entry types today. `thinking_dropped` — a
      `thinking`, `redacted_thinking` or `connector_text` block from the request's
      `messages` that was removed from the prompt instead of being shown to the
      model because it failed a binding check. `thinking_mismatch_allowed` — a
      `thinking` or `redacted_thinking` block that failed the conversation check
      (the conversation before it differs from the one it was created in, or it
      carries no record of one on a model that requires it) and was shown to the
      model all the same, because that check is not enforced for this request.
      More entry types may be added over time; ignore types you do not recognize.

      Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on
      every such response from a model that supports extended thinking, as `[]`
      when there is no entry to report; without the beta, blocks are removed or
      left in place all the same but nothing is reported. Removed blocks contribute
      nothing to `usage.input_tokens`; blocks left in place count as sent. When
      streaming, the array is final in `message_start`; the final `message_delta`
      event carries it only when a server-side model fallback happened mid-stream,
      in which case it holds the serving model's entries and replaces the one in
      `message_start`.

      - `class BetaThinkingDroppedInputTransformation`

      - `class BetaThinkingMismatchAllowedInputTransformation`

  - `class BetaRawMessageStopEvent`

    - `JsonValue type = "message_stop"`

  - `class BetaRawContentBlockStartEvent`

    - `JsonValue type = "content_block_start"`

    - `ContentBlock contentBlock`

      - `class BetaTextBlock`

      - `class BetaThinkingBlock`

      - `class BetaRedactedThinkingBlock`

      - `class BetaToolUseBlock`

      - `class BetaServerToolUseBlock`

      - `class BetaWebSearchToolResultBlock`

      - `class BetaWebFetchToolResultBlock`

      - `class BetaAdvisorToolResultBlock`

      - `class BetaCodeExecutionToolResultBlock`

      - `class BetaBashCodeExecutionToolResultBlock`

      - `class BetaTextEditorCodeExecutionToolResultBlock`

      - `class BetaToolSearchToolResultBlock`

      - `class BetaMcpToolUseBlock`

      - `class BetaMcpToolResultBlock`

      - `class BetaContainerUploadBlock`

        Response model for a file uploaded to the container.

      - `class BetaCompactionBlock`

        A compaction block returned when autocompact is triggered.

        When content is None, it indicates the compaction failed to produce a valid
        summary (e.g., malformed output from the model). Clients may round-trip
        compaction blocks with null content; the server treats them as no-ops.

      - `class BetaFallbackBlock`

        Marks the point in `content` where one model's output gives way to the next.

        One block appears per hop where a preceding model actually ran this turn and
        declined. A turn where no preceding model ran and declined has no such
        boundary and carries no block — the signal for whether a fallback model
        served the response is the presence of a `fallback_message` entry in
        `usage.iterations`, not this block.

        The block is treated like a server-tool content block for streaming: it
        arrives via the standard `content_block_start` / `content_block_stop`
        pair and carries no deltas.

      - `class BetaMcpToolListingBlock`

        The tool listing the server fetched from an MCP server while producing
        this response. Send the assistant message back unchanged, this block
        included, so later requests use this listing instead of asking the MCP
        server again.

    - `long index`

  - `class BetaRawContentBlockDeltaEvent`

    - `JsonValue type = "content_block_delta"`

    - `BetaRawContentBlockDelta delta`

      - `class BetaTextDelta`

        - `JsonValue type = "text_delta"`

        - `String text`

      - `class BetaInputJsonDelta`

        - `JsonValue type = "input_json_delta"`

        - `String partialJson`

      - `class BetaCitationsDelta`

        - `JsonValue type = "citations_delta"`

        - `Citation citation`

          - `class BetaCitationCharLocation`

          - `class BetaCitationPageLocation`

          - `class BetaCitationContentBlockLocation`

          - `class BetaCitationsWebSearchResultLocation`

          - `class BetaCitationSearchResultLocation`

      - `class BetaThinkingDelta`

        - `JsonValue type = "thinking_delta"`

        - `Optional<Long> estimatedTokens`

          Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative.

        - `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 BetaSignatureDelta`

        - `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.

      - `class BetaCompactionContentBlockDelta`

        - `JsonValue type = "compaction_delta"`

        - `Optional<String> content`

        - `Optional<String> encryptedContent`

          Opaque metadata from prior compaction, to be round-tripped verbatim

    - `long index`

  - `class BetaRawContentBlockStopEvent`

    - `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.beta.messages.BetaMessage;
import com.anthropic.models.beta.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();
        BetaMessage betaMessage = client.beta().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"
    }
  ],
  "context_management": {
    "applied_edits": [
      {
        "cleared_input_tokens": 0,
        "cleared_tool_uses": 0,
        "type": "clear_tool_uses_20250919"
      }
    ]
  },
  "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.",
    "fallback_credit_token": "QW50aHJvcGljL0NsYXVkZQ==",
    "fallback_has_prefill_claim": true,
    "recommended_model": "claude-opus-4-8",
    "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,
    "fallback_credit": {
      "status": {
        "type": "redeemed"
      }
    },
    "inference_geo": "global",
    "input_tokens": 2095,
    "iterations": [
      {
        "cache_creation": {
          "ephemeral_1h_input_tokens": 0,
          "ephemeral_5m_input_tokens": 0
        },
        "cache_creation_input_tokens": 0,
        "cache_read_input_tokens": 0,
        "input_tokens": 0,
        "model": "claude-haiku-5-5",
        "output_tokens": 0,
        "type": "message"
      }
    ],
    "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"
  },
  "input_transformations": [
    {
      "path": "path",
      "reason": "model_binding_mismatch",
      "type": "thinking_dropped"
    }
  ]
}
```

## Count tokens in a Message

`BetaMessageTokensCount beta().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<List<AnthropicBeta>> betas` (header parameter)

    Optional header to specify the beta version(s) you want to use.

    - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")`

    - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")`

    - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")`

    - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")`

    - `PDFS_2024_09_25("pdfs-2024-09-25")`

    - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")`

    - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")`

    - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")`

    - `FILES_API_2025_04_14("files-api-2025-04-14")`

    - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")`

    - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")`

    - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")`

    - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")`

    - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")`

    - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")`

    - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")`

    - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")`

    - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")`

    - `SKILLS_2025_10_02("skills-2025-10-02")`

    - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")`

    - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")`

    - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")`

    - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")`

    - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")`

    - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")`

    - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")`

    - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")`

    - `DREAMING_2026_04_21("dreaming-2026-04-21")`

    - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")`

    - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")`

    - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")`

    - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")`

    - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")`

    - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")`

    - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")`

    - `COMPACT_2026_01_12("compact-2026-01-12")`

    - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")`

    - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")`

    - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")`

    - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")`

    - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")`

    - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")`

    - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")`

    - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")`

    - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")`

    - `COMPACT_2026_09_04("compact-2026-09-04")`

    - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")`

    - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")`

    - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")`

    - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")`

    - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")`

  - `Optional<String> 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<String> 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<BetaMessageParam> 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<BetaContentBlockParam>`

        - `class BetaTextBlockParam`

          - `JsonValue type = "text"`

          - `String text`

            minLength: 1

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

            - `JsonValue type = "ephemeral"`

            - `Optional<Ttl> 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<List<BetaTextCitationParam>> citations`

            - `class BetaCitationCharLocationParam`

              - `JsonValue type = "char_location"`

              - `String citedText`

              - `long documentIndex`

                minimum: 0

              - `Optional<String> documentTitle`

                minLength: 1, maxLength: 500

              - `long endCharIndex`

              - `long startCharIndex`

                minimum: 0

            - `class BetaCitationPageLocationParam`

              - `JsonValue type = "page_location"`

              - `String citedText`

              - `long documentIndex`

                minimum: 0

              - `Optional<String> documentTitle`

                minLength: 1, maxLength: 500

              - `long endPageNumber`

              - `long startPageNumber`

                minimum: 1

            - `class BetaCitationContentBlockLocationParam`

              - `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<String> 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 BetaCitationWebSearchResultLocationParam`

              - `JsonValue type = "web_search_result_location"`

              - `String citedText`

              - `String encryptedIndex`

              - `Optional<String> title`

                minLength: 1, maxLength: 512

              - `String url`

                minLength: 1

            - `class BetaCitationSearchResultLocationParam`

              - `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<String> title`

        - `class BetaImageBlockParam`

          - `JsonValue type = "image"`

          - `Source source`

            - `class BetaBase64ImageSource`

              - `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 BetaUrlImageSource`

              - `JsonValue type = "url"`

              - `String url`

            - `class BetaFileImageSource`

              - `JsonValue type = "file"`

              - `String fileId`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaImageTransformationsParam> 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> 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 BetaRequestDocumentBlock`

          - `JsonValue type = "document"`

          - `Source source`

            - `class BetaBase64PdfSource`

              - `JsonValue type = "base64"`

              - `String data`

                format: byte

              - `JsonValue mediaType = "application/pdf"`

            - `class BetaPlainTextSource`

              - `JsonValue type = "text"`

              - `String data`

              - `JsonValue mediaType = "text/plain"`

            - `class BetaContentBlockSource`

              - `JsonValue type = "content"`

              - `Content content`

                - `String`

                - `List<BetaContentBlockSourceContent>`

                  - `class BetaTextBlockParam`

                  - `class BetaImageBlockParam`

            - `class BetaUrlPdfSource`

              - `JsonValue type = "url"`

              - `String url`

            - `class BetaFileDocumentSource`

              - `JsonValue type = "file"`

              - `String fileId`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaCitationsConfigParam> citations`

            - `Optional<Boolean> enabled`

          - `Optional<String> context`

            minLength: 1

          - `Optional<String> title`

            minLength: 1, maxLength: 500

        - `class BetaSearchResultBlockParam`

          - `JsonValue type = "search_result"`

          - `List<BetaTextBlockParam> content`

            - `JsonValue type = "text"`

            - `String text`

              minLength: 1

            - `Optional<BetaCacheControlEphemeral> cacheControl`

              Create a cache control breakpoint at this content block.

            - `Optional<List<BetaTextCitationParam>> citations`

          - `String source`

          - `String title`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaCitationsConfigParam> citations`

        - `class BetaThinkingBlockParam`

          - `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 BetaRedactedThinkingBlockParam`

          - `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 BetaToolUseBlockParam`

          - `JsonValue type = "tool_use"`

          - `String id`

            pattern: ^[a-zA-Z0-9_-]+$

          - `Input input`

          - `String name`

            minLength: 1, maxLength: 200

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Caller> caller`

            - `class BetaDirectCaller`

              Tool invocation directly from the model.

              - `JsonValue type = "direct"`

            - `class BetaServerToolCaller`

              Tool invocation generated by a server-side tool.

              - `JsonValue type = "code_execution_20250825"`

              - `String toolId`

                pattern: ^srvtoolu_[a-zA-Z0-9_]+$

            - `class BetaServerToolCaller20260120`

              - `JsonValue type = "code_execution_20260120"`

              - `String toolId`

                pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<String> toolsetName`

            For a toolset member tool_use, the toolset family this member belongs to.

            minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$

        - `class BetaToolResultBlockParam`

          - `JsonValue type = "tool_result"`

          - `String toolUseId`

            pattern: ^[a-zA-Z0-9_-]+$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Content> content`

            - `String`

            - `List<Block>`

              - `class BetaTextBlockParam`

              - `class BetaImageBlockParam`

              - `class BetaSearchResultBlockParam`

              - `class BetaRequestDocumentBlock`

              - `class BetaToolReferenceBlockParam`

                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<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

              - `class BetaBrowserStateBlockParam`

                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<BetaBrowserStateTabEntry> 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<Boolean> active`

                    Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<List<BetaBrowserStateChange>> 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 BetaBrowserStateChangeTabOpened`

                    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 BetaBrowserStateChangeDownloadStarted`

                    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 BetaBrowserStateChangeDownloadCompleted`

                    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<String> 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<Long> sizeBytes`

                      The completed download's size.

                      minimum: 0

                  - `class BetaBrowserStateChangeDownloadFailed`

                    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<String> error`

                      The failure or cancellation detail, when known.

                      maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$

          - `Optional<Boolean> isError`

          - `Optional<String> 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 BetaServerToolUseBlockParam`

          - `JsonValue type = "server_tool_use"`

          - `String id`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Input input`

          - `Name name`

            - `ADVISOR("advisor")`

            - `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<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Caller> caller`

            - `class BetaDirectCaller`

              Tool invocation directly from the model.

            - `class BetaServerToolCaller`

              Tool invocation generated by a server-side tool.

            - `class BetaServerToolCaller20260120`

        - `class BetaWebSearchToolResultBlockParam`

          - `JsonValue type = "web_search_tool_result"`

          - `BetaWebSearchToolResultBlockParamContent content`

            - `List<BetaWebSearchResultBlockParam>`

              - `JsonValue type = "web_search_result"`

              - `String encryptedContent`

              - `String title`

              - `String url`

              - `Optional<String> pageAge`

            - `class BetaWebSearchToolRequestError`

              - `JsonValue type = "web_search_tool_result_error"`

              - `BetaWebSearchToolResultErrorCode 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<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Caller> caller`

            - `class BetaDirectCaller`

              Tool invocation directly from the model.

            - `class BetaServerToolCaller`

              Tool invocation generated by a server-side tool.

            - `class BetaServerToolCaller20260120`

        - `class BetaWebFetchToolResultBlockParam`

          - `JsonValue type = "web_fetch_tool_result"`

          - `Content content`

            - `class BetaWebFetchToolResultErrorBlockParam`

              - `JsonValue type = "web_fetch_tool_result_error"`

              - `BetaWebFetchToolResultErrorCode 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 BetaWebFetchBlockParam`

              - `JsonValue type = "web_fetch_result"`

              - `BetaRequestDocumentBlock content`

              - `String url`

                Fetched content URL

              - `Optional<String> retrievedAt`

                ISO 8601 timestamp when the content was retrieved

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Caller> caller`

            - `class BetaDirectCaller`

              Tool invocation directly from the model.

            - `class BetaServerToolCaller`

              Tool invocation generated by a server-side tool.

            - `class BetaServerToolCaller20260120`

        - `class BetaAdvisorToolResultBlockParam`

          - `JsonValue type = "advisor_tool_result"`

          - `Content content`

            - `class BetaAdvisorToolResultErrorParam`

              - `JsonValue type = "advisor_tool_result_error"`

              - `ErrorCode errorCode`

                - `MAX_USES_EXCEEDED("max_uses_exceeded")`

                - `PROMPT_TOO_LONG("prompt_too_long")`

                - `TOO_MANY_REQUESTS("too_many_requests")`

                - `OVERLOADED("overloaded")`

                - `UNAVAILABLE("unavailable")`

                - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

                - `MODEL_NOT_FOUND("model_not_found")`

            - `class BetaAdvisorResultBlockParam`

              - `JsonValue type = "advisor_result"`

              - `String text`

              - `Optional<String> stopReason`

            - `class BetaAdvisorRedactedResultBlockParam`

              - `JsonValue type = "advisor_redacted_result"`

              - `String encryptedContent`

                Opaque blob produced by a prior response; must be round-tripped verbatim.

              - `Optional<String> stopReason`

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

        - `class BetaCodeExecutionToolResultBlockParam`

          - `JsonValue type = "code_execution_tool_result"`

          - `BetaCodeExecutionToolResultBlockParamContent content`

            - `class BetaCodeExecutionToolResultErrorParam`

              - `JsonValue type = "code_execution_tool_result_error"`

              - `BetaCodeExecutionToolResultErrorCode errorCode`

                - `INVALID_TOOL_INPUT("invalid_tool_input")`

                - `UNAVAILABLE("unavailable")`

                - `TOO_MANY_REQUESTS("too_many_requests")`

                - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

            - `class BetaCodeExecutionResultBlockParam`

              - `JsonValue type = "code_execution_result"`

              - `List<BetaCodeExecutionOutputBlockParam> content`

                - `JsonValue type = "code_execution_output"`

                - `String fileId`

              - `long returnCode`

              - `String stderr`

              - `String stdout`

            - `class BetaEncryptedCodeExecutionResultBlockParam`

              Code execution result with encrypted stdout for PFC + web_search results.

              - `JsonValue type = "encrypted_code_execution_result"`

              - `List<BetaCodeExecutionOutputBlockParam> content`

                - `JsonValue type = "code_execution_output"`

                - `String fileId`

              - `String encryptedStdout`

              - `long returnCode`

              - `String stderr`

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

        - `class BetaBashCodeExecutionToolResultBlockParam`

          - `JsonValue type = "bash_code_execution_tool_result"`

          - `Content content`

            - `class BetaBashCodeExecutionToolResultErrorParam`

              - `JsonValue type = "bash_code_execution_tool_result_error"`

              - `ErrorCode 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 BetaBashCodeExecutionResultBlockParam`

              - `JsonValue type = "bash_code_execution_result"`

              - `List<BetaBashCodeExecutionOutputBlockParam> content`

                - `JsonValue type = "bash_code_execution_output"`

                - `String fileId`

              - `long returnCode`

              - `String stderr`

              - `String stdout`

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

        - `class BetaTextEditorCodeExecutionToolResultBlockParam`

          - `JsonValue type = "text_editor_code_execution_tool_result"`

          - `Content content`

            - `class BetaTextEditorCodeExecutionToolResultErrorParam`

              - `JsonValue type = "text_editor_code_execution_tool_result_error"`

              - `ErrorCode 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<String> errorMessage`

            - `class BetaTextEditorCodeExecutionViewResultBlockParam`

              - `JsonValue type = "text_editor_code_execution_view_result"`

              - `String content`

              - `FileType fileType`

                - `TEXT("text")`

                - `IMAGE("image")`

                - `PDF("pdf")`

              - `Optional<Long> numLines`

              - `Optional<Long> startLine`

              - `Optional<Long> totalLines`

            - `class BetaTextEditorCodeExecutionCreateResultBlockParam`

              - `JsonValue type = "text_editor_code_execution_create_result"`

              - `boolean isFileUpdate`

            - `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam`

              - `JsonValue type = "text_editor_code_execution_str_replace_result"`

              - `Optional<List<String>> lines`

              - `Optional<Long> newLines`

              - `Optional<Long> newStart`

              - `Optional<Long> oldLines`

              - `Optional<Long> oldStart`

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

        - `class BetaToolSearchToolResultBlockParam`

          - `JsonValue type = "tool_search_tool_result"`

          - `Content content`

            - `class BetaToolSearchToolResultErrorParam`

              - `JsonValue type = "tool_search_tool_result_error"`

              - `ErrorCode errorCode`

                - `INVALID_TOOL_INPUT("invalid_tool_input")`

                - `UNAVAILABLE("unavailable")`

                - `TOO_MANY_REQUESTS("too_many_requests")`

                - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

              - `Optional<String> errorMessage`

            - `class BetaToolSearchToolSearchResultBlockParam`

              - `JsonValue type = "tool_search_tool_search_result"`

              - `List<BetaToolReferenceBlockParam> toolReferences`

                - `JsonValue type = "tool_reference"`

                - `String toolName`

                  minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

        - `class BetaMcpToolUseBlockParam`

          - `JsonValue type = "mcp_tool_use"`

          - `String id`

            pattern: ^[a-zA-Z0-9_-]+$

          - `Input input`

          - `String name`

          - `String serverName`

            The name of the MCP server

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

        - `class BetaRequestMcpToolResultBlockParam`

          - `JsonValue type = "mcp_tool_result"`

          - `String toolUseId`

            pattern: ^[a-zA-Z0-9_-]+$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Content> content`

            - `String`

            - `List<BetaTextBlockParam>`

              - `JsonValue type = "text"`

              - `String text`

                minLength: 1

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<List<BetaTextCitationParam>> citations`

          - `Optional<Boolean> isError`

        - `class BetaContainerUploadBlockParam`

          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<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

        - `class BetaCompactionBlockParam`

          A compaction block containing summary of previous context.

          Users should round-trip these blocks from responses to subsequent requests
          to maintain context across compaction boundaries.

          When content is None, the block represents a failed compaction. The server
          treats these as no-ops. Empty string content is not allowed.

          - `JsonValue type = "compaction"`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<String> content`

            Summary of previously compacted content, or null if compaction failed

          - `Optional<String> encryptedContent`

            Opaque metadata from prior compaction, to be round-tripped verbatim

          - `Optional<String> signature`

            The block's signature as returned, to be sent back verbatim

          - `Optional<List<ToolChange>> toolChanges`

            The tool changes of the compacted range, as the server returned them on this block: the `tool_addition` and `tool_removal` entries that take the request's `tools` to the tool set in effect at the end of the range. Send them back unchanged with the block.

            - `class BetaRequestToolAdditionBlock`

              Mid-conversation directive to make a tool available.

              `tool` is a reference to a tool (or MCP toolset) declared in the
              request's `tools`. Under the `inline-tools-2026-09-15` beta it may
              instead be a reference to a tool defined earlier in `messages`, or a
              `tool_definition` object that carries an inline tool definition in
              `definition` (the same object a `tools` entry holds). An `mcp_toolset`
              definition also requires the `mcp-client-2026-09-15` beta. The tool is
              offered to the model from this point in the conversation onward.

              - `JsonValue type = "tool_addition"`

              - `Tool tool`

                - `class BetaToolChangeToolReference`

                  Reference to a single tool, by the name the model uses to call it: a
                  tool declared in `tools` or defined by an earlier `tool_addition`
                  block. Does not accept the composed `{server}_{name}` form the server
                  assigns to MCP-resolved tools; use `mcp_tool_reference` or
                  `mcp_toolset_reference` for those.

                  - `JsonValue type = "tool_reference"`

                  - `String name`

                    pattern: ^[a-zA-Z0-9_-]{1,128}$

                - `class BetaToolChangeMcpToolReference`

                  Reference to a single MCP tool by its server and remote name; the
                  same `server_name`/`name` pair `mcp_tool_use` carries.

                  - `JsonValue type = "mcp_tool_reference"`

                  - `String name`

                  - `String serverName`

                - `class BetaToolChangeMcpToolsetReference`

                  Reference to every tool in the named MCP server's toolset.

                  - `JsonValue type = "mcp_toolset_reference"`

                  - `String serverName`

                - `class BetaToolChangeToolDefinitionParam`

                  A tool defined by value: `definition` is a `tools` entry (any kind
                  `tools` accepts, an MCP toolset included). An `mcp_toolset` given here
                  also requires the `mcp-client-2026-09-15` beta.

                  - `JsonValue type = "tool_definition"`

                  - `BetaToolUnion definition`

                    - `class BetaTool`

                      - `Optional<Type> 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> properties`

                        - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolBash20241022`

                      - `JsonValue type = "bash_20241022"`

                      - `JsonValue name = "bash"`

                        Name of the tool.

                        This is how the tool will be called by the model and in `tool_use` blocks.

                      - `Optional<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolBash20250124`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaCodeExecutionTool20250522`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaCodeExecutionTool20250825`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaCodeExecutionTool20260120`

                      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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaCodeExecutionTool20260521`

                      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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaBrowserToolset20260801`

                      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<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

                          `type`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserCloseTabConfig> closeTab`

                          `close_tab`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

                          `double_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserFileUploadConfig> fileUpload`

                          `file_upload`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserFindConfig> find`

                          `find`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserFormInputConfig> formInput`

                          `form_input`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserGetPageTextConfig> getPageText`

                          `get_page_text`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserHoldKeyConfig> holdKey`

                          `hold_key`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserHoverConfig> hover`

                          `hover`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

                          `javascript_exec`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserKeyConfig> key`

                          `key`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserLeftClickConfig> leftClick`

                          `left_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

                          `left_click_drag`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

                          `left_mouse_down`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

                          `left_mouse_up`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserListTabsConfig> listTabs`

                          `list_tabs`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserMiddleClickConfig> middleClick`

                          `middle_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

                          `mouse_move`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserNavigateConfig> navigate`

                          `navigate`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserNewTabConfig> newTab`

                          `new_tab`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserReadConsoleConfig> readConsole`

                          `read_console`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

                          `read_network`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserReadPageConfig> readPage`

                          `read_page`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserRightClickConfig> rightClick`

                          `right_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserScreenshotConfig> screenshot`

                          `screenshot`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserScrollConfig> scroll`

                          `scroll`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserScrollToConfig> scrollTo`

                          `scroll_to`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserSwitchTabConfig> switchTab`

                          `switch_tab`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserTripleClickConfig> tripleClick`

                          `triple_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserWaitConfig> wait`

                          `wait`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserZoomConfig> zoom`

                          `zoom`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered 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 BetaToolComputerUse20241022`

                      - `JsonValue type = "computer_20241022"`

                      - `long displayHeightPx`

                        The height of the display in pixels.

                        minimum: 1

                      - `long displayWidthPx`

                        The width of the display in pixels.

                        minimum: 1

                      - `JsonValue name = "computer"`

                        Name of the tool.

                        This is how the tool will be called by the model and in `tool_use` blocks.

                      - `Optional<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> displayNumber`

                        The X11 display number (e.g. 0, 1) for the display.

                        minimum: 0

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaMemoryTool20250818`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolComputerUse20250124`

                      - `JsonValue type = "computer_20250124"`

                      - `long displayHeightPx`

                        The height of the display in pixels.

                        minimum: 1

                      - `long displayWidthPx`

                        The width of the display in pixels.

                        minimum: 1

                      - `JsonValue name = "computer"`

                        Name of the tool.

                        This is how the tool will be called by the model and in `tool_use` blocks.

                      - `Optional<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> displayNumber`

                        The X11 display number (e.g. 0, 1) for the display.

                        minimum: 0

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolTextEditor20241022`

                      - `JsonValue type = "text_editor_20241022"`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolComputerUse20251124`

                      - `JsonValue type = "computer_20251124"`

                      - `long displayHeightPx`

                        The height of the display in pixels.

                        minimum: 1

                      - `long displayWidthPx`

                        The width of the display in pixels.

                        minimum: 1

                      - `JsonValue name = "computer"`

                        Name of the tool.

                        This is how the tool will be called by the model and in `tool_use` blocks.

                      - `Optional<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> displayNumber`

                        The X11 display number (e.g. 0, 1) for the display.

                        minimum: 0

                      - `Optional<Boolean> enableZoom`

                        Whether to enable an action to take a zoomed-in screenshot of the screen.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaComputerToolset20260801`

                      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<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

                          `type`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

                          `cursor_position`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerDoubleClickConfig> doubleClick`

                          `double_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerHoldKeyConfig> holdKey`

                          `hold_key`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerKeyConfig> key`

                          `key`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerLeftClickConfig> leftClick`

                          `left_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

                          `left_click_drag`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

                          `left_mouse_down`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

                          `left_mouse_up`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerMiddleClickConfig> middleClick`

                          `middle_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerMouseMoveConfig> mouseMove`

                          `mouse_move`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerRightClickConfig> rightClick`

                          `right_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerScreenshotConfig> screenshot`

                          `screenshot`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerScrollConfig> scroll`

                          `scroll`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerTripleClickConfig> tripleClick`

                          `triple_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerWaitConfig> wait`

                          `wait`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerZoomConfig> zoom`

                          `zoom`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered 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 BetaToolTextEditor20250124`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolTextEditor20250429`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolTextEditor20250728`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Long> maxCharacters`

                        Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaWebSearchTool20250305`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                      - `Optional<List<String>> blockedDomains`

                        If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaUserLocation> userLocation`

                        Parameters for the user's location. Used to provide more relevant search results.

                        - `JsonValue type = "approximate"`

                        - `Optional<String> city`

                          The city of the user.

                          minLength: 1, maxLength: 255

                        - `Optional<String> 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<String> region`

                          The region of the user.

                          minLength: 1, maxLength: 255

                        - `Optional<String> timezone`

                          The [IANA timezone](https://nodatime.org/TimeZones) of the user.

                          minLength: 1, maxLength: 255

                    - `class BetaWebFetchTool20250910`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        List of domains to allow fetching from

                      - `Optional<List<String>> blockedDomains`

                        List of domains to block fetching from

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaCitationsConfigParam> citations`

                        Citations configuration for fetched documents. Citations are disabled by default.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> 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<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaWebFetchUrlSources> urlSources`

                        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                        - `Optional<ClientToolResults> clientToolResults`

                          Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

                          - `class BetaWebFetchUrlSourceAll`

                            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 BetaWebFetchUrlSourceNone`

                            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 BetaWebFetchUrlSourceOnly`

                            The tool filter variant under which only the named tools' results
                            contribute.

                            - `JsonValue type = "only"`

                            - `List<BetaWebFetchUrlSourceToolReference> tools`

                              - `JsonValue type = "tool_reference"`

                              - `String name`

                          - `class BetaWebFetchUrlSourceExcept`

                            The tool filter variant under which every result but the named
                            tools' contributes.

                            - `JsonValue type = "except"`

                            - `List<BetaWebFetchUrlSourceToolReference> tools`

                              - `JsonValue type = "tool_reference"`

                              - `String name`

                        - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

                            The `url_sources` variant under which a source contributes in
                            full: every result of the tool filter's source, or all user input.

                          - `class BetaWebFetchUrlSourceNone`

                            The `url_sources` variant under which a source contributes nothing:
                            no result of the tool filter's source, or no user input.

                          - `class BetaWebFetchUrlSourceOnly`

                            The tool filter variant under which only the named tools' results
                            contribute.

                          - `class BetaWebFetchUrlSourceExcept`

                            The tool filter variant under which every result but the named
                            tools' contributes.

                        - `Optional<UserInput> userInput`

                          Whether URLs in user messages are fetchable: "all" or "none".

                          - `class BetaWebFetchUrlSourceAll`

                            The `url_sources` variant under which a source contributes in
                            full: every result of the tool filter's source, or all user input.

                          - `class BetaWebFetchUrlSourceNone`

                            The `url_sources` variant under which a source contributes nothing:
                            no result of the tool filter's source, or no user input.

                    - `class BetaWebSearchTool20260209`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                      - `Optional<List<String>> blockedDomains`

                        If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaUserLocation> userLocation`

                        Parameters for the user's location. Used to provide more relevant search results.

                    - `class BetaWebFetchTool20260209`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        List of domains to allow fetching from

                      - `Optional<List<String>> blockedDomains`

                        List of domains to block fetching from

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaCitationsConfigParam> citations`

                        Citations configuration for fetched documents. Citations are disabled by default.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> 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<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaWebFetchUrlSources> urlSources`

                        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                    - `class BetaWebFetchTool20260309`

                      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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        List of domains to allow fetching from

                      - `Optional<List<String>> blockedDomains`

                        List of domains to block fetching from

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaCitationsConfigParam> citations`

                        Citations configuration for fetched documents. Citations are disabled by default.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> 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<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaWebFetchUrlSources> urlSources`

                        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                      - `Optional<Boolean> 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 BetaWebSearchTool20260318`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                      - `Optional<List<String>> blockedDomains`

                        If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<ResponseInclusion> 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<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaUserLocation> userLocation`

                        Parameters for the user's location. Used to provide more relevant search results.

                    - `class BetaWebFetchTool20260318`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        List of domains to allow fetching from

                      - `Optional<List<String>> blockedDomains`

                        List of domains to block fetching from

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaCitationsConfigParam> citations`

                        Citations configuration for fetched documents. Citations are disabled by default.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> 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<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<ResponseInclusion> 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<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaWebFetchUrlSources> urlSources`

                        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                      - `Optional<Boolean> 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 BetaAdvisorTool20260301`

                      - `JsonValue type = "advisor_20260301"`

                      - `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 name = "advisor"`

                        Name of the tool.

                        This is how the tool will be called by the model and in `tool_use` blocks.

                      - `Optional<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaCacheControlEphemeral> caching`

                        Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> maxTokens`

                        Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

                        minimum: 1024

                      - `Optional<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolSearchToolRegex20251119`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaMcpToolset`

                      Configuration for a group of tools from an MCP server.

                      Allows configuring enabled status and defer_loading for all tools
                      from an MCP server, with optional per-tool overrides.

                      - `JsonValue type = "mcp_toolset"`

                      - `String mcpServerName`

                        Name of the MCP server to configure tools for

                        minLength: 1, maxLength: 255

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Configs> configs`

                        Configuration overrides for specific tools, keyed by tool name

                        - `Optional<Boolean> deferLoading`

                        - `Optional<Boolean> enabled`

                      - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

                        Default configuration applied to all tools from this server

                        - `Optional<Boolean> deferLoading`

                        - `Optional<Boolean> enabled`

                      - `Optional<List<BetaMcpToolParam>> tools`

                        The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

                        - `InputSchema inputSchema`

                          The tool's input schema as the MCP server lists it, verbatim.

                        - `String name`

                          The tool's name as the MCP server lists it (not prefixed with the server name).

                          minLength: 1

                        - `Optional<String> description`

                          The tool's description as the MCP server lists it.

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

            - `class BetaRequestToolRemovalBlock`

              Mid-conversation directive to withdraw a tool.

              `tool` references a tool (or MCP toolset) by name: one declared in the
              request's `tools` or defined earlier in `messages`. It is no longer
              offered to the model from this point in the conversation onward.

              - `JsonValue type = "tool_removal"`

              - `Tool tool`

                - `class BetaToolChangeToolReference`

                  Reference to a single tool, by the name the model uses to call it: a
                  tool declared in `tools` or defined by an earlier `tool_addition`
                  block. Does not accept the composed `{server}_{name}` form the server
                  assigns to MCP-resolved tools; use `mcp_tool_reference` or
                  `mcp_toolset_reference` for those.

                - `class BetaToolChangeMcpToolReference`

                  Reference to a single MCP tool by its server and remote name; the
                  same `server_name`/`name` pair `mcp_tool_use` carries.

                - `class BetaToolChangeMcpToolsetReference`

                  Reference to every tool in the named MCP server's toolset.

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

        - `class BetaRequestToolAdditionBlock`

          Mid-conversation directive to make a tool available.

          `tool` is a reference to a tool (or MCP toolset) declared in the
          request's `tools`. Under the `inline-tools-2026-09-15` beta it may
          instead be a reference to a tool defined earlier in `messages`, or a
          `tool_definition` object that carries an inline tool definition in
          `definition` (the same object a `tools` entry holds). An `mcp_toolset`
          definition also requires the `mcp-client-2026-09-15` beta. The tool is
          offered to the model from this point in the conversation onward.

        - `class BetaRequestToolRemovalBlock`

          Mid-conversation directive to withdraw a tool.

          `tool` references a tool (or MCP toolset) by name: one declared in the
          request's `tools` or defined earlier in `messages`. It is no longer
          offered to the model from this point in the conversation onward.

        - `class BetaMcpToolListingBlockParam`

          The tool listing an MCP server returned while an earlier response was
          produced, as that response carried it. Send the assistant message back
          unchanged, this block included, and the server uses this listing for the
          matching `mcp_toolset` instead of asking the MCP server again.

          - `JsonValue type = "mcp_tool_listing"`

          - `String mcpServerName`

            The name of the MCP server this listing came from, as `mcp_servers` declares it.

            minLength: 1, maxLength: 255

          - `List<BetaMcpToolParam> tools`

            The server's tools, exactly as the response listed them.

            - `InputSchema inputSchema`

              The tool's input schema as the MCP server lists it, verbatim.

            - `String name`

              The tool's name as the MCP server lists it (not prefixed with the server name).

              minLength: 1

            - `Optional<String> description`

              The tool's description as the MCP server lists it.

        - `class BetaFallbackBlockParam`

          A `fallback` block echoed back from a prior response.

          Accepted in `messages[].content` and not rendered into the prompt; not
          validated against the request's `fallbacks` chain or top-level `model`.

          Echo the assistant turn back verbatim, including this block in its
          original position. The block marks the boundary between content produced
          before and after a fallback hop, and the server relies on that boundary
          to validate the turn: when thinking runs flank the boundary, omitting
          the block merges them into one span the server cannot validate (the
          request is rejected), and moving it into the middle of a single run is
          likewise rejected; between non-thinking blocks the block's placement has
          no validation effect.

          - `JsonValue type = "fallback"`

          - `BetaFallbackInfoParam from`

            Identifies one hop of a fallback transition.

            - `Model model`

              The model that will complete your prompt.

              See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

          - `BetaFallbackInfoParam to`

            Identifies one hop of a fallback transition.

          - `Optional<JsonValue> trigger`

            The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed.

    - `Role role`

      - `USER("user")`

      - `ASSISTANT("assistant")`

      - `SYSTEM("system")`

    - `Optional<ClearAt> clearAt`

      How long this system message's text stays in front of the model. `"never"` (the default) renders it on every request that includes it. `"next_user_message"` renders it only for the user turn it follows: once a later `role: "user"` message exists in `messages` the message stays in the array (send it unchanged) but is no longer shown to the model. Only permitted on `role: "system"` messages.

      - `NEXT_USER_MESSAGE("next_user_message")`

      - `NEVER("never")`

    - `Optional<BetaSystemMessageOutputConfig> outputConfig`

      Per-message output configuration on a role:"system" input message.

      Fields here apply per-turn; `format` remains top-level only. An
      empty `{}` is accepted on a message that carries content; a message
      with neither content nor output_config fields is rejected.

      - `Optional<Effort> 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")`

  - `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<BetaCacheControlEphemeral> cacheControl`

    Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.

  - `Optional<BetaCompactionConfig> compaction`

    Compaction configuration.

    When set on `POST /v1/messages`, the request is a compaction request: the conversation in `messages` is summarized and the response holds only the resulting `compaction` block (`stop_reason` `"compaction"`), which later requests send first in `messages` in place of the messages it summarizes. `POST /v1/messages/count_tokens` accepts this parameter and ignores it: the count it returns is for the conversation in `messages` as sent. Cannot be combined with `context_management`.

  - `Optional<BetaContextManagementConfig> contextManagement`

    Context management configuration.

    This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not.

  - `Optional<List<BetaRequestMcpServerUrlDefinition>> mcpServers`

    MCP servers to be utilized in this request

    maxItems: 20

    - `JsonValue type = "url"`

    - `String name`

    - `String url`

    - `Optional<String> authorizationToken`

    - `Optional<BetaRequestMcpServerToolConfiguration> toolConfiguration`

      - `Optional<List<String>> allowedTools`

      - `Optional<Boolean> enabled`

  - `Optional<BetaOutputConfig> outputConfig`

    Configuration options for the model's output, such as the output format.

  - `Optional<Speed> 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`

    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<BetaTextBlockParam>`

      - `JsonValue type = "text"`

      - `String text`

        minLength: 1

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<List<BetaTextCitationParam>> citations`

  - `Optional<BetaThinkingConfigParam> 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<BetaToolChoice> 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<List<Tool>> 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 BetaTool`

    - `class BetaToolBash20241022`

    - `class BetaToolBash20250124`

    - `class BetaCodeExecutionTool20250522`

    - `class BetaCodeExecutionTool20250825`

    - `class BetaCodeExecutionTool20260120`

      Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).

    - `class BetaCodeExecutionTool20260521`

      Code execution tool with REPL state persistence.

    - `class BetaBrowserToolset20260801`

      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.

    - `class BetaToolComputerUse20241022`

    - `class BetaMemoryTool20250818`

    - `class BetaToolComputerUse20250124`

    - `class BetaToolTextEditor20241022`

    - `class BetaToolComputerUse20251124`

    - `class BetaComputerToolset20260801`

      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`.

    - `class BetaToolTextEditor20250124`

    - `class BetaToolTextEditor20250429`

    - `class BetaToolTextEditor20250728`

    - `class BetaWebSearchTool20250305`

    - `class BetaWebFetchTool20250910`

    - `class BetaWebSearchTool20260209`

    - `class BetaWebFetchTool20260209`

    - `class BetaWebFetchTool20260309`

      Web fetch tool with use_cache parameter for bypassing cached content.

    - `class BetaWebSearchTool20260318`

    - `class BetaWebFetchTool20260318`

    - `class BetaAdvisorTool20260301`

    - `class BetaToolSearchToolBm25_20251119`

    - `class BetaToolSearchToolRegex20251119`

    - `class BetaMcpToolset`

      Configuration for a group of tools from an MCP server.

      Allows configuring enabled status and defer_loading for all tools
      from an MCP server, with optional per-tool overrides.

  - `Optional<BetaJsonOutputFormat> outputFormat`

    **Deprecated**

    Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=java)

    A schema to specify Claude's output format in responses. This parameter will be removed in a future release.

### Returns

- `class BetaMessageTokensCount`

  - `Optional<BetaCountTokensContextManagementResponse> contextManagement`

    Information about context management applied to the message.

    - `long originalInputTokens`

      The original token count before context management was applied

  - `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.beta.messages.BetaMessageTokensCount;
import com.anthropic.models.beta.messages.MessageCountTokensParams;
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();
        BetaMessageTokensCount betaMessageTokensCount = client.beta().messages().countTokens(params);
    }
}
```

#### Response (200)

```json
{
  "context_management": {
    "original_input_tokens": 0
  },
  "input_tokens": 2095
}
```

## Domain types

### Beta Advisor Message Iteration Usage

- `class BetaAdvisorMessageIterationUsage`

  Token usage for an advisor sub-inference iteration.

  - `JsonValue type = "advisor_message"`

    Usage for an advisor sub-inference iteration

  - `Optional<BetaCacheCreation> 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

  - `long cacheCreationInputTokens`

    The number of input tokens used to create the cache entry.

    minimum: 0

  - `long cacheReadInputTokens`

    The number of input tokens read from the cache.

    minimum: 0

  - `long inputTokens`

    The number of input tokens which were used.

    minimum: 0

  - `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

  - `long outputTokens`

    The number of output tokens which were used.

    minimum: 0

### Beta Advisor Redacted Result Block

- `class BetaAdvisorRedactedResultBlock`

  - `JsonValue type = "advisor_redacted_result"`

  - `String encryptedContent`

    Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify.

  - `Optional<String> stopReason`

    The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`).

### Beta Advisor Redacted Result Block Param

- `class BetaAdvisorRedactedResultBlockParam`

  - `JsonValue type = "advisor_redacted_result"`

  - `String encryptedContent`

    Opaque blob produced by a prior response; must be round-tripped verbatim.

  - `Optional<String> stopReason`

### Beta Advisor Result Block

- `class BetaAdvisorResultBlock`

  - `JsonValue type = "advisor_result"`

  - `Optional<String> stopReason`

    The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap.

  - `String text`

### Beta Advisor Result Block Param

- `class BetaAdvisorResultBlockParam`

  - `JsonValue type = "advisor_result"`

  - `String text`

  - `Optional<String> stopReason`

### Beta Advisor Tool 20260301

- `class BetaAdvisorTool20260301`

  - `JsonValue type = "advisor_20260301"`

  - `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 name = "advisor"`

    Name of the tool.

    This is how the tool will be called by the model and in `tool_use` blocks.

  - `Optional<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<BetaCacheControlEphemeral> caching`

    Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

  - `Optional<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Long> maxTokens`

    Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

    minimum: 1024

  - `Optional<Long> maxUses`

    Maximum number of times the tool can be used in the API request.

    minimum: 1

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Advisor Tool Result Block

- `class BetaAdvisorToolResultBlock`

  - `JsonValue type = "advisor_tool_result"`

  - `Content content`

    - `class BetaAdvisorToolResultError`

      - `JsonValue type = "advisor_tool_result_error"`

      - `ErrorCode errorCode`

        - `MAX_USES_EXCEEDED("max_uses_exceeded")`

        - `PROMPT_TOO_LONG("prompt_too_long")`

        - `TOO_MANY_REQUESTS("too_many_requests")`

        - `OVERLOADED("overloaded")`

        - `UNAVAILABLE("unavailable")`

        - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

        - `MODEL_NOT_FOUND("model_not_found")`

    - `class BetaAdvisorResultBlock`

      - `JsonValue type = "advisor_result"`

      - `Optional<String> stopReason`

        The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap.

      - `String text`

    - `class BetaAdvisorRedactedResultBlock`

      - `JsonValue type = "advisor_redacted_result"`

      - `String encryptedContent`

        Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify.

      - `Optional<String> stopReason`

        The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`).

  - `String toolUseId`

    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Advisor Tool Result Block Param

- `class BetaAdvisorToolResultBlockParam`

  - `JsonValue type = "advisor_tool_result"`

  - `Content content`

    - `class BetaAdvisorToolResultErrorParam`

      - `JsonValue type = "advisor_tool_result_error"`

      - `ErrorCode errorCode`

        - `MAX_USES_EXCEEDED("max_uses_exceeded")`

        - `PROMPT_TOO_LONG("prompt_too_long")`

        - `TOO_MANY_REQUESTS("too_many_requests")`

        - `OVERLOADED("overloaded")`

        - `UNAVAILABLE("unavailable")`

        - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

        - `MODEL_NOT_FOUND("model_not_found")`

    - `class BetaAdvisorResultBlockParam`

      - `JsonValue type = "advisor_result"`

      - `String text`

      - `Optional<String> stopReason`

    - `class BetaAdvisorRedactedResultBlockParam`

      - `JsonValue type = "advisor_redacted_result"`

      - `String encryptedContent`

        Opaque blob produced by a prior response; must be round-tripped verbatim.

      - `Optional<String> stopReason`

  - `String toolUseId`

    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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")`

### Beta Advisor Tool Result Error

- `class BetaAdvisorToolResultError`

  - `JsonValue type = "advisor_tool_result_error"`

  - `ErrorCode errorCode`

    - `MAX_USES_EXCEEDED("max_uses_exceeded")`

    - `PROMPT_TOO_LONG("prompt_too_long")`

    - `TOO_MANY_REQUESTS("too_many_requests")`

    - `OVERLOADED("overloaded")`

    - `UNAVAILABLE("unavailable")`

    - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

    - `MODEL_NOT_FOUND("model_not_found")`

### Beta Advisor Tool Result Error Param

- `class BetaAdvisorToolResultErrorParam`

  - `JsonValue type = "advisor_tool_result_error"`

  - `ErrorCode errorCode`

    - `MAX_USES_EXCEEDED("max_uses_exceeded")`

    - `PROMPT_TOO_LONG("prompt_too_long")`

    - `TOO_MANY_REQUESTS("too_many_requests")`

    - `OVERLOADED("overloaded")`

    - `UNAVAILABLE("unavailable")`

    - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

    - `MODEL_NOT_FOUND("model_not_found")`

### Beta All Thinking Turns

- `class BetaAllThinkingTurns`

  - `JsonValue type = "all"`

### Beta Base64 Image Source

- `class BetaBase64ImageSource`

  - `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")`

### Beta Base64 PDF Source

- `class BetaBase64PdfSource`

  - `JsonValue type = "base64"`

  - `String data`

    format: byte

  - `JsonValue mediaType = "application/pdf"`

### Beta Bash Code Execution Output Block

- `class BetaBashCodeExecutionOutputBlock`

  - `JsonValue type = "bash_code_execution_output"`

  - `String fileId`

### Beta Bash Code Execution Output Block Param

- `class BetaBashCodeExecutionOutputBlockParam`

  - `JsonValue type = "bash_code_execution_output"`

  - `String fileId`

### Beta Bash Code Execution Result Block

- `class BetaBashCodeExecutionResultBlock`

  - `JsonValue type = "bash_code_execution_result"`

  - `List<BetaBashCodeExecutionOutputBlock> content`

    - `JsonValue type = "bash_code_execution_output"`

    - `String fileId`

  - `long returnCode`

  - `String stderr`

  - `String stdout`

### Beta Bash Code Execution Result Block Param

- `class BetaBashCodeExecutionResultBlockParam`

  - `JsonValue type = "bash_code_execution_result"`

  - `List<BetaBashCodeExecutionOutputBlockParam> content`

    - `JsonValue type = "bash_code_execution_output"`

    - `String fileId`

  - `long returnCode`

  - `String stderr`

  - `String stdout`

### Beta Bash Code Execution Tool Result Block

- `class BetaBashCodeExecutionToolResultBlock`

  - `JsonValue type = "bash_code_execution_tool_result"`

  - `Content content`

    - `class BetaBashCodeExecutionToolResultError`

      - `JsonValue type = "bash_code_execution_tool_result_error"`

      - `ErrorCode 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 BetaBashCodeExecutionResultBlock`

      - `JsonValue type = "bash_code_execution_result"`

      - `List<BetaBashCodeExecutionOutputBlock> content`

        - `JsonValue type = "bash_code_execution_output"`

        - `String fileId`

      - `long returnCode`

      - `String stderr`

      - `String stdout`

  - `String toolUseId`

    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Bash Code Execution Tool Result Block Param

- `class BetaBashCodeExecutionToolResultBlockParam`

  - `JsonValue type = "bash_code_execution_tool_result"`

  - `Content content`

    - `class BetaBashCodeExecutionToolResultErrorParam`

      - `JsonValue type = "bash_code_execution_tool_result_error"`

      - `ErrorCode 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 BetaBashCodeExecutionResultBlockParam`

      - `JsonValue type = "bash_code_execution_result"`

      - `List<BetaBashCodeExecutionOutputBlockParam> content`

        - `JsonValue type = "bash_code_execution_output"`

        - `String fileId`

      - `long returnCode`

      - `String stderr`

      - `String stdout`

  - `String toolUseId`

    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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")`

### Beta Bash Code Execution Tool Result Error

- `class BetaBashCodeExecutionToolResultError`

  - `JsonValue type = "bash_code_execution_tool_result_error"`

  - `ErrorCode 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")`

### Beta Bash Code Execution Tool Result Error Param

- `class BetaBashCodeExecutionToolResultErrorParam`

  - `JsonValue type = "bash_code_execution_tool_result_error"`

  - `ErrorCode 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")`

### Beta Browser Click Target

- `class BetaBrowserClickTarget: union`

  Where to act: either a viewport coordinate or an element reference.

  - `class BetaBrowserCoordinateTarget`

    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 BetaBrowserRefTarget`

    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.

### Beta Browser Close Tab Config

- `class BetaBrowserCloseTabConfig`

  `close_tab`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Close Tab Input

- `class BetaBrowserCloseTabInput`

  Close the tab with the given tab_id.

  - `String tabId`

    The tab to close.

### Beta Browser Close Tab Tool Use Block

- `class BetaBrowserCloseTabToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserCloseTabInput input`

    Close the tab with the given tab_id.

    - `String tabId`

      The tab to close.

  - `JsonValue name = "close_tab"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Coordinate Target

- `class BetaBrowserCoordinateTarget`

  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

### Beta Browser Double Click Config

- `class BetaBrowserDoubleClickConfig`

  `double_click`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Double Click Input

- `class BetaBrowserDoubleClickInput`

  Double left-click at a viewport coordinate or on an element by reference.

  - `BetaBrowserClickTarget target`

    Where to act: either a viewport coordinate or an element reference.

    - `class BetaBrowserCoordinateTarget`

      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 BetaBrowserRefTarget`

      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<String> modifiers`

    Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

  - `Optional<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Double Click Tool Use Block

- `class BetaBrowserDoubleClickToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserDoubleClickInput input`

    Double left-click at a viewport coordinate or on an element by reference.

    - `BetaBrowserClickTarget target`

      Where to act: either a viewport coordinate or an element reference.

      - `class BetaBrowserCoordinateTarget`

        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 BetaBrowserRefTarget`

        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<String> modifiers`

      Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

    - `Optional<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "double_click"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser File Upload Config

- `class BetaBrowserFileUploadConfig`

  `file_upload`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser File Upload Input

- `class BetaBrowserFileUploadInput`

  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.

  - `BetaBrowserRefTarget 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<List<String>> documentIds`

    References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem.

    minItems: 1

  - `Optional<List<String>> paths`

    File paths on the browser executor's filesystem.

    minItems: 1

  - `Optional<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser File Upload Tool Use Block

- `class BetaBrowserFileUploadToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserFileUploadInput 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.

    - `BetaBrowserRefTarget 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<List<String>> documentIds`

      References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem.

      minItems: 1

    - `Optional<List<String>> paths`

      File paths on the browser executor's filesystem.

      minItems: 1

    - `Optional<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "file_upload"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Find Config

- `class BetaBrowserFindConfig`

  `find`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Find Input

- `class BetaBrowserFindInput`

  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<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Find Tool Use Block

- `class BetaBrowserFindToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserFindInput 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<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "find"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Form Input Config

- `class BetaBrowserFormInputConfig`

  `form_input`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Form Input Input

- `class BetaBrowserFormInputInput`

  Set the value of a form element (input, textarea, select, checkbox). Use a
  boolean for checkboxes, an option value or text for selects.

  - `BetaBrowserRefTarget 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.

  - `BetaBrowserFormInputValue value`

    The value to set.

    - `String`

    - `double`

    - `boolean`

  - `Optional<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Form Input Tool Use Block

- `class BetaBrowserFormInputToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserFormInputInput input`

    Set the value of a form element (input, textarea, select, checkbox). Use a
    boolean for checkboxes, an option value or text for selects.

    - `BetaBrowserRefTarget 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.

    - `BetaBrowserFormInputValue value`

      The value to set.

      - `String`

      - `double`

      - `boolean`

    - `Optional<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "form_input"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Form Input Value

- `class BetaBrowserFormInputValue: union`

  - `String`

  - `double`

  - `boolean`

### Beta Browser Get Page Text Config

- `class BetaBrowserGetPageTextConfig`

  `get_page_text`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Get Page Text Input

- `class BetaBrowserGetPageTextInput`

  Return the page's visible text content as plain text, prioritizing article
  content. Suited to articles, documentation, and other text-heavy pages.

  - `Optional<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Get Page Text Tool Use Block

- `class BetaBrowserGetPageTextToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserGetPageTextInput input`

    Return the page's visible text content as plain text, prioritizing article
    content. Suited to articles, documentation, and other text-heavy pages.

    - `Optional<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "get_page_text"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Hold Key Config

- `class BetaBrowserHoldKeyConfig`

  `hold_key`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Hold Key Input

- `class BetaBrowserHoldKeyInput`

  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<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Hold Key Tool Use Block

- `class BetaBrowserHoldKeyToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserHoldKeyInput 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<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "hold_key"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Hover Config

- `class BetaBrowserHoverConfig`

  `hover`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Hover Input

- `class BetaBrowserHoverInput`

  Move the cursor to a coordinate or element without clicking.

  - `BetaBrowserClickTarget target`

    Where to act: either a viewport coordinate or an element reference.

    - `class BetaBrowserCoordinateTarget`

      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 BetaBrowserRefTarget`

      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<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Hover Tool Use Block

- `class BetaBrowserHoverToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserHoverInput input`

    Move the cursor to a coordinate or element without clicking.

    - `BetaBrowserClickTarget target`

      Where to act: either a viewport coordinate or an element reference.

      - `class BetaBrowserCoordinateTarget`

        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 BetaBrowserRefTarget`

        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<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "hover"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Javascript Exec Config

- `class BetaBrowserJavascriptExecConfig`

  `javascript_exec`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Javascript Exec Input

- `class BetaBrowserJavascriptExecInput`

  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<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Javascript Exec Tool Use Block

- `class BetaBrowserJavascriptExecToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserJavascriptExecInput 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<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "javascript_exec"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Key Config

- `class BetaBrowserKeyConfig`

  `key`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Key Input

- `class BetaBrowserKeyInput`

  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<Long> repeat`

    Number of times to repeat. Default 1.

    minimum: 1, maximum: 100

  - `Optional<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Key Tool Use Block

- `class BetaBrowserKeyToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserKeyInput 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<Long> repeat`

      Number of times to repeat. Default 1.

      minimum: 1, maximum: 100

    - `Optional<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "key"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Left Click Config

- `class BetaBrowserLeftClickConfig`

  `left_click`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Left Click Drag Config

- `class BetaBrowserLeftClickDragConfig`

  `left_click_drag`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Left Click Drag Input

- `class BetaBrowserLeftClickDragInput`

  Press at `from`, drag to `target`, release. Both must be coordinate targets.

  - `BetaBrowserCoordinateTarget 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

  - `BetaBrowserCoordinateTarget target`

    A point in the browser viewport, in viewport pixels (the same frame as a
    full-viewport screenshot).

  - `Optional<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Left Click Drag Tool Use Block

- `class BetaBrowserLeftClickDragToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserLeftClickDragInput input`

    Press at `from`, drag to `target`, release. Both must be coordinate targets.

    - `BetaBrowserCoordinateTarget 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

    - `BetaBrowserCoordinateTarget target`

      A point in the browser viewport, in viewport pixels (the same frame as a
      full-viewport screenshot).

    - `Optional<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "left_click_drag"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Left Click Input

- `class BetaBrowserLeftClickInput`

  Left-click at a viewport coordinate or on an element by reference.

  - `BetaBrowserClickTarget target`

    Where to act: either a viewport coordinate or an element reference.

    - `class BetaBrowserCoordinateTarget`

      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 BetaBrowserRefTarget`

      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<String> modifiers`

    Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

  - `Optional<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Left Click Tool Use Block

- `class BetaBrowserLeftClickToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserLeftClickInput input`

    Left-click at a viewport coordinate or on an element by reference.

    - `BetaBrowserClickTarget target`

      Where to act: either a viewport coordinate or an element reference.

      - `class BetaBrowserCoordinateTarget`

        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 BetaBrowserRefTarget`

        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<String> modifiers`

      Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

    - `Optional<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "left_click"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Left Mouse Down Config

- `class BetaBrowserLeftMouseDownConfig`

  `left_mouse_down`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Left Mouse Down Input

- `class BetaBrowserLeftMouseDownInput`

  Press and hold the left mouse button at a viewport coordinate. Pair with
  left_mouse_up to perform a custom drag.

  - `BetaBrowserCoordinateTarget 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<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Left Mouse Down Tool Use Block

- `class BetaBrowserLeftMouseDownToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserLeftMouseDownInput input`

    Press and hold the left mouse button at a viewport coordinate. Pair with
    left_mouse_up to perform a custom drag.

    - `BetaBrowserCoordinateTarget 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<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "left_mouse_down"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Left Mouse Up Config

- `class BetaBrowserLeftMouseUpConfig`

  `left_mouse_up`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Left Mouse Up Input

- `class BetaBrowserLeftMouseUpInput`

  Release the left mouse button at a viewport coordinate.

  - `BetaBrowserCoordinateTarget 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<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Left Mouse Up Tool Use Block

- `class BetaBrowserLeftMouseUpToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserLeftMouseUpInput input`

    Release the left mouse button at a viewport coordinate.

    - `BetaBrowserCoordinateTarget 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<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "left_mouse_up"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser List Tabs Config

- `class BetaBrowserListTabsConfig`

  `list_tabs`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser List Tabs Input

- `class BetaBrowserListTabsInput:`

  List all open tabs with each tab's tab_id, title, and URL.

### Beta Browser List Tabs Tool Use Block

- `class BetaBrowserListTabsToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserListTabsInput input`

    List all open tabs with each tab's tab_id, title, and URL.

  - `JsonValue name = "list_tabs"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Middle Click Config

- `class BetaBrowserMiddleClickConfig`

  `middle_click`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Middle Click Input

- `class BetaBrowserMiddleClickInput`

  Middle-click at a viewport coordinate or on an element by reference.

  - `BetaBrowserClickTarget target`

    Where to act: either a viewport coordinate or an element reference.

    - `class BetaBrowserCoordinateTarget`

      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 BetaBrowserRefTarget`

      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<String> modifiers`

    Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

  - `Optional<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Middle Click Tool Use Block

- `class BetaBrowserMiddleClickToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserMiddleClickInput input`

    Middle-click at a viewport coordinate or on an element by reference.

    - `BetaBrowserClickTarget target`

      Where to act: either a viewport coordinate or an element reference.

      - `class BetaBrowserCoordinateTarget`

        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 BetaBrowserRefTarget`

        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<String> modifiers`

      Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

    - `Optional<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "middle_click"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Mouse Move Config

- `class BetaBrowserMouseMoveConfig`

  `mouse_move`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Mouse Move Input

- `class BetaBrowserMouseMoveInput`

  Move the pointer to a viewport coordinate without clicking.

  - `BetaBrowserCoordinateTarget 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<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Mouse Move Tool Use Block

- `class BetaBrowserMouseMoveToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserMouseMoveInput input`

    Move the pointer to a viewport coordinate without clicking.

    - `BetaBrowserCoordinateTarget 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<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "mouse_move"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Navigate Config

- `class BetaBrowserNavigateConfig`

  `navigate`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Navigate Input

- `class BetaBrowserNavigateInput`

  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<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Navigate Tool Use Block

- `class BetaBrowserNavigateToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserNavigateInput 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<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "navigate"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser New Tab Config

- `class BetaBrowserNewTabConfig`

  `new_tab`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser New Tab Input

- `class BetaBrowserNewTabInput:`

  Open a new empty tab and return its tab_id.

### Beta Browser New Tab Tool Use Block

- `class BetaBrowserNewTabToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserNewTabInput input`

    Open a new empty tab and return its tab_id.

  - `JsonValue name = "new_tab"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Read Console Config

- `class BetaBrowserReadConsoleConfig`

  `read_console`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Read Console Input

- `class BetaBrowserReadConsoleInput`

  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<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Read Console Tool Use Block

- `class BetaBrowserReadConsoleToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserReadConsoleInput 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<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "read_console"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Read Network Config

- `class BetaBrowserReadNetworkConfig`

  `read_network`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Read Network Input

- `class BetaBrowserReadNetworkInput`

  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<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Read Network Tool Use Block

- `class BetaBrowserReadNetworkToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserReadNetworkInput 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<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "read_network"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Read Page Config

- `class BetaBrowserReadPageConfig`

  `read_page`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Read Page Filter

- `enum BetaBrowserReadPageFilter`

  - `ALL("all")`

  - `INTERACTIVE("interactive")`

### Beta Browser Read Page Input

- `class BetaBrowserReadPageInput`

  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<Long> depth`

    Maximum tree depth. Default 15.

    minimum: 1

  - `Optional<BetaBrowserReadPageFilter> filter`

    Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements.

    - `ALL("all")`

    - `INTERACTIVE("interactive")`

  - `Optional<String> ref`

    Element reference to read a subtree from. Omit to read from the page root.

  - `Optional<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Read Page Tool Use Block

- `class BetaBrowserReadPageToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserReadPageInput 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<Long> depth`

      Maximum tree depth. Default 15.

      minimum: 1

    - `Optional<BetaBrowserReadPageFilter> filter`

      Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements.

      - `ALL("all")`

      - `INTERACTIVE("interactive")`

    - `Optional<String> ref`

      Element reference to read a subtree from. Omit to read from the page root.

    - `Optional<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "read_page"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Ref Target

- `class BetaBrowserRefTarget`

  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.

### Beta Browser Right Click Config

- `class BetaBrowserRightClickConfig`

  `right_click`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Right Click Input

- `class BetaBrowserRightClickInput`

  Right-click at a viewport coordinate or on an element by reference.

  - `BetaBrowserClickTarget target`

    Where to act: either a viewport coordinate or an element reference.

    - `class BetaBrowserCoordinateTarget`

      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 BetaBrowserRefTarget`

      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<String> modifiers`

    Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

  - `Optional<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Right Click Tool Use Block

- `class BetaBrowserRightClickToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserRightClickInput input`

    Right-click at a viewport coordinate or on an element by reference.

    - `BetaBrowserClickTarget target`

      Where to act: either a viewport coordinate or an element reference.

      - `class BetaBrowserCoordinateTarget`

        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 BetaBrowserRefTarget`

        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<String> modifiers`

      Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

    - `Optional<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "right_click"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Screenshot Config

- `class BetaBrowserScreenshotConfig`

  `screenshot`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Screenshot Input

- `class BetaBrowserScreenshotInput`

  Capture the current browser viewport.

  - `Optional<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Screenshot Tool Use Block

- `class BetaBrowserScreenshotToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserScreenshotInput input`

    Capture the current browser viewport.

    - `Optional<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "screenshot"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Scroll Config

- `class BetaBrowserScrollConfig`

  `scroll`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Scroll Direction

- `enum BetaBrowserScrollDirection`

  - `UP("up")`

  - `DOWN("down")`

  - `LEFT("left")`

  - `RIGHT("right")`

### Beta Browser Scroll Input

- `class BetaBrowserScrollInput`

  Scroll at a viewport position. `target` must be a coordinate target.

  - `BetaBrowserScrollDirection scrollDirection`

    - `UP("up")`

    - `DOWN("down")`

    - `LEFT("left")`

    - `RIGHT("right")`

  - `BetaBrowserCoordinateTarget 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<Long> scrollAmount`

    Scroll-wheel notches (1–10). Default 3.

    minimum: 1, maximum: 10

  - `Optional<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Scroll To Config

- `class BetaBrowserScrollToConfig`

  `scroll_to`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Scroll To Input

- `class BetaBrowserScrollToInput`

  Scroll an element into view.

  - `BetaBrowserRefTarget 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<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Scroll To Tool Use Block

- `class BetaBrowserScrollToToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserScrollToInput input`

    Scroll an element into view.

    - `BetaBrowserRefTarget 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<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "scroll_to"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Scroll Tool Use Block

- `class BetaBrowserScrollToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserScrollInput input`

    Scroll at a viewport position. `target` must be a coordinate target.

    - `BetaBrowserScrollDirection scrollDirection`

      - `UP("up")`

      - `DOWN("down")`

      - `LEFT("left")`

      - `RIGHT("right")`

    - `BetaBrowserCoordinateTarget 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<Long> scrollAmount`

      Scroll-wheel notches (1–10). Default 3.

      minimum: 1, maximum: 10

    - `Optional<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "scroll"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser State Block Param

- `class BetaBrowserStateBlockParam`

  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<BetaBrowserStateTabEntry> 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<Boolean> active`

      Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<List<BetaBrowserStateChange>> 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 BetaBrowserStateChangeTabOpened`

      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 BetaBrowserStateChangeDownloadStarted`

      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 BetaBrowserStateChangeDownloadCompleted`

      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<String> 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<Long> sizeBytes`

        The completed download's size.

        minimum: 0

    - `class BetaBrowserStateChangeDownloadFailed`

      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<String> error`

        The failure or cancellation detail, when known.

        maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$

### Beta Browser State Change

- `class BetaBrowserStateChange: union`

  - `class BetaBrowserStateChangeTabOpened`

    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 BetaBrowserStateChangeDownloadStarted`

    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 BetaBrowserStateChangeDownloadCompleted`

    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<String> 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<Long> sizeBytes`

      The completed download's size.

      minimum: 0

  - `class BetaBrowserStateChangeDownloadFailed`

    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<String> error`

      The failure or cancellation detail, when known.

      maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$

### Beta Browser State Change Download Completed

- `class BetaBrowserStateChangeDownloadCompleted`

  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<String> 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<Long> sizeBytes`

    The completed download's size.

    minimum: 0

### Beta Browser State Change Download Failed

- `class BetaBrowserStateChangeDownloadFailed`

  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<String> error`

    The failure or cancellation detail, when known.

    maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$

### Beta Browser State Change Download Started

- `class BetaBrowserStateChangeDownloadStarted`

  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]*$

### Beta Browser State Change Tab Opened

- `class BetaBrowserStateChangeTabOpened`

  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]*$

### Beta Browser State Tab Entry

- `class BetaBrowserStateTabEntry`

  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<Boolean> active`

    Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.

### Beta Browser Switch Tab Config

- `class BetaBrowserSwitchTabConfig`

  `switch_tab`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Switch Tab Input

- `class BetaBrowserSwitchTabInput`

  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.

### Beta Browser Switch Tab Tool Use Block

- `class BetaBrowserSwitchTabToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserSwitchTabInput 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"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Tool Use Block

- `class BetaBrowserToolUseBlock: union`

  - `class BetaBrowserNavigateToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserNavigateInput 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<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "navigate"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

      - `class BetaDirectCaller`

        Tool invocation directly from the model.

        - `JsonValue type = "direct"`

      - `class BetaServerToolCaller`

        Tool invocation generated by a server-side tool.

        - `JsonValue type = "code_execution_20250825"`

        - `String toolId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `class BetaServerToolCaller20260120`

        - `JsonValue type = "code_execution_20260120"`

        - `String toolId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `class BetaBrowserListTabsToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserListTabsInput input`

      List all open tabs with each tab's tab_id, title, and URL.

    - `JsonValue name = "list_tabs"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserNewTabToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserNewTabInput input`

      Open a new empty tab and return its tab_id.

    - `JsonValue name = "new_tab"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserSwitchTabToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserSwitchTabInput 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"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserCloseTabToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserCloseTabInput input`

      Close the tab with the given tab_id.

      - `String tabId`

        The tab to close.

    - `JsonValue name = "close_tab"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserReadPageToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserReadPageInput 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<Long> depth`

        Maximum tree depth. Default 15.

        minimum: 1

      - `Optional<BetaBrowserReadPageFilter> filter`

        Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements.

        - `ALL("all")`

        - `INTERACTIVE("interactive")`

      - `Optional<String> ref`

        Element reference to read a subtree from. Omit to read from the page root.

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "read_page"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserGetPageTextToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserGetPageTextInput input`

      Return the page's visible text content as plain text, prioritizing article
      content. Suited to articles, documentation, and other text-heavy pages.

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "get_page_text"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserReadConsoleToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserReadConsoleInput 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<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "read_console"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserReadNetworkToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserReadNetworkInput 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<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "read_network"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserFindToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserFindInput 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<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "find"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserFormInputToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserFormInputInput input`

      Set the value of a form element (input, textarea, select, checkbox). Use a
      boolean for checkboxes, an option value or text for selects.

      - `BetaBrowserRefTarget 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.

      - `BetaBrowserFormInputValue value`

        The value to set.

        - `String`

        - `double`

        - `boolean`

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "form_input"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserFileUploadToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserFileUploadInput 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.

      - `BetaBrowserRefTarget 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<List<String>> documentIds`

        References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem.

        minItems: 1

      - `Optional<List<String>> paths`

        File paths on the browser executor's filesystem.

        minItems: 1

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "file_upload"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserScrollToToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserScrollToInput input`

      Scroll an element into view.

      - `BetaBrowserRefTarget 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<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "scroll_to"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserScreenshotToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserScreenshotInput input`

      Capture the current browser viewport.

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "screenshot"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserZoomToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserZoomInput 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<long> region`

        [x0, y0, x1, y1] in viewport pixels.

        minItems: 4, maxItems: 4

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "zoom"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserLeftClickToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserLeftClickInput input`

      Left-click at a viewport coordinate or on an element by reference.

      - `BetaBrowserClickTarget target`

        Where to act: either a viewport coordinate or an element reference.

        - `class BetaBrowserCoordinateTarget`

          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 BetaBrowserRefTarget`

          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<String> modifiers`

        Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "left_click"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserRightClickToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserRightClickInput input`

      Right-click at a viewport coordinate or on an element by reference.

      - `BetaBrowserClickTarget target`

        Where to act: either a viewport coordinate or an element reference.

      - `Optional<String> modifiers`

        Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "right_click"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserMiddleClickToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserMiddleClickInput input`

      Middle-click at a viewport coordinate or on an element by reference.

      - `BetaBrowserClickTarget target`

        Where to act: either a viewport coordinate or an element reference.

      - `Optional<String> modifiers`

        Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "middle_click"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserDoubleClickToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserDoubleClickInput input`

      Double left-click at a viewport coordinate or on an element by reference.

      - `BetaBrowserClickTarget target`

        Where to act: either a viewport coordinate or an element reference.

      - `Optional<String> modifiers`

        Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "double_click"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserTripleClickToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserTripleClickInput input`

      Triple left-click at a viewport coordinate or on an element by reference
      (typically selects a line or paragraph).

      - `BetaBrowserClickTarget target`

        Where to act: either a viewport coordinate or an element reference.

      - `Optional<String> modifiers`

        Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "triple_click"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserHoverToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserHoverInput input`

      Move the cursor to a coordinate or element without clicking.

      - `BetaBrowserClickTarget target`

        Where to act: either a viewport coordinate or an element reference.

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "hover"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserLeftClickDragToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserLeftClickDragInput input`

      Press at `from`, drag to `target`, release. Both must be coordinate targets.

      - `BetaBrowserCoordinateTarget from`

        A point in the browser viewport, in viewport pixels (the same frame as a
        full-viewport screenshot).

      - `BetaBrowserCoordinateTarget target`

        A point in the browser viewport, in viewport pixels (the same frame as a
        full-viewport screenshot).

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "left_click_drag"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserLeftMouseDownToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserLeftMouseDownInput input`

      Press and hold the left mouse button at a viewport coordinate. Pair with
      left_mouse_up to perform a custom drag.

      - `BetaBrowserCoordinateTarget target`

        A point in the browser viewport, in viewport pixels (the same frame as a
        full-viewport screenshot).

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "left_mouse_down"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserLeftMouseUpToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserLeftMouseUpInput input`

      Release the left mouse button at a viewport coordinate.

      - `BetaBrowserCoordinateTarget target`

        A point in the browser viewport, in viewport pixels (the same frame as a
        full-viewport screenshot).

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "left_mouse_up"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserMouseMoveToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserMouseMoveInput input`

      Move the pointer to a viewport coordinate without clicking.

      - `BetaBrowserCoordinateTarget target`

        A point in the browser viewport, in viewport pixels (the same frame as a
        full-viewport screenshot).

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "mouse_move"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserScrollToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserScrollInput input`

      Scroll at a viewport position. `target` must be a coordinate target.

      - `BetaBrowserScrollDirection scrollDirection`

        - `UP("up")`

        - `DOWN("down")`

        - `LEFT("left")`

        - `RIGHT("right")`

      - `BetaBrowserCoordinateTarget target`

        A point in the browser viewport, in viewport pixels (the same frame as a
        full-viewport screenshot).

      - `Optional<Long> scrollAmount`

        Scroll-wheel notches (1–10). Default 3.

        minimum: 1, maximum: 10

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "scroll"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserTypeToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserTypeInput input`

      Type a literal string at the current focus.

      - `String text`

        The text to type.

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "type"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserKeyToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserKeyInput 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<Long> repeat`

        Number of times to repeat. Default 1.

        minimum: 1, maximum: 100

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "key"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserHoldKeyToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserHoldKeyInput 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<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "hold_key"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserWaitToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserWaitInput input`

      Pause for the given duration.

      - `double duration`

        Seconds to wait (maximum 30).

        minimum: 0, maximum: 30

      - `Optional<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "wait"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaBrowserJavascriptExecToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaBrowserJavascriptExecInput 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<String> tabId`

        Tab to act on. Defaults to the active tab when omitted.

    - `JsonValue name = "javascript_exec"`

    - `JsonValue toolsetName = "browser"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

### Beta Browser Toolset 20260801

- `class BetaBrowserToolset20260801`

  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<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

      `type`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserCloseTabConfig> closeTab`

      `close_tab`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

      `double_click`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserFileUploadConfig> fileUpload`

      `file_upload`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserFindConfig> find`

      `find`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserFormInputConfig> formInput`

      `form_input`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserGetPageTextConfig> getPageText`

      `get_page_text`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserHoldKeyConfig> holdKey`

      `hold_key`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserHoverConfig> hover`

      `hover`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

      `javascript_exec`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserKeyConfig> key`

      `key`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserLeftClickConfig> leftClick`

      `left_click`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

      `left_click_drag`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

      `left_mouse_down`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

      `left_mouse_up`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserListTabsConfig> listTabs`

      `list_tabs`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserMiddleClickConfig> middleClick`

      `middle_click`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

      `mouse_move`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserNavigateConfig> navigate`

      `navigate`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserNewTabConfig> newTab`

      `new_tab`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserReadConsoleConfig> readConsole`

      `read_console`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

      `read_network`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserReadPageConfig> readPage`

      `read_page`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserRightClickConfig> rightClick`

      `right_click`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserScreenshotConfig> screenshot`

      `screenshot`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserScrollConfig> scroll`

      `scroll`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserScrollToConfig> scrollTo`

      `scroll_to`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserSwitchTabConfig> switchTab`

      `switch_tab`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserTripleClickConfig> tripleClick`

      `triple_click`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserWaitConfig> wait`

      `wait`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaBrowserZoomConfig> zoom`

      `zoom`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Toolset Configs

- `class BetaBrowserToolsetConfigs`

  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<BetaBrowserTypeConfig> type`

    `type`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserCloseTabConfig> closeTab`

    `close_tab`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

    `double_click`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserFileUploadConfig> fileUpload`

    `file_upload`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserFindConfig> find`

    `find`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserFormInputConfig> formInput`

    `form_input`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserGetPageTextConfig> getPageText`

    `get_page_text`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserHoldKeyConfig> holdKey`

    `hold_key`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserHoverConfig> hover`

    `hover`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

    `javascript_exec`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserKeyConfig> key`

    `key`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserLeftClickConfig> leftClick`

    `left_click`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

    `left_click_drag`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

    `left_mouse_down`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

    `left_mouse_up`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserListTabsConfig> listTabs`

    `list_tabs`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserMiddleClickConfig> middleClick`

    `middle_click`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

    `mouse_move`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserNavigateConfig> navigate`

    `navigate`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserNewTabConfig> newTab`

    `new_tab`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserReadConsoleConfig> readConsole`

    `read_console`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

    `read_network`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserReadPageConfig> readPage`

    `read_page`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserRightClickConfig> rightClick`

    `right_click`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserScreenshotConfig> screenshot`

    `screenshot`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserScrollConfig> scroll`

    `scroll`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserScrollToConfig> scrollTo`

    `scroll_to`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserSwitchTabConfig> switchTab`

    `switch_tab`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserTripleClickConfig> tripleClick`

    `triple_click`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserWaitConfig> wait`

    `wait`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaBrowserZoomConfig> zoom`

    `zoom`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Triple Click Config

- `class BetaBrowserTripleClickConfig`

  `triple_click`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Triple Click Input

- `class BetaBrowserTripleClickInput`

  Triple left-click at a viewport coordinate or on an element by reference
  (typically selects a line or paragraph).

  - `BetaBrowserClickTarget target`

    Where to act: either a viewport coordinate or an element reference.

    - `class BetaBrowserCoordinateTarget`

      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 BetaBrowserRefTarget`

      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<String> modifiers`

    Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

  - `Optional<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Triple Click Tool Use Block

- `class BetaBrowserTripleClickToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserTripleClickInput input`

    Triple left-click at a viewport coordinate or on an element by reference
    (typically selects a line or paragraph).

    - `BetaBrowserClickTarget target`

      Where to act: either a viewport coordinate or an element reference.

      - `class BetaBrowserCoordinateTarget`

        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 BetaBrowserRefTarget`

        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<String> modifiers`

      Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

    - `Optional<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "triple_click"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Type Config

- `class BetaBrowserTypeConfig`

  `type`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Type Input

- `class BetaBrowserTypeInput`

  Type a literal string at the current focus.

  - `String text`

    The text to type.

  - `Optional<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Type Tool Use Block

- `class BetaBrowserTypeToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserTypeInput input`

    Type a literal string at the current focus.

    - `String text`

      The text to type.

    - `Optional<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "type"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Wait Config

- `class BetaBrowserWaitConfig`

  `wait`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Wait Input

- `class BetaBrowserWaitInput`

  Pause for the given duration.

  - `double duration`

    Seconds to wait (maximum 30).

    minimum: 0, maximum: 30

  - `Optional<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Wait Tool Use Block

- `class BetaBrowserWaitToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserWaitInput input`

    Pause for the given duration.

    - `double duration`

      Seconds to wait (maximum 30).

      minimum: 0, maximum: 30

    - `Optional<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "wait"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Browser Zoom Config

- `class BetaBrowserZoomConfig`

  `zoom`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Browser Zoom Input

- `class BetaBrowserZoomInput`

  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<long> region`

    [x0, y0, x1, y1] in viewport pixels.

    minItems: 4, maxItems: 4

  - `Optional<String> tabId`

    Tab to act on. Defaults to the active tab when omitted.

### Beta Browser Zoom Tool Use Block

- `class BetaBrowserZoomToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaBrowserZoomInput 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<long> region`

      [x0, y0, x1, y1] in viewport pixels.

      minItems: 4, maxItems: 4

    - `Optional<String> tabId`

      Tab to act on. Defaults to the active tab when omitted.

  - `JsonValue name = "zoom"`

  - `JsonValue toolsetName = "browser"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Cache Control Ephemeral

- `class BetaCacheControlEphemeral`

  - `JsonValue type = "ephemeral"`

  - `Optional<Ttl> 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")`

### Beta Cache Creation

- `class BetaCacheCreation`

  - `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

### Beta Cache Miss Messages Changed

- `class BetaCacheMissMessagesChanged`

  - `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.

### Beta Cache Miss Model Changed

- `class BetaCacheMissModelChanged`

  - `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.

### Beta Cache Miss Previous Message Not Found

- `class BetaCacheMissPreviousMessageNotFound`

  - `JsonValue type = "previous_message_not_found"`

### Beta Cache Miss Reason

- `class BetaCacheMissReason: union`

  - `class BetaCacheMissModelChanged`

    - `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 BetaCacheMissSystemChanged`

    - `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 BetaCacheMissToolsChanged`

    - `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 BetaCacheMissMessagesChanged`

    - `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 BetaCacheMissPreviousMessageNotFound`

    - `JsonValue type = "previous_message_not_found"`

  - `class BetaCacheMissUnavailable`

    - `JsonValue type = "unavailable"`

### Beta Cache Miss System Changed

- `class BetaCacheMissSystemChanged`

  - `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.

### Beta Cache Miss Tools Changed

- `class BetaCacheMissToolsChanged`

  - `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.

### Beta Cache Miss Unavailable

- `class BetaCacheMissUnavailable`

  - `JsonValue type = "unavailable"`

### Beta Citation Char Location

- `class BetaCitationCharLocation`

  - `JsonValue type = "char_location"`

  - `String citedText`

  - `long documentIndex`

    minimum: 0

  - `Optional<String> documentTitle`

  - `long endCharIndex`

  - `Optional<String> fileId`

  - `long startCharIndex`

    minimum: 0

### Beta Citation Char Location Param

- `class BetaCitationCharLocationParam`

  - `JsonValue type = "char_location"`

  - `String citedText`

  - `long documentIndex`

    minimum: 0

  - `Optional<String> documentTitle`

    minLength: 1, maxLength: 500

  - `long endCharIndex`

  - `long startCharIndex`

    minimum: 0

### Beta Citation Config

- `class BetaCitationConfig`

  - `boolean enabled`

### Beta Citation Content Block Location

- `class BetaCitationContentBlockLocation`

  - `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<String> 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<String> fileId`

  - `long startBlockIndex`

    0-based index of the first cited block in the source's `content` array.

    minimum: 0

### Beta Citation Content Block Location Param

- `class BetaCitationContentBlockLocationParam`

  - `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<String> 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

### Beta Citation Page Location

- `class BetaCitationPageLocation`

  - `JsonValue type = "page_location"`

  - `String citedText`

  - `long documentIndex`

    minimum: 0

  - `Optional<String> documentTitle`

  - `long endPageNumber`

  - `Optional<String> fileId`

  - `long startPageNumber`

    minimum: 1

### Beta Citation Page Location Param

- `class BetaCitationPageLocationParam`

  - `JsonValue type = "page_location"`

  - `String citedText`

  - `long documentIndex`

    minimum: 0

  - `Optional<String> documentTitle`

    minLength: 1, maxLength: 500

  - `long endPageNumber`

  - `long startPageNumber`

    minimum: 1

### Beta Citation Search Result Location

- `class BetaCitationSearchResultLocation`

  - `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<String> title`

### Beta Citation Search Result Location Param

- `class BetaCitationSearchResultLocationParam`

  - `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<String> title`

### Beta Citation Web Search Result Location Param

- `class BetaCitationWebSearchResultLocationParam`

  - `JsonValue type = "web_search_result_location"`

  - `String citedText`

  - `String encryptedIndex`

  - `Optional<String> title`

    minLength: 1, maxLength: 512

  - `String url`

    minLength: 1

### Beta Citations Config Param

- `class BetaCitationsConfigParam`

  - `Optional<Boolean> enabled`

### Beta Citations Delta

- `class BetaCitationsDelta`

  - `JsonValue type = "citations_delta"`

  - `Citation citation`

    - `class BetaCitationCharLocation`

      - `JsonValue type = "char_location"`

      - `String citedText`

      - `long documentIndex`

        minimum: 0

      - `Optional<String> documentTitle`

      - `long endCharIndex`

      - `Optional<String> fileId`

      - `long startCharIndex`

        minimum: 0

    - `class BetaCitationPageLocation`

      - `JsonValue type = "page_location"`

      - `String citedText`

      - `long documentIndex`

        minimum: 0

      - `Optional<String> documentTitle`

      - `long endPageNumber`

      - `Optional<String> fileId`

      - `long startPageNumber`

        minimum: 1

    - `class BetaCitationContentBlockLocation`

      - `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<String> 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<String> fileId`

      - `long startBlockIndex`

        0-based index of the first cited block in the source's `content` array.

        minimum: 0

    - `class BetaCitationsWebSearchResultLocation`

      - `JsonValue type = "web_search_result_location"`

      - `String citedText`

      - `String encryptedIndex`

      - `Optional<String> title`

        maxLength: 512

      - `String url`

    - `class BetaCitationSearchResultLocation`

      - `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<String> title`

### Beta Citations Web Search Result Location

- `class BetaCitationsWebSearchResultLocation`

  - `JsonValue type = "web_search_result_location"`

  - `String citedText`

  - `String encryptedIndex`

  - `Optional<String> title`

    maxLength: 512

  - `String url`

### Beta Clear Thinking 20251015 Edit

- `class BetaClearThinking20251015Edit`

  - `JsonValue type = "clear_thinking_20251015"`

  - `Optional<Keep> keep`

    Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.

    - `class BetaThinkingTurns`

      - `JsonValue type = "thinking_turns"`

      - `long value`

        minimum: 1

    - `class BetaAllThinkingTurns`

      - `JsonValue type = "all"`

    - `JsonValue`

### Beta Clear Thinking 20251015 Edit Response

- `class BetaClearThinking20251015EditResponse`

  - `JsonValue type = "clear_thinking_20251015"`

    The type of context management edit applied.

  - `long clearedInputTokens`

    Number of input tokens cleared by this edit.

    minimum: 0

  - `long clearedThinkingTurns`

    Number of thinking turns that were cleared.

    minimum: 0

### Beta Clear Tool Uses 20250919 Edit

- `class BetaClearToolUses20250919Edit`

  - `JsonValue type = "clear_tool_uses_20250919"`

  - `Optional<BetaInputTokensClearAtLeast> clearAtLeast`

    Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.

    - `JsonValue type = "input_tokens"`

    - `long value`

      minimum: 0

  - `Optional<ClearToolInputs> clearToolInputs`

    Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)

    - `boolean`

    - `List<String>`

  - `Optional<List<String>> excludeTools`

    Tool names whose uses are preserved from clearing

  - `Optional<BetaToolUsesKeep> keep`

    Number of tool uses to retain in the conversation

    - `JsonValue type = "tool_uses"`

    - `long value`

      minimum: 0

  - `Optional<Trigger> trigger`

    Condition that triggers the context management strategy

    - `class BetaInputTokensTrigger`

      - `JsonValue type = "input_tokens"`

      - `long value`

        minimum: 1

    - `class BetaToolUsesTrigger`

      - `JsonValue type = "tool_uses"`

      - `long value`

        minimum: 1

### Beta Clear Tool Uses 20250919 Edit Response

- `class BetaClearToolUses20250919EditResponse`

  - `JsonValue type = "clear_tool_uses_20250919"`

    The type of context management edit applied.

  - `long clearedInputTokens`

    Number of input tokens cleared by this edit.

    minimum: 0

  - `long clearedToolUses`

    Number of tool uses that were cleared.

    minimum: 0

### Beta Code Execution Output Block

- `class BetaCodeExecutionOutputBlock`

  - `JsonValue type = "code_execution_output"`

  - `String fileId`

### Beta Code Execution Output Block Param

- `class BetaCodeExecutionOutputBlockParam`

  - `JsonValue type = "code_execution_output"`

  - `String fileId`

### Beta Code Execution Result Block

- `class BetaCodeExecutionResultBlock`

  - `JsonValue type = "code_execution_result"`

  - `List<BetaCodeExecutionOutputBlock> content`

    - `JsonValue type = "code_execution_output"`

    - `String fileId`

  - `long returnCode`

  - `String stderr`

  - `String stdout`

### Beta Code Execution Result Block Param

- `class BetaCodeExecutionResultBlockParam`

  - `JsonValue type = "code_execution_result"`

  - `List<BetaCodeExecutionOutputBlockParam> content`

    - `JsonValue type = "code_execution_output"`

    - `String fileId`

  - `long returnCode`

  - `String stderr`

  - `String stdout`

### Beta Code Execution Tool 20250522

- `class BetaCodeExecutionTool20250522`

  - `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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Code Execution Tool 20250825

- `class BetaCodeExecutionTool20250825`

  - `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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Code Execution Tool 20260120

- `class BetaCodeExecutionTool20260120`

  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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Code Execution Tool 20260521

- `class BetaCodeExecutionTool20260521`

  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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Code Execution Tool Result Block

- `class BetaCodeExecutionToolResultBlock`

  - `JsonValue type = "code_execution_tool_result"`

  - `BetaCodeExecutionToolResultBlockContent content`

    - `class BetaCodeExecutionToolResultError`

      - `JsonValue type = "code_execution_tool_result_error"`

      - `BetaCodeExecutionToolResultErrorCode errorCode`

        - `INVALID_TOOL_INPUT("invalid_tool_input")`

        - `UNAVAILABLE("unavailable")`

        - `TOO_MANY_REQUESTS("too_many_requests")`

        - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

    - `class BetaCodeExecutionResultBlock`

      - `JsonValue type = "code_execution_result"`

      - `List<BetaCodeExecutionOutputBlock> content`

        - `JsonValue type = "code_execution_output"`

        - `String fileId`

      - `long returnCode`

      - `String stderr`

      - `String stdout`

    - `class BetaEncryptedCodeExecutionResultBlock`

      Code execution result with encrypted stdout for PFC + web_search results.

      - `JsonValue type = "encrypted_code_execution_result"`

      - `List<BetaCodeExecutionOutputBlock> content`

        - `JsonValue type = "code_execution_output"`

        - `String fileId`

      - `String encryptedStdout`

      - `long returnCode`

      - `String stderr`

  - `String toolUseId`

    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Code Execution Tool Result Block Content

- `class BetaCodeExecutionToolResultBlockContent: union`

  - `class BetaCodeExecutionToolResultError`

    - `JsonValue type = "code_execution_tool_result_error"`

    - `BetaCodeExecutionToolResultErrorCode errorCode`

      - `INVALID_TOOL_INPUT("invalid_tool_input")`

      - `UNAVAILABLE("unavailable")`

      - `TOO_MANY_REQUESTS("too_many_requests")`

      - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

  - `class BetaCodeExecutionResultBlock`

    - `JsonValue type = "code_execution_result"`

    - `List<BetaCodeExecutionOutputBlock> content`

      - `JsonValue type = "code_execution_output"`

      - `String fileId`

    - `long returnCode`

    - `String stderr`

    - `String stdout`

  - `class BetaEncryptedCodeExecutionResultBlock`

    Code execution result with encrypted stdout for PFC + web_search results.

    - `JsonValue type = "encrypted_code_execution_result"`

    - `List<BetaCodeExecutionOutputBlock> content`

      - `JsonValue type = "code_execution_output"`

      - `String fileId`

    - `String encryptedStdout`

    - `long returnCode`

    - `String stderr`

### Beta Code Execution Tool Result Block Param

- `class BetaCodeExecutionToolResultBlockParam`

  - `JsonValue type = "code_execution_tool_result"`

  - `BetaCodeExecutionToolResultBlockParamContent content`

    - `class BetaCodeExecutionToolResultErrorParam`

      - `JsonValue type = "code_execution_tool_result_error"`

      - `BetaCodeExecutionToolResultErrorCode errorCode`

        - `INVALID_TOOL_INPUT("invalid_tool_input")`

        - `UNAVAILABLE("unavailable")`

        - `TOO_MANY_REQUESTS("too_many_requests")`

        - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

    - `class BetaCodeExecutionResultBlockParam`

      - `JsonValue type = "code_execution_result"`

      - `List<BetaCodeExecutionOutputBlockParam> content`

        - `JsonValue type = "code_execution_output"`

        - `String fileId`

      - `long returnCode`

      - `String stderr`

      - `String stdout`

    - `class BetaEncryptedCodeExecutionResultBlockParam`

      Code execution result with encrypted stdout for PFC + web_search results.

      - `JsonValue type = "encrypted_code_execution_result"`

      - `List<BetaCodeExecutionOutputBlockParam> content`

        - `JsonValue type = "code_execution_output"`

        - `String fileId`

      - `String encryptedStdout`

      - `long returnCode`

      - `String stderr`

  - `String toolUseId`

    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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")`

### Beta Code Execution Tool Result Block Param Content

- `class BetaCodeExecutionToolResultBlockParamContent: union`

  - `class BetaCodeExecutionToolResultErrorParam`

    - `JsonValue type = "code_execution_tool_result_error"`

    - `BetaCodeExecutionToolResultErrorCode errorCode`

      - `INVALID_TOOL_INPUT("invalid_tool_input")`

      - `UNAVAILABLE("unavailable")`

      - `TOO_MANY_REQUESTS("too_many_requests")`

      - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

  - `class BetaCodeExecutionResultBlockParam`

    - `JsonValue type = "code_execution_result"`

    - `List<BetaCodeExecutionOutputBlockParam> content`

      - `JsonValue type = "code_execution_output"`

      - `String fileId`

    - `long returnCode`

    - `String stderr`

    - `String stdout`

  - `class BetaEncryptedCodeExecutionResultBlockParam`

    Code execution result with encrypted stdout for PFC + web_search results.

    - `JsonValue type = "encrypted_code_execution_result"`

    - `List<BetaCodeExecutionOutputBlockParam> content`

      - `JsonValue type = "code_execution_output"`

      - `String fileId`

    - `String encryptedStdout`

    - `long returnCode`

    - `String stderr`

### Beta Code Execution Tool Result Error

- `class BetaCodeExecutionToolResultError`

  - `JsonValue type = "code_execution_tool_result_error"`

  - `BetaCodeExecutionToolResultErrorCode errorCode`

    - `INVALID_TOOL_INPUT("invalid_tool_input")`

    - `UNAVAILABLE("unavailable")`

    - `TOO_MANY_REQUESTS("too_many_requests")`

    - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

### Beta Code Execution Tool Result Error Code

- `enum BetaCodeExecutionToolResultErrorCode`

  - `INVALID_TOOL_INPUT("invalid_tool_input")`

  - `UNAVAILABLE("unavailable")`

  - `TOO_MANY_REQUESTS("too_many_requests")`

  - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

### Beta Code Execution Tool Result Error Param

- `class BetaCodeExecutionToolResultErrorParam`

  - `JsonValue type = "code_execution_tool_result_error"`

  - `BetaCodeExecutionToolResultErrorCode errorCode`

    - `INVALID_TOOL_INPUT("invalid_tool_input")`

    - `UNAVAILABLE("unavailable")`

    - `TOO_MANY_REQUESTS("too_many_requests")`

    - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

### Beta Compact 20260112 Edit

- `class BetaCompact20260112Edit`

  Automatically compact older context when reaching the configured trigger threshold.

  - `JsonValue type = "compact_20260112"`

  - `Optional<String> instructions`

    Additional instructions for summarization.

  - `Optional<Boolean> pauseAfterCompaction`

    Whether to pause after compaction and return the compaction block to the user.

  - `Optional<BetaInputTokensTrigger> trigger`

    When to trigger compaction. Defaults to 150000 input tokens.

    - `JsonValue type = "input_tokens"`

    - `long value`

      minimum: 1

### Beta Compaction Block

- `class BetaCompactionBlock`

  A compaction block returned when autocompact is triggered.

  When content is None, it indicates the compaction failed to produce a valid
  summary (e.g., malformed output from the model). Clients may round-trip
  compaction blocks with null content; the server treats them as no-ops.

  - `JsonValue type = "compaction"`

  - `Optional<String> content`

    Summary of compacted content, or null if compaction failed

  - `Optional<String> encryptedContent`

    Opaque metadata from prior compaction, to be round-tripped verbatim

  - `Optional<String> signature`

    Signature over the summary, to be sent back with the block verbatim

  - `Optional<List<ToolChange>> toolChanges`

    The tool changes of the compacted range: the `tool_addition` and `tool_removal` blocks that take the request's `tools` to the tool set in effect at the end of the range, or `[]` when the range changed no tool. Absent when the server did not compute them. Send the block back unchanged.

    - `class BetaResponseToolAdditionBlock`

      An entry of a `compaction` block's `tool_changes`: a tool the
      compacted range made available, as a reference to a `tools` entry or
      MCP toolset, or as the tool definition in effect at the end of the
      range, by value. Send it back unchanged.

      - `JsonValue type = "tool_addition"`

      - `Tool tool`

        The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value.

        - `class BetaResponseToolChangeToolReference`

          Reference to a single tool, by the name the model uses to call it, as
          a `compaction` block's `tool_changes` entry reports it: a tool
          declared in `tools` or defined by an earlier `tool_addition` block.
          Send it back unchanged with the block.

          - `JsonValue type = "tool_reference"`

          - `String name`

        - `class BetaResponseToolChangeMcpToolReference`

          Reference to a single MCP tool, by its server and its name on that
          server, as a `compaction` block's `tool_changes` entry reports it.
          Send it back unchanged with the block.

          - `JsonValue type = "mcp_tool_reference"`

          - `String name`

          - `String serverName`

        - `class BetaResponseToolChangeMcpToolsetReference`

          Reference to every tool in the named MCP server's toolset, as a
          `compaction` block's `tool_changes` entry reports it. Send it back
          unchanged with the block.

          - `JsonValue type = "mcp_toolset_reference"`

          - `String serverName`

        - `class BetaToolChangeToolDefinition`

          A tool defined by value, as a `compaction` block's `tool_changes` entry
          reports it: `definition` is the tool's definition as it was sent, in the
          form of a `tools` entry, without `cache_control`. Send it back unchanged
          with the block.

          - `JsonValue type = "tool_definition"`

          - `BetaResponseToolUnion definition`

            - `class BetaResponseTool`

              A custom tool definition, as sent.

              - `Optional<Type> type`

              - `BetaResponseToolInputSchema 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> properties`

                - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolBash20241022`

              - `JsonValue type = "bash_20241022"`

              - `JsonValue name = "bash"`

                Name of the tool.

                This is how the tool will be called by the model and in `tool_use` blocks.

              - `Optional<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

                - `JsonValue type = "ephemeral"`

                - `Optional<Ttl> 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<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolBash20250124`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaCodeExecutionTool20250522`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaCodeExecutionTool20250825`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaCodeExecutionTool20260120`

              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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaCodeExecutionTool20260521`

              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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaBrowserToolset20260801`

              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<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

                  `type`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserCloseTabConfig> closeTab`

                  `close_tab`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

                  `double_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserFileUploadConfig> fileUpload`

                  `file_upload`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserFindConfig> find`

                  `find`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserFormInputConfig> formInput`

                  `form_input`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserGetPageTextConfig> getPageText`

                  `get_page_text`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserHoldKeyConfig> holdKey`

                  `hold_key`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserHoverConfig> hover`

                  `hover`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

                  `javascript_exec`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserKeyConfig> key`

                  `key`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserLeftClickConfig> leftClick`

                  `left_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

                  `left_click_drag`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

                  `left_mouse_down`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

                  `left_mouse_up`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserListTabsConfig> listTabs`

                  `list_tabs`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserMiddleClickConfig> middleClick`

                  `middle_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

                  `mouse_move`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserNavigateConfig> navigate`

                  `navigate`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserNewTabConfig> newTab`

                  `new_tab`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserReadConsoleConfig> readConsole`

                  `read_console`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

                  `read_network`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserReadPageConfig> readPage`

                  `read_page`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserRightClickConfig> rightClick`

                  `right_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserScreenshotConfig> screenshot`

                  `screenshot`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserScrollConfig> scroll`

                  `scroll`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserScrollToConfig> scrollTo`

                  `scroll_to`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserSwitchTabConfig> switchTab`

                  `switch_tab`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserTripleClickConfig> tripleClick`

                  `triple_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserWaitConfig> wait`

                  `wait`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserZoomConfig> zoom`

                  `zoom`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered 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 BetaToolComputerUse20241022`

              - `JsonValue type = "computer_20241022"`

              - `long displayHeightPx`

                The height of the display in pixels.

                minimum: 1

              - `long displayWidthPx`

                The width of the display in pixels.

                minimum: 1

              - `JsonValue name = "computer"`

                Name of the tool.

                This is how the tool will be called by the model and in `tool_use` blocks.

              - `Optional<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> displayNumber`

                The X11 display number (e.g. 0, 1) for the display.

                minimum: 0

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaMemoryTool20250818`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolComputerUse20250124`

              - `JsonValue type = "computer_20250124"`

              - `long displayHeightPx`

                The height of the display in pixels.

                minimum: 1

              - `long displayWidthPx`

                The width of the display in pixels.

                minimum: 1

              - `JsonValue name = "computer"`

                Name of the tool.

                This is how the tool will be called by the model and in `tool_use` blocks.

              - `Optional<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> displayNumber`

                The X11 display number (e.g. 0, 1) for the display.

                minimum: 0

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolTextEditor20241022`

              - `JsonValue type = "text_editor_20241022"`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolComputerUse20251124`

              - `JsonValue type = "computer_20251124"`

              - `long displayHeightPx`

                The height of the display in pixels.

                minimum: 1

              - `long displayWidthPx`

                The width of the display in pixels.

                minimum: 1

              - `JsonValue name = "computer"`

                Name of the tool.

                This is how the tool will be called by the model and in `tool_use` blocks.

              - `Optional<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> displayNumber`

                The X11 display number (e.g. 0, 1) for the display.

                minimum: 0

              - `Optional<Boolean> enableZoom`

                Whether to enable an action to take a zoomed-in screenshot of the screen.

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaComputerToolset20260801`

              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<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

                  `type`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

                  `cursor_position`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerDoubleClickConfig> doubleClick`

                  `double_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerHoldKeyConfig> holdKey`

                  `hold_key`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerKeyConfig> key`

                  `key`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerLeftClickConfig> leftClick`

                  `left_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

                  `left_click_drag`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

                  `left_mouse_down`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

                  `left_mouse_up`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerMiddleClickConfig> middleClick`

                  `middle_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerMouseMoveConfig> mouseMove`

                  `mouse_move`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerRightClickConfig> rightClick`

                  `right_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerScreenshotConfig> screenshot`

                  `screenshot`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerScrollConfig> scroll`

                  `scroll`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerTripleClickConfig> tripleClick`

                  `triple_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerWaitConfig> wait`

                  `wait`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerZoomConfig> zoom`

                  `zoom`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered 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 BetaToolTextEditor20250124`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolTextEditor20250429`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolTextEditor20250728`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Long> maxCharacters`

                Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

                minimum: 1

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaWebSearchTool20250305`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<List<String>> allowedDomains`

                If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

              - `Optional<List<String>> blockedDomains`

                If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> maxUses`

                Maximum number of times the tool can be used in the API request.

                minimum: 1

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

              - `Optional<BetaUserLocation> userLocation`

                Parameters for the user's location. Used to provide more relevant search results.

                - `JsonValue type = "approximate"`

                - `Optional<String> city`

                  The city of the user.

                  minLength: 1, maxLength: 255

                - `Optional<String> 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<String> region`

                  The region of the user.

                  minLength: 1, maxLength: 255

                - `Optional<String> timezone`

                  The [IANA timezone](https://nodatime.org/TimeZones) of the user.

                  minLength: 1, maxLength: 255

            - `class BetaWebFetchTool20250910`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<List<String>> allowedDomains`

                List of domains to allow fetching from

              - `Optional<List<String>> blockedDomains`

                List of domains to block fetching from

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaCitationsConfigParam> citations`

                Citations configuration for fetched documents. Citations are disabled by default.

                - `Optional<Boolean> enabled`

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> 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<Long> maxUses`

                Maximum number of times the tool can be used in the API request.

                minimum: 1

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

              - `Optional<BetaWebFetchUrlSources> urlSources`

                Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                - `Optional<ClientToolResults> clientToolResults`

                  Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

                  - `class BetaWebFetchUrlSourceAll`

                    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 BetaWebFetchUrlSourceNone`

                    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 BetaWebFetchUrlSourceOnly`

                    The tool filter variant under which only the named tools' results
                    contribute.

                    - `JsonValue type = "only"`

                    - `List<BetaWebFetchUrlSourceToolReference> tools`

                      - `JsonValue type = "tool_reference"`

                      - `String name`

                  - `class BetaWebFetchUrlSourceExcept`

                    The tool filter variant under which every result but the named
                    tools' contributes.

                    - `JsonValue type = "except"`

                    - `List<BetaWebFetchUrlSourceToolReference> tools`

                      - `JsonValue type = "tool_reference"`

                      - `String name`

                - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

                    The `url_sources` variant under which a source contributes in
                    full: every result of the tool filter's source, or all user input.

                  - `class BetaWebFetchUrlSourceNone`

                    The `url_sources` variant under which a source contributes nothing:
                    no result of the tool filter's source, or no user input.

                  - `class BetaWebFetchUrlSourceOnly`

                    The tool filter variant under which only the named tools' results
                    contribute.

                  - `class BetaWebFetchUrlSourceExcept`

                    The tool filter variant under which every result but the named
                    tools' contributes.

                - `Optional<UserInput> userInput`

                  Whether URLs in user messages are fetchable: "all" or "none".

                  - `class BetaWebFetchUrlSourceAll`

                    The `url_sources` variant under which a source contributes in
                    full: every result of the tool filter's source, or all user input.

                  - `class BetaWebFetchUrlSourceNone`

                    The `url_sources` variant under which a source contributes nothing:
                    no result of the tool filter's source, or no user input.

            - `class BetaWebSearchTool20260209`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<List<String>> allowedDomains`

                If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

              - `Optional<List<String>> blockedDomains`

                If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> maxUses`

                Maximum number of times the tool can be used in the API request.

                minimum: 1

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

              - `Optional<BetaUserLocation> userLocation`

                Parameters for the user's location. Used to provide more relevant search results.

            - `class BetaWebFetchTool20260209`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<List<String>> allowedDomains`

                List of domains to allow fetching from

              - `Optional<List<String>> blockedDomains`

                List of domains to block fetching from

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaCitationsConfigParam> citations`

                Citations configuration for fetched documents. Citations are disabled by default.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> 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<Long> maxUses`

                Maximum number of times the tool can be used in the API request.

                minimum: 1

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

              - `Optional<BetaWebFetchUrlSources> urlSources`

                Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

            - `class BetaWebFetchTool20260309`

              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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<List<String>> allowedDomains`

                List of domains to allow fetching from

              - `Optional<List<String>> blockedDomains`

                List of domains to block fetching from

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaCitationsConfigParam> citations`

                Citations configuration for fetched documents. Citations are disabled by default.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> 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<Long> maxUses`

                Maximum number of times the tool can be used in the API request.

                minimum: 1

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

              - `Optional<BetaWebFetchUrlSources> urlSources`

                Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

              - `Optional<Boolean> 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 BetaWebSearchTool20260318`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<List<String>> allowedDomains`

                If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

              - `Optional<List<String>> blockedDomains`

                If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> maxUses`

                Maximum number of times the tool can be used in the API request.

                minimum: 1

              - `Optional<ResponseInclusion> 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<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

              - `Optional<BetaUserLocation> userLocation`

                Parameters for the user's location. Used to provide more relevant search results.

            - `class BetaWebFetchTool20260318`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<List<String>> allowedDomains`

                List of domains to allow fetching from

              - `Optional<List<String>> blockedDomains`

                List of domains to block fetching from

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaCitationsConfigParam> citations`

                Citations configuration for fetched documents. Citations are disabled by default.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> 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<Long> maxUses`

                Maximum number of times the tool can be used in the API request.

                minimum: 1

              - `Optional<ResponseInclusion> 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<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

              - `Optional<BetaWebFetchUrlSources> urlSources`

                Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

              - `Optional<Boolean> 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 BetaAdvisorTool20260301`

              - `JsonValue type = "advisor_20260301"`

              - `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 name = "advisor"`

                Name of the tool.

                This is how the tool will be called by the model and in `tool_use` blocks.

              - `Optional<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaCacheControlEphemeral> caching`

                Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> maxTokens`

                Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

                minimum: 1024

              - `Optional<Long> maxUses`

                Maximum number of times the tool can be used in the API request.

                minimum: 1

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolSearchToolRegex20251119`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaMcpToolset`

              Configuration for a group of tools from an MCP server.

              Allows configuring enabled status and defer_loading for all tools
              from an MCP server, with optional per-tool overrides.

              - `JsonValue type = "mcp_toolset"`

              - `String mcpServerName`

                Name of the MCP server to configure tools for

                minLength: 1, maxLength: 255

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Configs> configs`

                Configuration overrides for specific tools, keyed by tool name

                - `Optional<Boolean> deferLoading`

                - `Optional<Boolean> enabled`

              - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

                Default configuration applied to all tools from this server

                - `Optional<Boolean> deferLoading`

                - `Optional<Boolean> enabled`

              - `Optional<List<BetaMcpToolParam>> tools`

                The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

                - `InputSchema inputSchema`

                  The tool's input schema as the MCP server lists it, verbatim.

                - `String name`

                  The tool's name as the MCP server lists it (not prefixed with the server name).

                  minLength: 1

                - `Optional<String> description`

                  The tool's description as the MCP server lists it.

    - `class BetaResponseToolRemovalBlock`

      An entry of a `compaction` block's `tool_changes`: a tool of the
      request's `tools` (or an MCP tool or toolset) that the compacted range
      withdrew. Send it back unchanged.

      - `JsonValue type = "tool_removal"`

      - `Tool tool`

        A reference to the withdrawn `tools` entry, MCP tool or MCP toolset.

        - `class BetaResponseToolChangeToolReference`

          Reference to a single tool, by the name the model uses to call it, as
          a `compaction` block's `tool_changes` entry reports it: a tool
          declared in `tools` or defined by an earlier `tool_addition` block.
          Send it back unchanged with the block.

        - `class BetaResponseToolChangeMcpToolReference`

          Reference to a single MCP tool, by its server and its name on that
          server, as a `compaction` block's `tool_changes` entry reports it.
          Send it back unchanged with the block.

        - `class BetaResponseToolChangeMcpToolsetReference`

          Reference to every tool in the named MCP server's toolset, as a
          `compaction` block's `tool_changes` entry reports it. Send it back
          unchanged with the block.

### Beta Compaction Block Param

- `class BetaCompactionBlockParam`

  A compaction block containing summary of previous context.

  Users should round-trip these blocks from responses to subsequent requests
  to maintain context across compaction boundaries.

  When content is None, the block represents a failed compaction. The server
  treats these as no-ops. Empty string content is not allowed.

  - `JsonValue type = "compaction"`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<String> content`

    Summary of previously compacted content, or null if compaction failed

  - `Optional<String> encryptedContent`

    Opaque metadata from prior compaction, to be round-tripped verbatim

  - `Optional<String> signature`

    The block's signature as returned, to be sent back verbatim

  - `Optional<List<ToolChange>> toolChanges`

    The tool changes of the compacted range, as the server returned them on this block: the `tool_addition` and `tool_removal` entries that take the request's `tools` to the tool set in effect at the end of the range. Send them back unchanged with the block.

    - `class BetaRequestToolAdditionBlock`

      Mid-conversation directive to make a tool available.

      `tool` is a reference to a tool (or MCP toolset) declared in the
      request's `tools`. Under the `inline-tools-2026-09-15` beta it may
      instead be a reference to a tool defined earlier in `messages`, or a
      `tool_definition` object that carries an inline tool definition in
      `definition` (the same object a `tools` entry holds). An `mcp_toolset`
      definition also requires the `mcp-client-2026-09-15` beta. The tool is
      offered to the model from this point in the conversation onward.

      - `JsonValue type = "tool_addition"`

      - `Tool tool`

        - `class BetaToolChangeToolReference`

          Reference to a single tool, by the name the model uses to call it: a
          tool declared in `tools` or defined by an earlier `tool_addition`
          block. Does not accept the composed `{server}_{name}` form the server
          assigns to MCP-resolved tools; use `mcp_tool_reference` or
          `mcp_toolset_reference` for those.

          - `JsonValue type = "tool_reference"`

          - `String name`

            pattern: ^[a-zA-Z0-9_-]{1,128}$

        - `class BetaToolChangeMcpToolReference`

          Reference to a single MCP tool by its server and remote name; the
          same `server_name`/`name` pair `mcp_tool_use` carries.

          - `JsonValue type = "mcp_tool_reference"`

          - `String name`

          - `String serverName`

        - `class BetaToolChangeMcpToolsetReference`

          Reference to every tool in the named MCP server's toolset.

          - `JsonValue type = "mcp_toolset_reference"`

          - `String serverName`

        - `class BetaToolChangeToolDefinitionParam`

          A tool defined by value: `definition` is a `tools` entry (any kind
          `tools` accepts, an MCP toolset included). An `mcp_toolset` given here
          also requires the `mcp-client-2026-09-15` beta.

          - `JsonValue type = "tool_definition"`

          - `BetaToolUnion definition`

            - `class BetaTool`

              - `Optional<Type> 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> properties`

                - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolBash20241022`

              - `JsonValue type = "bash_20241022"`

              - `JsonValue name = "bash"`

                Name of the tool.

                This is how the tool will be called by the model and in `tool_use` blocks.

              - `Optional<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolBash20250124`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaCodeExecutionTool20250522`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaCodeExecutionTool20250825`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaCodeExecutionTool20260120`

              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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaCodeExecutionTool20260521`

              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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaBrowserToolset20260801`

              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<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

                  `type`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserCloseTabConfig> closeTab`

                  `close_tab`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

                  `double_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserFileUploadConfig> fileUpload`

                  `file_upload`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserFindConfig> find`

                  `find`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserFormInputConfig> formInput`

                  `form_input`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserGetPageTextConfig> getPageText`

                  `get_page_text`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserHoldKeyConfig> holdKey`

                  `hold_key`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserHoverConfig> hover`

                  `hover`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

                  `javascript_exec`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserKeyConfig> key`

                  `key`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserLeftClickConfig> leftClick`

                  `left_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

                  `left_click_drag`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

                  `left_mouse_down`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

                  `left_mouse_up`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserListTabsConfig> listTabs`

                  `list_tabs`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserMiddleClickConfig> middleClick`

                  `middle_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

                  `mouse_move`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserNavigateConfig> navigate`

                  `navigate`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserNewTabConfig> newTab`

                  `new_tab`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserReadConsoleConfig> readConsole`

                  `read_console`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

                  `read_network`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserReadPageConfig> readPage`

                  `read_page`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserRightClickConfig> rightClick`

                  `right_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserScreenshotConfig> screenshot`

                  `screenshot`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserScrollConfig> scroll`

                  `scroll`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserScrollToConfig> scrollTo`

                  `scroll_to`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserSwitchTabConfig> switchTab`

                  `switch_tab`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserTripleClickConfig> tripleClick`

                  `triple_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserWaitConfig> wait`

                  `wait`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaBrowserZoomConfig> zoom`

                  `zoom`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered 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 BetaToolComputerUse20241022`

              - `JsonValue type = "computer_20241022"`

              - `long displayHeightPx`

                The height of the display in pixels.

                minimum: 1

              - `long displayWidthPx`

                The width of the display in pixels.

                minimum: 1

              - `JsonValue name = "computer"`

                Name of the tool.

                This is how the tool will be called by the model and in `tool_use` blocks.

              - `Optional<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> displayNumber`

                The X11 display number (e.g. 0, 1) for the display.

                minimum: 0

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaMemoryTool20250818`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolComputerUse20250124`

              - `JsonValue type = "computer_20250124"`

              - `long displayHeightPx`

                The height of the display in pixels.

                minimum: 1

              - `long displayWidthPx`

                The width of the display in pixels.

                minimum: 1

              - `JsonValue name = "computer"`

                Name of the tool.

                This is how the tool will be called by the model and in `tool_use` blocks.

              - `Optional<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> displayNumber`

                The X11 display number (e.g. 0, 1) for the display.

                minimum: 0

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolTextEditor20241022`

              - `JsonValue type = "text_editor_20241022"`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolComputerUse20251124`

              - `JsonValue type = "computer_20251124"`

              - `long displayHeightPx`

                The height of the display in pixels.

                minimum: 1

              - `long displayWidthPx`

                The width of the display in pixels.

                minimum: 1

              - `JsonValue name = "computer"`

                Name of the tool.

                This is how the tool will be called by the model and in `tool_use` blocks.

              - `Optional<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> displayNumber`

                The X11 display number (e.g. 0, 1) for the display.

                minimum: 0

              - `Optional<Boolean> enableZoom`

                Whether to enable an action to take a zoomed-in screenshot of the screen.

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaComputerToolset20260801`

              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<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

                  `type`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

                  `cursor_position`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerDoubleClickConfig> doubleClick`

                  `double_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerHoldKeyConfig> holdKey`

                  `hold_key`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerKeyConfig> key`

                  `key`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerLeftClickConfig> leftClick`

                  `left_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

                  `left_click_drag`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

                  `left_mouse_down`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

                  `left_mouse_up`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerMiddleClickConfig> middleClick`

                  `middle_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerMouseMoveConfig> mouseMove`

                  `mouse_move`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerRightClickConfig> rightClick`

                  `right_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerScreenshotConfig> screenshot`

                  `screenshot`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerScrollConfig> scroll`

                  `scroll`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerTripleClickConfig> tripleClick`

                  `triple_click`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerWaitConfig> wait`

                  `wait`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                - `Optional<BetaComputerZoomConfig> zoom`

                  `zoom`'s config overrides.

                  - `Optional<Boolean> deferLoading`

                    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                  - `Optional<Boolean> enabled`

                    Whether this member is offered 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 BetaToolTextEditor20250124`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolTextEditor20250429`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolTextEditor20250728`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<List<InputExample>> inputExamples`

              - `Optional<Long> maxCharacters`

                Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

                minimum: 1

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaWebSearchTool20250305`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<List<String>> allowedDomains`

                If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

              - `Optional<List<String>> blockedDomains`

                If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> maxUses`

                Maximum number of times the tool can be used in the API request.

                minimum: 1

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

              - `Optional<BetaUserLocation> userLocation`

                Parameters for the user's location. Used to provide more relevant search results.

                - `JsonValue type = "approximate"`

                - `Optional<String> city`

                  The city of the user.

                  minLength: 1, maxLength: 255

                - `Optional<String> 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<String> region`

                  The region of the user.

                  minLength: 1, maxLength: 255

                - `Optional<String> timezone`

                  The [IANA timezone](https://nodatime.org/TimeZones) of the user.

                  minLength: 1, maxLength: 255

            - `class BetaWebFetchTool20250910`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<List<String>> allowedDomains`

                List of domains to allow fetching from

              - `Optional<List<String>> blockedDomains`

                List of domains to block fetching from

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaCitationsConfigParam> citations`

                Citations configuration for fetched documents. Citations are disabled by default.

                - `Optional<Boolean> enabled`

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> 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<Long> maxUses`

                Maximum number of times the tool can be used in the API request.

                minimum: 1

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

              - `Optional<BetaWebFetchUrlSources> urlSources`

                Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                - `Optional<ClientToolResults> clientToolResults`

                  Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

                  - `class BetaWebFetchUrlSourceAll`

                    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 BetaWebFetchUrlSourceNone`

                    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 BetaWebFetchUrlSourceOnly`

                    The tool filter variant under which only the named tools' results
                    contribute.

                    - `JsonValue type = "only"`

                    - `List<BetaWebFetchUrlSourceToolReference> tools`

                      - `JsonValue type = "tool_reference"`

                      - `String name`

                  - `class BetaWebFetchUrlSourceExcept`

                    The tool filter variant under which every result but the named
                    tools' contributes.

                    - `JsonValue type = "except"`

                    - `List<BetaWebFetchUrlSourceToolReference> tools`

                      - `JsonValue type = "tool_reference"`

                      - `String name`

                - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

                    The `url_sources` variant under which a source contributes in
                    full: every result of the tool filter's source, or all user input.

                  - `class BetaWebFetchUrlSourceNone`

                    The `url_sources` variant under which a source contributes nothing:
                    no result of the tool filter's source, or no user input.

                  - `class BetaWebFetchUrlSourceOnly`

                    The tool filter variant under which only the named tools' results
                    contribute.

                  - `class BetaWebFetchUrlSourceExcept`

                    The tool filter variant under which every result but the named
                    tools' contributes.

                - `Optional<UserInput> userInput`

                  Whether URLs in user messages are fetchable: "all" or "none".

                  - `class BetaWebFetchUrlSourceAll`

                    The `url_sources` variant under which a source contributes in
                    full: every result of the tool filter's source, or all user input.

                  - `class BetaWebFetchUrlSourceNone`

                    The `url_sources` variant under which a source contributes nothing:
                    no result of the tool filter's source, or no user input.

            - `class BetaWebSearchTool20260209`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<List<String>> allowedDomains`

                If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

              - `Optional<List<String>> blockedDomains`

                If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> maxUses`

                Maximum number of times the tool can be used in the API request.

                minimum: 1

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

              - `Optional<BetaUserLocation> userLocation`

                Parameters for the user's location. Used to provide more relevant search results.

            - `class BetaWebFetchTool20260209`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<List<String>> allowedDomains`

                List of domains to allow fetching from

              - `Optional<List<String>> blockedDomains`

                List of domains to block fetching from

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaCitationsConfigParam> citations`

                Citations configuration for fetched documents. Citations are disabled by default.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> 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<Long> maxUses`

                Maximum number of times the tool can be used in the API request.

                minimum: 1

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

              - `Optional<BetaWebFetchUrlSources> urlSources`

                Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

            - `class BetaWebFetchTool20260309`

              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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<List<String>> allowedDomains`

                List of domains to allow fetching from

              - `Optional<List<String>> blockedDomains`

                List of domains to block fetching from

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaCitationsConfigParam> citations`

                Citations configuration for fetched documents. Citations are disabled by default.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> 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<Long> maxUses`

                Maximum number of times the tool can be used in the API request.

                minimum: 1

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

              - `Optional<BetaWebFetchUrlSources> urlSources`

                Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

              - `Optional<Boolean> 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 BetaWebSearchTool20260318`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<List<String>> allowedDomains`

                If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

              - `Optional<List<String>> blockedDomains`

                If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> maxUses`

                Maximum number of times the tool can be used in the API request.

                minimum: 1

              - `Optional<ResponseInclusion> 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<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

              - `Optional<BetaUserLocation> userLocation`

                Parameters for the user's location. Used to provide more relevant search results.

            - `class BetaWebFetchTool20260318`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<List<String>> allowedDomains`

                List of domains to allow fetching from

              - `Optional<List<String>> blockedDomains`

                List of domains to block fetching from

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaCitationsConfigParam> citations`

                Citations configuration for fetched documents. Citations are disabled by default.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> 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<Long> maxUses`

                Maximum number of times the tool can be used in the API request.

                minimum: 1

              - `Optional<ResponseInclusion> 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<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

              - `Optional<BetaWebFetchUrlSources> urlSources`

                Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

              - `Optional<Boolean> 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 BetaAdvisorTool20260301`

              - `JsonValue type = "advisor_20260301"`

              - `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 name = "advisor"`

                Name of the tool.

                This is how the tool will be called by the model and in `tool_use` blocks.

              - `Optional<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaCacheControlEphemeral> caching`

                Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Long> maxTokens`

                Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

                minimum: 1024

              - `Optional<Long> maxUses`

                Maximum number of times the tool can be used in the API request.

                minimum: 1

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaToolSearchToolRegex20251119`

              - `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<List<AllowedCaller>> allowedCallers`

                - `DIRECT("direct")`

                - `CODE_EXECUTION_20250825("code_execution_20250825")`

                - `CODE_EXECUTION_20260120("code_execution_20260120")`

                - `CODE_EXECUTION_20260521("code_execution_20260521")`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Boolean> deferLoading`

                If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

              - `Optional<Boolean> strict`

                When true, guarantees schema validation on tool names and inputs

            - `class BetaMcpToolset`

              Configuration for a group of tools from an MCP server.

              Allows configuring enabled status and defer_loading for all tools
              from an MCP server, with optional per-tool overrides.

              - `JsonValue type = "mcp_toolset"`

              - `String mcpServerName`

                Name of the MCP server to configure tools for

                minLength: 1, maxLength: 255

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Configs> configs`

                Configuration overrides for specific tools, keyed by tool name

                - `Optional<Boolean> deferLoading`

                - `Optional<Boolean> enabled`

              - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

                Default configuration applied to all tools from this server

                - `Optional<Boolean> deferLoading`

                - `Optional<Boolean> enabled`

              - `Optional<List<BetaMcpToolParam>> tools`

                The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

                - `InputSchema inputSchema`

                  The tool's input schema as the MCP server lists it, verbatim.

                - `String name`

                  The tool's name as the MCP server lists it (not prefixed with the server name).

                  minLength: 1

                - `Optional<String> description`

                  The tool's description as the MCP server lists it.

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

    - `class BetaRequestToolRemovalBlock`

      Mid-conversation directive to withdraw a tool.

      `tool` references a tool (or MCP toolset) by name: one declared in the
      request's `tools` or defined earlier in `messages`. It is no longer
      offered to the model from this point in the conversation onward.

      - `JsonValue type = "tool_removal"`

      - `Tool tool`

        - `class BetaToolChangeToolReference`

          Reference to a single tool, by the name the model uses to call it: a
          tool declared in `tools` or defined by an earlier `tool_addition`
          block. Does not accept the composed `{server}_{name}` form the server
          assigns to MCP-resolved tools; use `mcp_tool_reference` or
          `mcp_toolset_reference` for those.

        - `class BetaToolChangeMcpToolReference`

          Reference to a single MCP tool by its server and remote name; the
          same `server_name`/`name` pair `mcp_tool_use` carries.

        - `class BetaToolChangeMcpToolsetReference`

          Reference to every tool in the named MCP server's toolset.

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

### Beta Compaction Config

- `class BetaCompactionConfig`

  Compact the whole conversation and return a signed `compaction` block,
  alone, that a later request sends back first in `messages`, in place of
  the messages it summarizes. There is no trigger and no pause flag: sending
  the parameter compacts, and nothing is sampled after the block.

  The summarization prompt is the server's own unless `instructions` are
  given, which then replace it for this request; a value that is empty or
  only whitespace counts as absent.

  - `JsonValue type = "summarize"`

  - `Optional<String> instructions`

    Replaces the server's default summarization prompt for this request. An empty or whitespace-only value counts as absent.

    maxLength: 16384

### Beta Compaction Content Block Delta

- `class BetaCompactionContentBlockDelta`

  - `JsonValue type = "compaction_delta"`

  - `Optional<String> content`

  - `Optional<String> encryptedContent`

    Opaque metadata from prior compaction, to be round-tripped verbatim

### Beta Compaction Iteration Usage

- `class BetaCompactionIterationUsage`

  Token usage for a compaction iteration.

  - `JsonValue type = "compaction"`

    Usage for a compaction iteration

  - `Optional<BetaCacheCreation> 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

  - `long cacheCreationInputTokens`

    The number of input tokens used to create the cache entry.

    minimum: 0

  - `long cacheReadInputTokens`

    The number of input tokens read from the cache.

    minimum: 0

  - `long inputTokens`

    The number of input tokens which were used.

    minimum: 0

  - `long outputTokens`

    The number of output tokens which were used.

    minimum: 0

### Beta Computer Cursor Position Config

- `class BetaComputerCursorPositionConfig`

  `cursor_position`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Cursor Position Input

- `class BetaComputerCursorPositionInput:`

  Get the current (x, y) pixel coordinate of the cursor.

### Beta Computer Cursor Position Tool Use Block

- `class BetaComputerCursorPositionToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerCursorPositionInput input`

    Get the current (x, y) pixel coordinate of the cursor.

  - `JsonValue name = "cursor_position"`

  - `JsonValue toolsetName = "computer"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Computer Double Click Config

- `class BetaComputerDoubleClickConfig`

  `double_click`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Double Click Input

- `class BetaComputerDoubleClickInput`

  Double-click the left mouse button at the specified (x, y) pixel coordinate, or
  the current cursor position if `coordinate` is omitted.

  - `Optional<List<Long>> coordinate`

    (x, y): x pixels from the left edge, y pixels from the top edge.

    minItems: 2, maxItems: 2

  - `Optional<String> text`

    Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

### Beta Computer Double Click Tool Use Block

- `class BetaComputerDoubleClickToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerDoubleClickInput input`

    Double-click the left mouse button at the specified (x, y) pixel coordinate, or
    the current cursor position if `coordinate` is omitted.

    - `Optional<List<Long>> coordinate`

      (x, y): x pixels from the left edge, y pixels from the top edge.

      minItems: 2, maxItems: 2

    - `Optional<String> text`

      Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

  - `JsonValue name = "double_click"`

  - `JsonValue toolsetName = "computer"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Computer Hold Key Config

- `class BetaComputerHoldKeyConfig`

  `hold_key`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Hold Key Input

- `class BetaComputerHoldKeyInput`

  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.

### Beta Computer Hold Key Tool Use Block

- `class BetaComputerHoldKeyToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerHoldKeyInput 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"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Computer Key Config

- `class BetaComputerKeyConfig`

  `key`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Key Input

- `class BetaComputerKeyInput`

  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<Long> repeat`

    Number of times to repeat the key press. Default is 1.

    minimum: 1, maximum: 100

### Beta Computer Key Tool Use Block

- `class BetaComputerKeyToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerKeyInput 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<Long> repeat`

      Number of times to repeat the key press. Default is 1.

      minimum: 1, maximum: 100

  - `JsonValue name = "key"`

  - `JsonValue toolsetName = "computer"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Computer Left Click Config

- `class BetaComputerLeftClickConfig`

  `left_click`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Left Click Drag Config

- `class BetaComputerLeftClickDragConfig`

  `left_click_drag`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Left Click Drag Input

- `class BetaComputerLeftClickDragInput`

  Click and drag the cursor from `start_coordinate` to `coordinate`.

  - `List<long> coordinate`

    (x, y): x pixels from the left edge, y pixels from the top edge.

    minItems: 2, maxItems: 2

  - `List<long> startCoordinate`

    (x, y): x pixels from the left edge, y pixels from the top edge.

    minItems: 2, maxItems: 2

  - `Optional<String> text`

    Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

### Beta Computer Left Click Drag Tool Use Block

- `class BetaComputerLeftClickDragToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerLeftClickDragInput input`

    Click and drag the cursor from `start_coordinate` to `coordinate`.

    - `List<long> coordinate`

      (x, y): x pixels from the left edge, y pixels from the top edge.

      minItems: 2, maxItems: 2

    - `List<long> startCoordinate`

      (x, y): x pixels from the left edge, y pixels from the top edge.

      minItems: 2, maxItems: 2

    - `Optional<String> text`

      Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

  - `JsonValue name = "left_click_drag"`

  - `JsonValue toolsetName = "computer"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Computer Left Click Input

- `class BetaComputerLeftClickInput`

  Click the left mouse button at the specified (x, y) pixel coordinate, or the
  current cursor position if `coordinate` is omitted.

  - `Optional<List<Long>> coordinate`

    (x, y): x pixels from the left edge, y pixels from the top edge.

    minItems: 2, maxItems: 2

  - `Optional<String> text`

    Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

### Beta Computer Left Click Tool Use Block

- `class BetaComputerLeftClickToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerLeftClickInput input`

    Click the left mouse button at the specified (x, y) pixel coordinate, or the
    current cursor position if `coordinate` is omitted.

    - `Optional<List<Long>> coordinate`

      (x, y): x pixels from the left edge, y pixels from the top edge.

      minItems: 2, maxItems: 2

    - `Optional<String> text`

      Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

  - `JsonValue name = "left_click"`

  - `JsonValue toolsetName = "computer"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Computer Left Mouse Down Config

- `class BetaComputerLeftMouseDownConfig`

  `left_mouse_down`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Left Mouse Down Input

- `class BetaComputerLeftMouseDownInput:`

  Press and hold the left mouse button at the current cursor position.

### Beta Computer Left Mouse Down Tool Use Block

- `class BetaComputerLeftMouseDownToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerLeftMouseDownInput input`

    Press and hold the left mouse button at the current cursor position.

  - `JsonValue name = "left_mouse_down"`

  - `JsonValue toolsetName = "computer"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Computer Left Mouse Up Config

- `class BetaComputerLeftMouseUpConfig`

  `left_mouse_up`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Left Mouse Up Input

- `class BetaComputerLeftMouseUpInput:`

  Release the left mouse button.

### Beta Computer Left Mouse Up Tool Use Block

- `class BetaComputerLeftMouseUpToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerLeftMouseUpInput input`

    Release the left mouse button.

  - `JsonValue name = "left_mouse_up"`

  - `JsonValue toolsetName = "computer"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Computer Middle Click Config

- `class BetaComputerMiddleClickConfig`

  `middle_click`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Middle Click Input

- `class BetaComputerMiddleClickInput`

  Click the middle mouse button at the specified (x, y) pixel coordinate, or the
  current cursor position if `coordinate` is omitted.

  - `Optional<List<Long>> coordinate`

    (x, y): x pixels from the left edge, y pixels from the top edge.

    minItems: 2, maxItems: 2

  - `Optional<String> text`

    Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

### Beta Computer Middle Click Tool Use Block

- `class BetaComputerMiddleClickToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerMiddleClickInput input`

    Click the middle mouse button at the specified (x, y) pixel coordinate, or the
    current cursor position if `coordinate` is omitted.

    - `Optional<List<Long>> coordinate`

      (x, y): x pixels from the left edge, y pixels from the top edge.

      minItems: 2, maxItems: 2

    - `Optional<String> text`

      Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

  - `JsonValue name = "middle_click"`

  - `JsonValue toolsetName = "computer"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Computer Mouse Move Config

- `class BetaComputerMouseMoveConfig`

  `mouse_move`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Mouse Move Input

- `class BetaComputerMouseMoveInput`

  Move the cursor to a specified (x, y) pixel coordinate. Use this ONLY to hover
  without clicking; otherwise use a click action directly.

  - `List<long> coordinate`

    (x, y): x pixels from the left edge, y pixels from the top edge.

    minItems: 2, maxItems: 2

### Beta Computer Mouse Move Tool Use Block

- `class BetaComputerMouseMoveToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerMouseMoveInput 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<long> 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"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Computer Right Click Config

- `class BetaComputerRightClickConfig`

  `right_click`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Right Click Input

- `class BetaComputerRightClickInput`

  Click the right mouse button at the specified (x, y) pixel coordinate, or the
  current cursor position if `coordinate` is omitted.

  - `Optional<List<Long>> coordinate`

    (x, y): x pixels from the left edge, y pixels from the top edge.

    minItems: 2, maxItems: 2

  - `Optional<String> text`

    Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

### Beta Computer Right Click Tool Use Block

- `class BetaComputerRightClickToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerRightClickInput input`

    Click the right mouse button at the specified (x, y) pixel coordinate, or the
    current cursor position if `coordinate` is omitted.

    - `Optional<List<Long>> coordinate`

      (x, y): x pixels from the left edge, y pixels from the top edge.

      minItems: 2, maxItems: 2

    - `Optional<String> text`

      Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

  - `JsonValue name = "right_click"`

  - `JsonValue toolsetName = "computer"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Computer Screenshot Config

- `class BetaComputerScreenshotConfig`

  `screenshot`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Screenshot Input

- `class BetaComputerScreenshotInput:`

  Take a screenshot of the screen.

### Beta Computer Screenshot Tool Use Block

- `class BetaComputerScreenshotToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerScreenshotInput input`

    Take a screenshot of the screen.

  - `JsonValue name = "screenshot"`

  - `JsonValue toolsetName = "computer"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Computer Scroll Config

- `class BetaComputerScrollConfig`

  `scroll`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Scroll Direction

- `enum BetaComputerScrollDirection`

  - `UP("up")`

  - `DOWN("down")`

  - `LEFT("left")`

  - `RIGHT("right")`

### Beta Computer Scroll Input

- `class BetaComputerScrollInput`

  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.

  - `BetaComputerScrollDirection scrollDirection`

    - `UP("up")`

    - `DOWN("down")`

    - `LEFT("left")`

    - `RIGHT("right")`

  - `Optional<List<Long>> coordinate`

    (x, y): x pixels from the left edge, y pixels from the top edge.

    minItems: 2, maxItems: 2

  - `Optional<String> text`

    Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

### Beta Computer Scroll Tool Use Block

- `class BetaComputerScrollToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerScrollInput 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.

    - `BetaComputerScrollDirection scrollDirection`

      - `UP("up")`

      - `DOWN("down")`

      - `LEFT("left")`

      - `RIGHT("right")`

    - `Optional<List<Long>> coordinate`

      (x, y): x pixels from the left edge, y pixels from the top edge.

      minItems: 2, maxItems: 2

    - `Optional<String> text`

      Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

  - `JsonValue name = "scroll"`

  - `JsonValue toolsetName = "computer"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Computer Tool Use Block

- `class BetaComputerToolUseBlock: union`

  - `class BetaComputerKeyToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerKeyInput 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<Long> repeat`

        Number of times to repeat the key press. Default is 1.

        minimum: 1, maximum: 100

    - `JsonValue name = "key"`

    - `JsonValue toolsetName = "computer"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

      - `class BetaDirectCaller`

        Tool invocation directly from the model.

        - `JsonValue type = "direct"`

      - `class BetaServerToolCaller`

        Tool invocation generated by a server-side tool.

        - `JsonValue type = "code_execution_20250825"`

        - `String toolId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `class BetaServerToolCaller20260120`

        - `JsonValue type = "code_execution_20260120"`

        - `String toolId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `class BetaComputerHoldKeyToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerHoldKeyInput 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"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaComputerTypeToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerTypeInput input`

      Type a string of text on the keyboard.

      - `String text`

        The text to type.

    - `JsonValue name = "type"`

    - `JsonValue toolsetName = "computer"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaComputerCursorPositionToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerCursorPositionInput input`

      Get the current (x, y) pixel coordinate of the cursor.

    - `JsonValue name = "cursor_position"`

    - `JsonValue toolsetName = "computer"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaComputerMouseMoveToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerMouseMoveInput 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<long> 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"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaComputerLeftMouseDownToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerLeftMouseDownInput input`

      Press and hold the left mouse button at the current cursor position.

    - `JsonValue name = "left_mouse_down"`

    - `JsonValue toolsetName = "computer"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaComputerLeftMouseUpToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerLeftMouseUpInput input`

      Release the left mouse button.

    - `JsonValue name = "left_mouse_up"`

    - `JsonValue toolsetName = "computer"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaComputerLeftClickToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerLeftClickInput input`

      Click the left mouse button at the specified (x, y) pixel coordinate, or the
      current cursor position if `coordinate` is omitted.

      - `Optional<List<Long>> coordinate`

        (x, y): x pixels from the left edge, y pixels from the top edge.

        minItems: 2, maxItems: 2

      - `Optional<String> text`

        Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

    - `JsonValue name = "left_click"`

    - `JsonValue toolsetName = "computer"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaComputerLeftClickDragToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerLeftClickDragInput input`

      Click and drag the cursor from `start_coordinate` to `coordinate`.

      - `List<long> coordinate`

        (x, y): x pixels from the left edge, y pixels from the top edge.

        minItems: 2, maxItems: 2

      - `List<long> startCoordinate`

        (x, y): x pixels from the left edge, y pixels from the top edge.

        minItems: 2, maxItems: 2

      - `Optional<String> text`

        Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

    - `JsonValue name = "left_click_drag"`

    - `JsonValue toolsetName = "computer"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaComputerRightClickToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerRightClickInput input`

      Click the right mouse button at the specified (x, y) pixel coordinate, or the
      current cursor position if `coordinate` is omitted.

      - `Optional<List<Long>> coordinate`

        (x, y): x pixels from the left edge, y pixels from the top edge.

        minItems: 2, maxItems: 2

      - `Optional<String> text`

        Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

    - `JsonValue name = "right_click"`

    - `JsonValue toolsetName = "computer"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaComputerMiddleClickToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerMiddleClickInput input`

      Click the middle mouse button at the specified (x, y) pixel coordinate, or the
      current cursor position if `coordinate` is omitted.

      - `Optional<List<Long>> coordinate`

        (x, y): x pixels from the left edge, y pixels from the top edge.

        minItems: 2, maxItems: 2

      - `Optional<String> text`

        Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

    - `JsonValue name = "middle_click"`

    - `JsonValue toolsetName = "computer"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaComputerDoubleClickToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerDoubleClickInput input`

      Double-click the left mouse button at the specified (x, y) pixel coordinate, or
      the current cursor position if `coordinate` is omitted.

      - `Optional<List<Long>> coordinate`

        (x, y): x pixels from the left edge, y pixels from the top edge.

        minItems: 2, maxItems: 2

      - `Optional<String> text`

        Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

    - `JsonValue name = "double_click"`

    - `JsonValue toolsetName = "computer"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaComputerTripleClickToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerTripleClickInput input`

      Triple-click the left mouse button at the specified (x, y) pixel coordinate, or
      the current cursor position if `coordinate` is omitted.

      - `Optional<List<Long>> coordinate`

        (x, y): x pixels from the left edge, y pixels from the top edge.

        minItems: 2, maxItems: 2

      - `Optional<String> text`

        Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

    - `JsonValue name = "triple_click"`

    - `JsonValue toolsetName = "computer"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaComputerScrollToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerScrollInput 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.

      - `BetaComputerScrollDirection scrollDirection`

        - `UP("up")`

        - `DOWN("down")`

        - `LEFT("left")`

        - `RIGHT("right")`

      - `Optional<List<Long>> coordinate`

        (x, y): x pixels from the left edge, y pixels from the top edge.

        minItems: 2, maxItems: 2

      - `Optional<String> text`

        Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

    - `JsonValue name = "scroll"`

    - `JsonValue toolsetName = "computer"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaComputerWaitToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerWaitInput input`

      Wait for a specified duration.

      - `long duration`

        Duration to wait, in seconds.

        maximum: 300

    - `JsonValue name = "wait"`

    - `JsonValue toolsetName = "computer"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaComputerScreenshotToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerScreenshotInput input`

      Take a screenshot of the screen.

    - `JsonValue name = "screenshot"`

    - `JsonValue toolsetName = "computer"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaComputerZoomToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `BetaComputerZoomInput 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<long> region`

        (x0, y0, x1, y1): The region to capture.

        minItems: 4, maxItems: 4

    - `JsonValue name = "zoom"`

    - `JsonValue toolsetName = "computer"`

    - `Optional<BetaToolUseCaller> caller`

      Which party invoked the tool call: the model directly, or a server tool on its behalf.

### Beta Computer Toolset 20260801

- `class BetaComputerToolset20260801`

  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<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

      `type`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

      `cursor_position`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaComputerDoubleClickConfig> doubleClick`

      `double_click`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaComputerHoldKeyConfig> holdKey`

      `hold_key`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaComputerKeyConfig> key`

      `key`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaComputerLeftClickConfig> leftClick`

      `left_click`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

      `left_click_drag`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

      `left_mouse_down`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

      `left_mouse_up`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaComputerMiddleClickConfig> middleClick`

      `middle_click`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaComputerMouseMoveConfig> mouseMove`

      `mouse_move`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaComputerRightClickConfig> rightClick`

      `right_click`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaComputerScreenshotConfig> screenshot`

      `screenshot`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaComputerScrollConfig> scroll`

      `scroll`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaComputerTripleClickConfig> tripleClick`

      `triple_click`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaComputerWaitConfig> wait`

      `wait`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

    - `Optional<BetaComputerZoomConfig> zoom`

      `zoom`'s config overrides.

      - `Optional<Boolean> deferLoading`

        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

      - `Optional<Boolean> enabled`

        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Toolset Configs

- `class BetaComputerToolsetConfigs`

  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<BetaComputerTypeConfig> type`

    `type`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

    `cursor_position`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaComputerDoubleClickConfig> doubleClick`

    `double_click`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaComputerHoldKeyConfig> holdKey`

    `hold_key`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaComputerKeyConfig> key`

    `key`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaComputerLeftClickConfig> leftClick`

    `left_click`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

    `left_click_drag`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

    `left_mouse_down`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

    `left_mouse_up`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaComputerMiddleClickConfig> middleClick`

    `middle_click`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaComputerMouseMoveConfig> mouseMove`

    `mouse_move`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaComputerRightClickConfig> rightClick`

    `right_click`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaComputerScreenshotConfig> screenshot`

    `screenshot`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaComputerScrollConfig> scroll`

    `scroll`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaComputerTripleClickConfig> tripleClick`

    `triple_click`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaComputerWaitConfig> wait`

    `wait`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

  - `Optional<BetaComputerZoomConfig> zoom`

    `zoom`'s config overrides.

    - `Optional<Boolean> deferLoading`

      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

    - `Optional<Boolean> enabled`

      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Triple Click Config

- `class BetaComputerTripleClickConfig`

  `triple_click`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Triple Click Input

- `class BetaComputerTripleClickInput`

  Triple-click the left mouse button at the specified (x, y) pixel coordinate, or
  the current cursor position if `coordinate` is omitted.

  - `Optional<List<Long>> coordinate`

    (x, y): x pixels from the left edge, y pixels from the top edge.

    minItems: 2, maxItems: 2

  - `Optional<String> text`

    Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

### Beta Computer Triple Click Tool Use Block

- `class BetaComputerTripleClickToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerTripleClickInput input`

    Triple-click the left mouse button at the specified (x, y) pixel coordinate, or
    the current cursor position if `coordinate` is omitted.

    - `Optional<List<Long>> coordinate`

      (x, y): x pixels from the left edge, y pixels from the top edge.

      minItems: 2, maxItems: 2

    - `Optional<String> text`

      Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

  - `JsonValue name = "triple_click"`

  - `JsonValue toolsetName = "computer"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Computer Type Config

- `class BetaComputerTypeConfig`

  `type`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Type Input

- `class BetaComputerTypeInput`

  Type a string of text on the keyboard.

  - `String text`

    The text to type.

### Beta Computer Type Tool Use Block

- `class BetaComputerTypeToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerTypeInput input`

    Type a string of text on the keyboard.

    - `String text`

      The text to type.

  - `JsonValue name = "type"`

  - `JsonValue toolsetName = "computer"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Computer Wait Config

- `class BetaComputerWaitConfig`

  `wait`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Wait Input

- `class BetaComputerWaitInput`

  Wait for a specified duration.

  - `long duration`

    Duration to wait, in seconds.

    maximum: 300

### Beta Computer Wait Tool Use Block

- `class BetaComputerWaitToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerWaitInput input`

    Wait for a specified duration.

    - `long duration`

      Duration to wait, in seconds.

      maximum: 300

  - `JsonValue name = "wait"`

  - `JsonValue toolsetName = "computer"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Computer Zoom Config

- `class BetaComputerZoomConfig`

  `zoom`'s config overrides.

  - `Optional<Boolean> deferLoading`

    Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

  - `Optional<Boolean> enabled`

    Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

### Beta Computer Zoom Input

- `class BetaComputerZoomInput`

  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<long> region`

    (x0, y0, x1, y1): The region to capture.

    minItems: 4, maxItems: 4

### Beta Computer Zoom Tool Use Block

- `class BetaComputerZoomToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `BetaComputerZoomInput 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<long> region`

      (x0, y0, x1, y1): The region to capture.

      minItems: 4, maxItems: 4

  - `JsonValue name = "zoom"`

  - `JsonValue toolsetName = "computer"`

  - `Optional<BetaToolUseCaller> caller`

    Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Container

- `class BetaContainer`

  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<List<BetaContainerSkill>> 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

### Beta Container Params

- `class BetaContainerParams`

  Container parameters with skills to be loaded.

  - `Optional<String> id`

    Container id

  - `Optional<List<BetaSkillParams>> 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<String> version`

      Skill version or 'latest' for most recent version

      minLength: 1, maxLength: 64

### Beta Container Skill

- `class BetaContainerSkill`

  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

### Beta Container Upload Block

- `class BetaContainerUploadBlock`

  Response model for a file uploaded to the container.

  - `JsonValue type = "container_upload"`

  - `String fileId`

### Beta Container Upload Block Param

- `class BetaContainerUploadBlockParam`

  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<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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")`

### Beta Content Block

- `class BetaContentBlock: union`

  - `class BetaTextBlock`

    - `JsonValue type = "text"`

    - `Optional<List<BetaTextCitation>> 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 BetaCitationCharLocation`

        - `JsonValue type = "char_location"`

        - `String citedText`

        - `long documentIndex`

          minimum: 0

        - `Optional<String> documentTitle`

        - `long endCharIndex`

        - `Optional<String> fileId`

        - `long startCharIndex`

          minimum: 0

      - `class BetaCitationPageLocation`

        - `JsonValue type = "page_location"`

        - `String citedText`

        - `long documentIndex`

          minimum: 0

        - `Optional<String> documentTitle`

        - `long endPageNumber`

        - `Optional<String> fileId`

        - `long startPageNumber`

          minimum: 1

      - `class BetaCitationContentBlockLocation`

        - `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<String> 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<String> fileId`

        - `long startBlockIndex`

          0-based index of the first cited block in the source's `content` array.

          minimum: 0

      - `class BetaCitationsWebSearchResultLocation`

        - `JsonValue type = "web_search_result_location"`

        - `String citedText`

        - `String encryptedIndex`

        - `Optional<String> title`

          maxLength: 512

        - `String url`

      - `class BetaCitationSearchResultLocation`

        - `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<String> title`

    - `String text`

  - `class BetaThinkingBlock`

    - `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 BetaRedactedThinkingBlock`

    - `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 BetaToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `Input input`

    - `String name`

      minLength: 1

    - `Optional<Caller> caller`

      - `class BetaDirectCaller`

        Tool invocation directly from the model.

        - `JsonValue type = "direct"`

      - `class BetaServerToolCaller`

        Tool invocation generated by a server-side tool.

        - `JsonValue type = "code_execution_20250825"`

        - `String toolId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `class BetaServerToolCaller20260120`

        - `JsonValue type = "code_execution_20260120"`

        - `String toolId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `Optional<String> toolsetName`

      For a toolset member tool_use, the toolset family.

      minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$

  - `class BetaServerToolUseBlock`

    - `JsonValue type = "server_tool_use"`

    - `String id`

      pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `Input input`

    - `Name name`

      - `ADVISOR("advisor")`

      - `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<Caller> caller`

      - `class BetaDirectCaller`

        Tool invocation directly from the model.

      - `class BetaServerToolCaller`

        Tool invocation generated by a server-side tool.

      - `class BetaServerToolCaller20260120`

  - `class BetaWebSearchToolResultBlock`

    - `JsonValue type = "web_search_tool_result"`

    - `BetaWebSearchToolResultBlockContent content`

      - `class BetaWebSearchToolResultError`

        - `JsonValue type = "web_search_tool_result_error"`

        - `BetaWebSearchToolResultErrorCode 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<BetaWebSearchResultBlock>`

        - `JsonValue type = "web_search_result"`

        - `String encryptedContent`

        - `Optional<String> pageAge`

        - `String title`

        - `String url`

    - `String toolUseId`

      pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `Optional<Caller> caller`

      - `class BetaDirectCaller`

        Tool invocation directly from the model.

      - `class BetaServerToolCaller`

        Tool invocation generated by a server-side tool.

      - `class BetaServerToolCaller20260120`

  - `class BetaWebFetchToolResultBlock`

    - `JsonValue type = "web_fetch_tool_result"`

    - `Content content`

      - `class BetaWebFetchToolResultErrorBlock`

        - `JsonValue type = "web_fetch_tool_result_error"`

        - `BetaWebFetchToolResultErrorCode 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 BetaWebFetchBlock`

        - `JsonValue type = "web_fetch_result"`

        - `BetaDocumentBlock content`

          - `JsonValue type = "document"`

          - `Optional<BetaCitationConfig> citations`

            Citation configuration for the document

            - `boolean enabled`

          - `Source source`

            - `class BetaBase64PdfSource`

              - `JsonValue type = "base64"`

              - `String data`

                format: byte

              - `JsonValue mediaType = "application/pdf"`

            - `class BetaPlainTextSource`

              - `JsonValue type = "text"`

              - `String data`

              - `JsonValue mediaType = "text/plain"`

          - `Optional<String> title`

            The title of the document

        - `Optional<String> retrievedAt`

          ISO 8601 timestamp when the content was retrieved

        - `String url`

          Fetched content URL

    - `String toolUseId`

      pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `Optional<Caller> caller`

      - `class BetaDirectCaller`

        Tool invocation directly from the model.

      - `class BetaServerToolCaller`

        Tool invocation generated by a server-side tool.

      - `class BetaServerToolCaller20260120`

  - `class BetaAdvisorToolResultBlock`

    - `JsonValue type = "advisor_tool_result"`

    - `Content content`

      - `class BetaAdvisorToolResultError`

        - `JsonValue type = "advisor_tool_result_error"`

        - `ErrorCode errorCode`

          - `MAX_USES_EXCEEDED("max_uses_exceeded")`

          - `PROMPT_TOO_LONG("prompt_too_long")`

          - `TOO_MANY_REQUESTS("too_many_requests")`

          - `OVERLOADED("overloaded")`

          - `UNAVAILABLE("unavailable")`

          - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

          - `MODEL_NOT_FOUND("model_not_found")`

      - `class BetaAdvisorResultBlock`

        - `JsonValue type = "advisor_result"`

        - `Optional<String> stopReason`

          The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap.

        - `String text`

      - `class BetaAdvisorRedactedResultBlock`

        - `JsonValue type = "advisor_redacted_result"`

        - `String encryptedContent`

          Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify.

        - `Optional<String> stopReason`

          The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`).

    - `String toolUseId`

      pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `class BetaCodeExecutionToolResultBlock`

    - `JsonValue type = "code_execution_tool_result"`

    - `BetaCodeExecutionToolResultBlockContent content`

      - `class BetaCodeExecutionToolResultError`

        - `JsonValue type = "code_execution_tool_result_error"`

        - `BetaCodeExecutionToolResultErrorCode errorCode`

          - `INVALID_TOOL_INPUT("invalid_tool_input")`

          - `UNAVAILABLE("unavailable")`

          - `TOO_MANY_REQUESTS("too_many_requests")`

          - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

      - `class BetaCodeExecutionResultBlock`

        - `JsonValue type = "code_execution_result"`

        - `List<BetaCodeExecutionOutputBlock> content`

          - `JsonValue type = "code_execution_output"`

          - `String fileId`

        - `long returnCode`

        - `String stderr`

        - `String stdout`

      - `class BetaEncryptedCodeExecutionResultBlock`

        Code execution result with encrypted stdout for PFC + web_search results.

        - `JsonValue type = "encrypted_code_execution_result"`

        - `List<BetaCodeExecutionOutputBlock> content`

          - `JsonValue type = "code_execution_output"`

          - `String fileId`

        - `String encryptedStdout`

        - `long returnCode`

        - `String stderr`

    - `String toolUseId`

      pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `class BetaBashCodeExecutionToolResultBlock`

    - `JsonValue type = "bash_code_execution_tool_result"`

    - `Content content`

      - `class BetaBashCodeExecutionToolResultError`

        - `JsonValue type = "bash_code_execution_tool_result_error"`

        - `ErrorCode 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 BetaBashCodeExecutionResultBlock`

        - `JsonValue type = "bash_code_execution_result"`

        - `List<BetaBashCodeExecutionOutputBlock> content`

          - `JsonValue type = "bash_code_execution_output"`

          - `String fileId`

        - `long returnCode`

        - `String stderr`

        - `String stdout`

    - `String toolUseId`

      pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `class BetaTextEditorCodeExecutionToolResultBlock`

    - `JsonValue type = "text_editor_code_execution_tool_result"`

    - `Content content`

      - `class BetaTextEditorCodeExecutionToolResultError`

        - `JsonValue type = "text_editor_code_execution_tool_result_error"`

        - `ErrorCode 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<String> errorMessage`

      - `class BetaTextEditorCodeExecutionViewResultBlock`

        - `JsonValue type = "text_editor_code_execution_view_result"`

        - `String content`

        - `FileType fileType`

          - `TEXT("text")`

          - `IMAGE("image")`

          - `PDF("pdf")`

        - `Optional<Long> numLines`

        - `Optional<Long> startLine`

        - `Optional<Long> totalLines`

      - `class BetaTextEditorCodeExecutionCreateResultBlock`

        - `JsonValue type = "text_editor_code_execution_create_result"`

        - `boolean isFileUpdate`

      - `class BetaTextEditorCodeExecutionStrReplaceResultBlock`

        - `JsonValue type = "text_editor_code_execution_str_replace_result"`

        - `Optional<List<String>> lines`

        - `Optional<Long> newLines`

        - `Optional<Long> newStart`

        - `Optional<Long> oldLines`

        - `Optional<Long> oldStart`

    - `String toolUseId`

      pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `class BetaToolSearchToolResultBlock`

    - `JsonValue type = "tool_search_tool_result"`

    - `Content content`

      - `class BetaToolSearchToolResultError`

        - `JsonValue type = "tool_search_tool_result_error"`

        - `ErrorCode errorCode`

          - `INVALID_TOOL_INPUT("invalid_tool_input")`

          - `UNAVAILABLE("unavailable")`

          - `TOO_MANY_REQUESTS("too_many_requests")`

          - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

        - `Optional<String> errorMessage`

      - `class BetaToolSearchToolSearchResultBlock`

        - `JsonValue type = "tool_search_tool_search_result"`

        - `List<BetaToolReferenceBlock> 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 BetaMcpToolUseBlock`

    - `JsonValue type = "mcp_tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `Input input`

    - `String name`

      The name of the MCP tool

    - `String serverName`

      The name of the MCP server

  - `class BetaMcpToolResultBlock`

    - `JsonValue type = "mcp_tool_result"`

    - `Content content`

      - `String`

      - `List<BetaTextBlock>`

        - `JsonValue type = "text"`

        - `Optional<List<BetaTextCitation>> 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`.

        - `String text`

    - `boolean isError`

    - `String toolUseId`

      pattern: ^[a-zA-Z0-9_-]+$

  - `class BetaContainerUploadBlock`

    Response model for a file uploaded to the container.

    - `JsonValue type = "container_upload"`

    - `String fileId`

  - `class BetaCompactionBlock`

    A compaction block returned when autocompact is triggered.

    When content is None, it indicates the compaction failed to produce a valid
    summary (e.g., malformed output from the model). Clients may round-trip
    compaction blocks with null content; the server treats them as no-ops.

    - `JsonValue type = "compaction"`

    - `Optional<String> content`

      Summary of compacted content, or null if compaction failed

    - `Optional<String> encryptedContent`

      Opaque metadata from prior compaction, to be round-tripped verbatim

    - `Optional<String> signature`

      Signature over the summary, to be sent back with the block verbatim

    - `Optional<List<ToolChange>> toolChanges`

      The tool changes of the compacted range: the `tool_addition` and `tool_removal` blocks that take the request's `tools` to the tool set in effect at the end of the range, or `[]` when the range changed no tool. Absent when the server did not compute them. Send the block back unchanged.

      - `class BetaResponseToolAdditionBlock`

        An entry of a `compaction` block's `tool_changes`: a tool the
        compacted range made available, as a reference to a `tools` entry or
        MCP toolset, or as the tool definition in effect at the end of the
        range, by value. Send it back unchanged.

        - `JsonValue type = "tool_addition"`

        - `Tool tool`

          The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value.

          - `class BetaResponseToolChangeToolReference`

            Reference to a single tool, by the name the model uses to call it, as
            a `compaction` block's `tool_changes` entry reports it: a tool
            declared in `tools` or defined by an earlier `tool_addition` block.
            Send it back unchanged with the block.

            - `JsonValue type = "tool_reference"`

            - `String name`

          - `class BetaResponseToolChangeMcpToolReference`

            Reference to a single MCP tool, by its server and its name on that
            server, as a `compaction` block's `tool_changes` entry reports it.
            Send it back unchanged with the block.

            - `JsonValue type = "mcp_tool_reference"`

            - `String name`

            - `String serverName`

          - `class BetaResponseToolChangeMcpToolsetReference`

            Reference to every tool in the named MCP server's toolset, as a
            `compaction` block's `tool_changes` entry reports it. Send it back
            unchanged with the block.

            - `JsonValue type = "mcp_toolset_reference"`

            - `String serverName`

          - `class BetaToolChangeToolDefinition`

            A tool defined by value, as a `compaction` block's `tool_changes` entry
            reports it: `definition` is the tool's definition as it was sent, in the
            form of a `tools` entry, without `cache_control`. Send it back unchanged
            with the block.

            - `JsonValue type = "tool_definition"`

            - `BetaResponseToolUnion definition`

              - `class BetaResponseTool`

                A custom tool definition, as sent.

                - `Optional<Type> type`

                - `BetaResponseToolInputSchema 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> properties`

                  - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolBash20241022`

                - `JsonValue type = "bash_20241022"`

                - `JsonValue name = "bash"`

                  Name of the tool.

                  This is how the tool will be called by the model and in `tool_use` blocks.

                - `Optional<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                  - `JsonValue type = "ephemeral"`

                  - `Optional<Ttl> 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<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolBash20250124`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaCodeExecutionTool20250522`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaCodeExecutionTool20250825`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaCodeExecutionTool20260120`

                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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaCodeExecutionTool20260521`

                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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaBrowserToolset20260801`

                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<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

                    `type`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserCloseTabConfig> closeTab`

                    `close_tab`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

                    `double_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserFileUploadConfig> fileUpload`

                    `file_upload`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserFindConfig> find`

                    `find`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserFormInputConfig> formInput`

                    `form_input`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserGetPageTextConfig> getPageText`

                    `get_page_text`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserHoldKeyConfig> holdKey`

                    `hold_key`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserHoverConfig> hover`

                    `hover`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

                    `javascript_exec`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserKeyConfig> key`

                    `key`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserLeftClickConfig> leftClick`

                    `left_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

                    `left_click_drag`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

                    `left_mouse_down`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

                    `left_mouse_up`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserListTabsConfig> listTabs`

                    `list_tabs`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserMiddleClickConfig> middleClick`

                    `middle_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

                    `mouse_move`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserNavigateConfig> navigate`

                    `navigate`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserNewTabConfig> newTab`

                    `new_tab`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserReadConsoleConfig> readConsole`

                    `read_console`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

                    `read_network`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserReadPageConfig> readPage`

                    `read_page`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserRightClickConfig> rightClick`

                    `right_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserScreenshotConfig> screenshot`

                    `screenshot`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserScrollConfig> scroll`

                    `scroll`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserScrollToConfig> scrollTo`

                    `scroll_to`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserSwitchTabConfig> switchTab`

                    `switch_tab`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserTripleClickConfig> tripleClick`

                    `triple_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserWaitConfig> wait`

                    `wait`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserZoomConfig> zoom`

                    `zoom`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered 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 BetaToolComputerUse20241022`

                - `JsonValue type = "computer_20241022"`

                - `long displayHeightPx`

                  The height of the display in pixels.

                  minimum: 1

                - `long displayWidthPx`

                  The width of the display in pixels.

                  minimum: 1

                - `JsonValue name = "computer"`

                  Name of the tool.

                  This is how the tool will be called by the model and in `tool_use` blocks.

                - `Optional<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> displayNumber`

                  The X11 display number (e.g. 0, 1) for the display.

                  minimum: 0

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaMemoryTool20250818`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolComputerUse20250124`

                - `JsonValue type = "computer_20250124"`

                - `long displayHeightPx`

                  The height of the display in pixels.

                  minimum: 1

                - `long displayWidthPx`

                  The width of the display in pixels.

                  minimum: 1

                - `JsonValue name = "computer"`

                  Name of the tool.

                  This is how the tool will be called by the model and in `tool_use` blocks.

                - `Optional<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> displayNumber`

                  The X11 display number (e.g. 0, 1) for the display.

                  minimum: 0

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolTextEditor20241022`

                - `JsonValue type = "text_editor_20241022"`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolComputerUse20251124`

                - `JsonValue type = "computer_20251124"`

                - `long displayHeightPx`

                  The height of the display in pixels.

                  minimum: 1

                - `long displayWidthPx`

                  The width of the display in pixels.

                  minimum: 1

                - `JsonValue name = "computer"`

                  Name of the tool.

                  This is how the tool will be called by the model and in `tool_use` blocks.

                - `Optional<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> displayNumber`

                  The X11 display number (e.g. 0, 1) for the display.

                  minimum: 0

                - `Optional<Boolean> enableZoom`

                  Whether to enable an action to take a zoomed-in screenshot of the screen.

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaComputerToolset20260801`

                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<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

                    `type`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

                    `cursor_position`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerDoubleClickConfig> doubleClick`

                    `double_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerHoldKeyConfig> holdKey`

                    `hold_key`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerKeyConfig> key`

                    `key`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerLeftClickConfig> leftClick`

                    `left_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

                    `left_click_drag`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

                    `left_mouse_down`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

                    `left_mouse_up`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerMiddleClickConfig> middleClick`

                    `middle_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerMouseMoveConfig> mouseMove`

                    `mouse_move`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerRightClickConfig> rightClick`

                    `right_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerScreenshotConfig> screenshot`

                    `screenshot`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerScrollConfig> scroll`

                    `scroll`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerTripleClickConfig> tripleClick`

                    `triple_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerWaitConfig> wait`

                    `wait`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerZoomConfig> zoom`

                    `zoom`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered 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 BetaToolTextEditor20250124`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolTextEditor20250429`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolTextEditor20250728`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Long> maxCharacters`

                  Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

                  minimum: 1

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaWebSearchTool20250305`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<List<String>> allowedDomains`

                  If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                - `Optional<List<String>> blockedDomains`

                  If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> maxUses`

                  Maximum number of times the tool can be used in the API request.

                  minimum: 1

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

                - `Optional<BetaUserLocation> userLocation`

                  Parameters for the user's location. Used to provide more relevant search results.

                  - `JsonValue type = "approximate"`

                  - `Optional<String> city`

                    The city of the user.

                    minLength: 1, maxLength: 255

                  - `Optional<String> 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<String> region`

                    The region of the user.

                    minLength: 1, maxLength: 255

                  - `Optional<String> timezone`

                    The [IANA timezone](https://nodatime.org/TimeZones) of the user.

                    minLength: 1, maxLength: 255

              - `class BetaWebFetchTool20250910`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<List<String>> allowedDomains`

                  List of domains to allow fetching from

                - `Optional<List<String>> blockedDomains`

                  List of domains to block fetching from

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<BetaCitationsConfigParam> citations`

                  Citations configuration for fetched documents. Citations are disabled by default.

                  - `Optional<Boolean> enabled`

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> 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<Long> maxUses`

                  Maximum number of times the tool can be used in the API request.

                  minimum: 1

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

                - `Optional<BetaWebFetchUrlSources> urlSources`

                  Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                  - `Optional<ClientToolResults> clientToolResults`

                    Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

                    - `class BetaWebFetchUrlSourceAll`

                      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 BetaWebFetchUrlSourceNone`

                      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 BetaWebFetchUrlSourceOnly`

                      The tool filter variant under which only the named tools' results
                      contribute.

                      - `JsonValue type = "only"`

                      - `List<BetaWebFetchUrlSourceToolReference> tools`

                        - `JsonValue type = "tool_reference"`

                        - `String name`

                    - `class BetaWebFetchUrlSourceExcept`

                      The tool filter variant under which every result but the named
                      tools' contributes.

                      - `JsonValue type = "except"`

                      - `List<BetaWebFetchUrlSourceToolReference> tools`

                        - `JsonValue type = "tool_reference"`

                        - `String name`

                  - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

                      The `url_sources` variant under which a source contributes in
                      full: every result of the tool filter's source, or all user input.

                    - `class BetaWebFetchUrlSourceNone`

                      The `url_sources` variant under which a source contributes nothing:
                      no result of the tool filter's source, or no user input.

                    - `class BetaWebFetchUrlSourceOnly`

                      The tool filter variant under which only the named tools' results
                      contribute.

                    - `class BetaWebFetchUrlSourceExcept`

                      The tool filter variant under which every result but the named
                      tools' contributes.

                  - `Optional<UserInput> userInput`

                    Whether URLs in user messages are fetchable: "all" or "none".

                    - `class BetaWebFetchUrlSourceAll`

                      The `url_sources` variant under which a source contributes in
                      full: every result of the tool filter's source, or all user input.

                    - `class BetaWebFetchUrlSourceNone`

                      The `url_sources` variant under which a source contributes nothing:
                      no result of the tool filter's source, or no user input.

              - `class BetaWebSearchTool20260209`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<List<String>> allowedDomains`

                  If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                - `Optional<List<String>> blockedDomains`

                  If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> maxUses`

                  Maximum number of times the tool can be used in the API request.

                  minimum: 1

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

                - `Optional<BetaUserLocation> userLocation`

                  Parameters for the user's location. Used to provide more relevant search results.

              - `class BetaWebFetchTool20260209`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<List<String>> allowedDomains`

                  List of domains to allow fetching from

                - `Optional<List<String>> blockedDomains`

                  List of domains to block fetching from

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<BetaCitationsConfigParam> citations`

                  Citations configuration for fetched documents. Citations are disabled by default.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> 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<Long> maxUses`

                  Maximum number of times the tool can be used in the API request.

                  minimum: 1

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

                - `Optional<BetaWebFetchUrlSources> urlSources`

                  Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

              - `class BetaWebFetchTool20260309`

                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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<List<String>> allowedDomains`

                  List of domains to allow fetching from

                - `Optional<List<String>> blockedDomains`

                  List of domains to block fetching from

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<BetaCitationsConfigParam> citations`

                  Citations configuration for fetched documents. Citations are disabled by default.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> 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<Long> maxUses`

                  Maximum number of times the tool can be used in the API request.

                  minimum: 1

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

                - `Optional<BetaWebFetchUrlSources> urlSources`

                  Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                - `Optional<Boolean> 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 BetaWebSearchTool20260318`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<List<String>> allowedDomains`

                  If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                - `Optional<List<String>> blockedDomains`

                  If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> maxUses`

                  Maximum number of times the tool can be used in the API request.

                  minimum: 1

                - `Optional<ResponseInclusion> 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<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

                - `Optional<BetaUserLocation> userLocation`

                  Parameters for the user's location. Used to provide more relevant search results.

              - `class BetaWebFetchTool20260318`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<List<String>> allowedDomains`

                  List of domains to allow fetching from

                - `Optional<List<String>> blockedDomains`

                  List of domains to block fetching from

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<BetaCitationsConfigParam> citations`

                  Citations configuration for fetched documents. Citations are disabled by default.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> 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<Long> maxUses`

                  Maximum number of times the tool can be used in the API request.

                  minimum: 1

                - `Optional<ResponseInclusion> 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<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

                - `Optional<BetaWebFetchUrlSources> urlSources`

                  Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                - `Optional<Boolean> 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 BetaAdvisorTool20260301`

                - `JsonValue type = "advisor_20260301"`

                - `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 name = "advisor"`

                  Name of the tool.

                  This is how the tool will be called by the model and in `tool_use` blocks.

                - `Optional<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<BetaCacheControlEphemeral> caching`

                  Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> maxTokens`

                  Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

                  minimum: 1024

                - `Optional<Long> maxUses`

                  Maximum number of times the tool can be used in the API request.

                  minimum: 1

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolSearchToolRegex20251119`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaMcpToolset`

                Configuration for a group of tools from an MCP server.

                Allows configuring enabled status and defer_loading for all tools
                from an MCP server, with optional per-tool overrides.

                - `JsonValue type = "mcp_toolset"`

                - `String mcpServerName`

                  Name of the MCP server to configure tools for

                  minLength: 1, maxLength: 255

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Configs> configs`

                  Configuration overrides for specific tools, keyed by tool name

                  - `Optional<Boolean> deferLoading`

                  - `Optional<Boolean> enabled`

                - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

                  Default configuration applied to all tools from this server

                  - `Optional<Boolean> deferLoading`

                  - `Optional<Boolean> enabled`

                - `Optional<List<BetaMcpToolParam>> tools`

                  The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

                  - `InputSchema inputSchema`

                    The tool's input schema as the MCP server lists it, verbatim.

                  - `String name`

                    The tool's name as the MCP server lists it (not prefixed with the server name).

                    minLength: 1

                  - `Optional<String> description`

                    The tool's description as the MCP server lists it.

      - `class BetaResponseToolRemovalBlock`

        An entry of a `compaction` block's `tool_changes`: a tool of the
        request's `tools` (or an MCP tool or toolset) that the compacted range
        withdrew. Send it back unchanged.

        - `JsonValue type = "tool_removal"`

        - `Tool tool`

          A reference to the withdrawn `tools` entry, MCP tool or MCP toolset.

          - `class BetaResponseToolChangeToolReference`

            Reference to a single tool, by the name the model uses to call it, as
            a `compaction` block's `tool_changes` entry reports it: a tool
            declared in `tools` or defined by an earlier `tool_addition` block.
            Send it back unchanged with the block.

          - `class BetaResponseToolChangeMcpToolReference`

            Reference to a single MCP tool, by its server and its name on that
            server, as a `compaction` block's `tool_changes` entry reports it.
            Send it back unchanged with the block.

          - `class BetaResponseToolChangeMcpToolsetReference`

            Reference to every tool in the named MCP server's toolset, as a
            `compaction` block's `tool_changes` entry reports it. Send it back
            unchanged with the block.

  - `class BetaFallbackBlock`

    Marks the point in `content` where one model's output gives way to the next.

    One block appears per hop where a preceding model actually ran this turn and
    declined. A turn where no preceding model ran and declined has no such
    boundary and carries no block — the signal for whether a fallback model
    served the response is the presence of a `fallback_message` entry in
    `usage.iterations`, not this block.

    The block is treated like a server-tool content block for streaming: it
    arrives via the standard `content_block_start` / `content_block_stop`
    pair and carries no deltas.

    - `JsonValue type = "fallback"`

    - `BetaFallbackInfo from`

      The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id.

      - `Model model`

        The model that will complete your prompt.

        See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

    - `BetaFallbackInfo to`

      The fallback model producing the content that follows this block. Its `model` is always the canonical id.

    - `BetaFallbackRefusalTrigger trigger`

      What caused the `from` model to hand over at this hop.

      - `JsonValue type = "refusal"`

      - `Optional<Category> category`

        The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.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.

  - `class BetaMcpToolListingBlock`

    The tool listing the server fetched from an MCP server while producing
    this response. Send the assistant message back unchanged, this block
    included, so later requests use this listing instead of asking the MCP
    server again.

    - `JsonValue type = "mcp_tool_listing"`

    - `String mcpServerName`

    - `List<BetaMcpTool> tools`

      - `InputSchema inputSchema`

      - `String name`

      - `Optional<String> description`

### Beta Content Block Param

- `class BetaContentBlockParam: union`

  - `class BetaTextBlockParam`

    - `JsonValue type = "text"`

    - `String text`

      minLength: 1

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

      - `JsonValue type = "ephemeral"`

      - `Optional<Ttl> 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<List<BetaTextCitationParam>> citations`

      - `class BetaCitationCharLocationParam`

        - `JsonValue type = "char_location"`

        - `String citedText`

        - `long documentIndex`

          minimum: 0

        - `Optional<String> documentTitle`

          minLength: 1, maxLength: 500

        - `long endCharIndex`

        - `long startCharIndex`

          minimum: 0

      - `class BetaCitationPageLocationParam`

        - `JsonValue type = "page_location"`

        - `String citedText`

        - `long documentIndex`

          minimum: 0

        - `Optional<String> documentTitle`

          minLength: 1, maxLength: 500

        - `long endPageNumber`

        - `long startPageNumber`

          minimum: 1

      - `class BetaCitationContentBlockLocationParam`

        - `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<String> 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 BetaCitationWebSearchResultLocationParam`

        - `JsonValue type = "web_search_result_location"`

        - `String citedText`

        - `String encryptedIndex`

        - `Optional<String> title`

          minLength: 1, maxLength: 512

        - `String url`

          minLength: 1

      - `class BetaCitationSearchResultLocationParam`

        - `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<String> title`

  - `class BetaImageBlockParam`

    - `JsonValue type = "image"`

    - `Source source`

      - `class BetaBase64ImageSource`

        - `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 BetaUrlImageSource`

        - `JsonValue type = "url"`

        - `String url`

      - `class BetaFileImageSource`

        - `JsonValue type = "file"`

        - `String fileId`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaImageTransformationsParam> 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> 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 BetaRequestDocumentBlock`

    - `JsonValue type = "document"`

    - `Source source`

      - `class BetaBase64PdfSource`

        - `JsonValue type = "base64"`

        - `String data`

          format: byte

        - `JsonValue mediaType = "application/pdf"`

      - `class BetaPlainTextSource`

        - `JsonValue type = "text"`

        - `String data`

        - `JsonValue mediaType = "text/plain"`

      - `class BetaContentBlockSource`

        - `JsonValue type = "content"`

        - `Content content`

          - `String`

          - `List<BetaContentBlockSourceContent>`

            - `class BetaTextBlockParam`

            - `class BetaImageBlockParam`

      - `class BetaUrlPdfSource`

        - `JsonValue type = "url"`

        - `String url`

      - `class BetaFileDocumentSource`

        - `JsonValue type = "file"`

        - `String fileId`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaCitationsConfigParam> citations`

      - `Optional<Boolean> enabled`

    - `Optional<String> context`

      minLength: 1

    - `Optional<String> title`

      minLength: 1, maxLength: 500

  - `class BetaSearchResultBlockParam`

    - `JsonValue type = "search_result"`

    - `List<BetaTextBlockParam> content`

      - `JsonValue type = "text"`

      - `String text`

        minLength: 1

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<List<BetaTextCitationParam>> citations`

    - `String source`

    - `String title`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaCitationsConfigParam> citations`

  - `class BetaThinkingBlockParam`

    - `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 BetaRedactedThinkingBlockParam`

    - `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 BetaToolUseBlockParam`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `Input input`

    - `String name`

      minLength: 1, maxLength: 200

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Caller> caller`

      - `class BetaDirectCaller`

        Tool invocation directly from the model.

        - `JsonValue type = "direct"`

      - `class BetaServerToolCaller`

        Tool invocation generated by a server-side tool.

        - `JsonValue type = "code_execution_20250825"`

        - `String toolId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `class BetaServerToolCaller20260120`

        - `JsonValue type = "code_execution_20260120"`

        - `String toolId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `Optional<String> toolsetName`

      For a toolset member tool_use, the toolset family this member belongs to.

      minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$

  - `class BetaToolResultBlockParam`

    - `JsonValue type = "tool_result"`

    - `String toolUseId`

      pattern: ^[a-zA-Z0-9_-]+$

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Content> content`

      - `String`

      - `List<Block>`

        - `class BetaTextBlockParam`

        - `class BetaImageBlockParam`

        - `class BetaSearchResultBlockParam`

        - `class BetaRequestDocumentBlock`

        - `class BetaToolReferenceBlockParam`

          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<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

        - `class BetaBrowserStateBlockParam`

          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<BetaBrowserStateTabEntry> 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<Boolean> active`

              Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<List<BetaBrowserStateChange>> 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 BetaBrowserStateChangeTabOpened`

              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 BetaBrowserStateChangeDownloadStarted`

              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 BetaBrowserStateChangeDownloadCompleted`

              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<String> 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<Long> sizeBytes`

                The completed download's size.

                minimum: 0

            - `class BetaBrowserStateChangeDownloadFailed`

              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<String> error`

                The failure or cancellation detail, when known.

                maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$

    - `Optional<Boolean> isError`

    - `Optional<String> 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 BetaServerToolUseBlockParam`

    - `JsonValue type = "server_tool_use"`

    - `String id`

      pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `Input input`

    - `Name name`

      - `ADVISOR("advisor")`

      - `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<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Caller> caller`

      - `class BetaDirectCaller`

        Tool invocation directly from the model.

      - `class BetaServerToolCaller`

        Tool invocation generated by a server-side tool.

      - `class BetaServerToolCaller20260120`

  - `class BetaWebSearchToolResultBlockParam`

    - `JsonValue type = "web_search_tool_result"`

    - `BetaWebSearchToolResultBlockParamContent content`

      - `List<BetaWebSearchResultBlockParam>`

        - `JsonValue type = "web_search_result"`

        - `String encryptedContent`

        - `String title`

        - `String url`

        - `Optional<String> pageAge`

      - `class BetaWebSearchToolRequestError`

        - `JsonValue type = "web_search_tool_result_error"`

        - `BetaWebSearchToolResultErrorCode 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<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Caller> caller`

      - `class BetaDirectCaller`

        Tool invocation directly from the model.

      - `class BetaServerToolCaller`

        Tool invocation generated by a server-side tool.

      - `class BetaServerToolCaller20260120`

  - `class BetaWebFetchToolResultBlockParam`

    - `JsonValue type = "web_fetch_tool_result"`

    - `Content content`

      - `class BetaWebFetchToolResultErrorBlockParam`

        - `JsonValue type = "web_fetch_tool_result_error"`

        - `BetaWebFetchToolResultErrorCode 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 BetaWebFetchBlockParam`

        - `JsonValue type = "web_fetch_result"`

        - `BetaRequestDocumentBlock content`

        - `String url`

          Fetched content URL

        - `Optional<String> retrievedAt`

          ISO 8601 timestamp when the content was retrieved

    - `String toolUseId`

      pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Caller> caller`

      - `class BetaDirectCaller`

        Tool invocation directly from the model.

      - `class BetaServerToolCaller`

        Tool invocation generated by a server-side tool.

      - `class BetaServerToolCaller20260120`

  - `class BetaAdvisorToolResultBlockParam`

    - `JsonValue type = "advisor_tool_result"`

    - `Content content`

      - `class BetaAdvisorToolResultErrorParam`

        - `JsonValue type = "advisor_tool_result_error"`

        - `ErrorCode errorCode`

          - `MAX_USES_EXCEEDED("max_uses_exceeded")`

          - `PROMPT_TOO_LONG("prompt_too_long")`

          - `TOO_MANY_REQUESTS("too_many_requests")`

          - `OVERLOADED("overloaded")`

          - `UNAVAILABLE("unavailable")`

          - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

          - `MODEL_NOT_FOUND("model_not_found")`

      - `class BetaAdvisorResultBlockParam`

        - `JsonValue type = "advisor_result"`

        - `String text`

        - `Optional<String> stopReason`

      - `class BetaAdvisorRedactedResultBlockParam`

        - `JsonValue type = "advisor_redacted_result"`

        - `String encryptedContent`

          Opaque blob produced by a prior response; must be round-tripped verbatim.

        - `Optional<String> stopReason`

    - `String toolUseId`

      pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

  - `class BetaCodeExecutionToolResultBlockParam`

    - `JsonValue type = "code_execution_tool_result"`

    - `BetaCodeExecutionToolResultBlockParamContent content`

      - `class BetaCodeExecutionToolResultErrorParam`

        - `JsonValue type = "code_execution_tool_result_error"`

        - `BetaCodeExecutionToolResultErrorCode errorCode`

          - `INVALID_TOOL_INPUT("invalid_tool_input")`

          - `UNAVAILABLE("unavailable")`

          - `TOO_MANY_REQUESTS("too_many_requests")`

          - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

      - `class BetaCodeExecutionResultBlockParam`

        - `JsonValue type = "code_execution_result"`

        - `List<BetaCodeExecutionOutputBlockParam> content`

          - `JsonValue type = "code_execution_output"`

          - `String fileId`

        - `long returnCode`

        - `String stderr`

        - `String stdout`

      - `class BetaEncryptedCodeExecutionResultBlockParam`

        Code execution result with encrypted stdout for PFC + web_search results.

        - `JsonValue type = "encrypted_code_execution_result"`

        - `List<BetaCodeExecutionOutputBlockParam> content`

          - `JsonValue type = "code_execution_output"`

          - `String fileId`

        - `String encryptedStdout`

        - `long returnCode`

        - `String stderr`

    - `String toolUseId`

      pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

  - `class BetaBashCodeExecutionToolResultBlockParam`

    - `JsonValue type = "bash_code_execution_tool_result"`

    - `Content content`

      - `class BetaBashCodeExecutionToolResultErrorParam`

        - `JsonValue type = "bash_code_execution_tool_result_error"`

        - `ErrorCode 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 BetaBashCodeExecutionResultBlockParam`

        - `JsonValue type = "bash_code_execution_result"`

        - `List<BetaBashCodeExecutionOutputBlockParam> content`

          - `JsonValue type = "bash_code_execution_output"`

          - `String fileId`

        - `long returnCode`

        - `String stderr`

        - `String stdout`

    - `String toolUseId`

      pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

  - `class BetaTextEditorCodeExecutionToolResultBlockParam`

    - `JsonValue type = "text_editor_code_execution_tool_result"`

    - `Content content`

      - `class BetaTextEditorCodeExecutionToolResultErrorParam`

        - `JsonValue type = "text_editor_code_execution_tool_result_error"`

        - `ErrorCode 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<String> errorMessage`

      - `class BetaTextEditorCodeExecutionViewResultBlockParam`

        - `JsonValue type = "text_editor_code_execution_view_result"`

        - `String content`

        - `FileType fileType`

          - `TEXT("text")`

          - `IMAGE("image")`

          - `PDF("pdf")`

        - `Optional<Long> numLines`

        - `Optional<Long> startLine`

        - `Optional<Long> totalLines`

      - `class BetaTextEditorCodeExecutionCreateResultBlockParam`

        - `JsonValue type = "text_editor_code_execution_create_result"`

        - `boolean isFileUpdate`

      - `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam`

        - `JsonValue type = "text_editor_code_execution_str_replace_result"`

        - `Optional<List<String>> lines`

        - `Optional<Long> newLines`

        - `Optional<Long> newStart`

        - `Optional<Long> oldLines`

        - `Optional<Long> oldStart`

    - `String toolUseId`

      pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

  - `class BetaToolSearchToolResultBlockParam`

    - `JsonValue type = "tool_search_tool_result"`

    - `Content content`

      - `class BetaToolSearchToolResultErrorParam`

        - `JsonValue type = "tool_search_tool_result_error"`

        - `ErrorCode errorCode`

          - `INVALID_TOOL_INPUT("invalid_tool_input")`

          - `UNAVAILABLE("unavailable")`

          - `TOO_MANY_REQUESTS("too_many_requests")`

          - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

        - `Optional<String> errorMessage`

      - `class BetaToolSearchToolSearchResultBlockParam`

        - `JsonValue type = "tool_search_tool_search_result"`

        - `List<BetaToolReferenceBlockParam> toolReferences`

          - `JsonValue type = "tool_reference"`

          - `String toolName`

            minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

    - `String toolUseId`

      pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

  - `class BetaMcpToolUseBlockParam`

    - `JsonValue type = "mcp_tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `Input input`

    - `String name`

    - `String serverName`

      The name of the MCP server

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

  - `class BetaRequestMcpToolResultBlockParam`

    - `JsonValue type = "mcp_tool_result"`

    - `String toolUseId`

      pattern: ^[a-zA-Z0-9_-]+$

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Content> content`

      - `String`

      - `List<BetaTextBlockParam>`

        - `JsonValue type = "text"`

        - `String text`

          minLength: 1

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<List<BetaTextCitationParam>> citations`

    - `Optional<Boolean> isError`

  - `class BetaContainerUploadBlockParam`

    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<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

  - `class BetaCompactionBlockParam`

    A compaction block containing summary of previous context.

    Users should round-trip these blocks from responses to subsequent requests
    to maintain context across compaction boundaries.

    When content is None, the block represents a failed compaction. The server
    treats these as no-ops. Empty string content is not allowed.

    - `JsonValue type = "compaction"`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<String> content`

      Summary of previously compacted content, or null if compaction failed

    - `Optional<String> encryptedContent`

      Opaque metadata from prior compaction, to be round-tripped verbatim

    - `Optional<String> signature`

      The block's signature as returned, to be sent back verbatim

    - `Optional<List<ToolChange>> toolChanges`

      The tool changes of the compacted range, as the server returned them on this block: the `tool_addition` and `tool_removal` entries that take the request's `tools` to the tool set in effect at the end of the range. Send them back unchanged with the block.

      - `class BetaRequestToolAdditionBlock`

        Mid-conversation directive to make a tool available.

        `tool` is a reference to a tool (or MCP toolset) declared in the
        request's `tools`. Under the `inline-tools-2026-09-15` beta it may
        instead be a reference to a tool defined earlier in `messages`, or a
        `tool_definition` object that carries an inline tool definition in
        `definition` (the same object a `tools` entry holds). An `mcp_toolset`
        definition also requires the `mcp-client-2026-09-15` beta. The tool is
        offered to the model from this point in the conversation onward.

        - `JsonValue type = "tool_addition"`

        - `Tool tool`

          - `class BetaToolChangeToolReference`

            Reference to a single tool, by the name the model uses to call it: a
            tool declared in `tools` or defined by an earlier `tool_addition`
            block. Does not accept the composed `{server}_{name}` form the server
            assigns to MCP-resolved tools; use `mcp_tool_reference` or
            `mcp_toolset_reference` for those.

            - `JsonValue type = "tool_reference"`

            - `String name`

              pattern: ^[a-zA-Z0-9_-]{1,128}$

          - `class BetaToolChangeMcpToolReference`

            Reference to a single MCP tool by its server and remote name; the
            same `server_name`/`name` pair `mcp_tool_use` carries.

            - `JsonValue type = "mcp_tool_reference"`

            - `String name`

            - `String serverName`

          - `class BetaToolChangeMcpToolsetReference`

            Reference to every tool in the named MCP server's toolset.

            - `JsonValue type = "mcp_toolset_reference"`

            - `String serverName`

          - `class BetaToolChangeToolDefinitionParam`

            A tool defined by value: `definition` is a `tools` entry (any kind
            `tools` accepts, an MCP toolset included). An `mcp_toolset` given here
            also requires the `mcp-client-2026-09-15` beta.

            - `JsonValue type = "tool_definition"`

            - `BetaToolUnion definition`

              - `class BetaTool`

                - `Optional<Type> 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> properties`

                  - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolBash20241022`

                - `JsonValue type = "bash_20241022"`

                - `JsonValue name = "bash"`

                  Name of the tool.

                  This is how the tool will be called by the model and in `tool_use` blocks.

                - `Optional<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolBash20250124`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaCodeExecutionTool20250522`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaCodeExecutionTool20250825`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaCodeExecutionTool20260120`

                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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaCodeExecutionTool20260521`

                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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaBrowserToolset20260801`

                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<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

                    `type`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserCloseTabConfig> closeTab`

                    `close_tab`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

                    `double_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserFileUploadConfig> fileUpload`

                    `file_upload`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserFindConfig> find`

                    `find`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserFormInputConfig> formInput`

                    `form_input`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserGetPageTextConfig> getPageText`

                    `get_page_text`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserHoldKeyConfig> holdKey`

                    `hold_key`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserHoverConfig> hover`

                    `hover`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

                    `javascript_exec`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserKeyConfig> key`

                    `key`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserLeftClickConfig> leftClick`

                    `left_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

                    `left_click_drag`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

                    `left_mouse_down`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

                    `left_mouse_up`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserListTabsConfig> listTabs`

                    `list_tabs`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserMiddleClickConfig> middleClick`

                    `middle_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

                    `mouse_move`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserNavigateConfig> navigate`

                    `navigate`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserNewTabConfig> newTab`

                    `new_tab`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserReadConsoleConfig> readConsole`

                    `read_console`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

                    `read_network`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserReadPageConfig> readPage`

                    `read_page`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserRightClickConfig> rightClick`

                    `right_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserScreenshotConfig> screenshot`

                    `screenshot`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserScrollConfig> scroll`

                    `scroll`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserScrollToConfig> scrollTo`

                    `scroll_to`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserSwitchTabConfig> switchTab`

                    `switch_tab`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserTripleClickConfig> tripleClick`

                    `triple_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserWaitConfig> wait`

                    `wait`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaBrowserZoomConfig> zoom`

                    `zoom`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered 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 BetaToolComputerUse20241022`

                - `JsonValue type = "computer_20241022"`

                - `long displayHeightPx`

                  The height of the display in pixels.

                  minimum: 1

                - `long displayWidthPx`

                  The width of the display in pixels.

                  minimum: 1

                - `JsonValue name = "computer"`

                  Name of the tool.

                  This is how the tool will be called by the model and in `tool_use` blocks.

                - `Optional<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> displayNumber`

                  The X11 display number (e.g. 0, 1) for the display.

                  minimum: 0

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaMemoryTool20250818`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolComputerUse20250124`

                - `JsonValue type = "computer_20250124"`

                - `long displayHeightPx`

                  The height of the display in pixels.

                  minimum: 1

                - `long displayWidthPx`

                  The width of the display in pixels.

                  minimum: 1

                - `JsonValue name = "computer"`

                  Name of the tool.

                  This is how the tool will be called by the model and in `tool_use` blocks.

                - `Optional<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> displayNumber`

                  The X11 display number (e.g. 0, 1) for the display.

                  minimum: 0

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolTextEditor20241022`

                - `JsonValue type = "text_editor_20241022"`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolComputerUse20251124`

                - `JsonValue type = "computer_20251124"`

                - `long displayHeightPx`

                  The height of the display in pixels.

                  minimum: 1

                - `long displayWidthPx`

                  The width of the display in pixels.

                  minimum: 1

                - `JsonValue name = "computer"`

                  Name of the tool.

                  This is how the tool will be called by the model and in `tool_use` blocks.

                - `Optional<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> displayNumber`

                  The X11 display number (e.g. 0, 1) for the display.

                  minimum: 0

                - `Optional<Boolean> enableZoom`

                  Whether to enable an action to take a zoomed-in screenshot of the screen.

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaComputerToolset20260801`

                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<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

                    `type`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

                    `cursor_position`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerDoubleClickConfig> doubleClick`

                    `double_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerHoldKeyConfig> holdKey`

                    `hold_key`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerKeyConfig> key`

                    `key`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerLeftClickConfig> leftClick`

                    `left_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

                    `left_click_drag`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

                    `left_mouse_down`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

                    `left_mouse_up`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerMiddleClickConfig> middleClick`

                    `middle_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerMouseMoveConfig> mouseMove`

                    `mouse_move`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerRightClickConfig> rightClick`

                    `right_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerScreenshotConfig> screenshot`

                    `screenshot`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerScrollConfig> scroll`

                    `scroll`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerTripleClickConfig> tripleClick`

                    `triple_click`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerWaitConfig> wait`

                    `wait`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                  - `Optional<BetaComputerZoomConfig> zoom`

                    `zoom`'s config overrides.

                    - `Optional<Boolean> deferLoading`

                      Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                    - `Optional<Boolean> enabled`

                      Whether this member is offered 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 BetaToolTextEditor20250124`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolTextEditor20250429`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolTextEditor20250728`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<List<InputExample>> inputExamples`

                - `Optional<Long> maxCharacters`

                  Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

                  minimum: 1

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaWebSearchTool20250305`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<List<String>> allowedDomains`

                  If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                - `Optional<List<String>> blockedDomains`

                  If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> maxUses`

                  Maximum number of times the tool can be used in the API request.

                  minimum: 1

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

                - `Optional<BetaUserLocation> userLocation`

                  Parameters for the user's location. Used to provide more relevant search results.

                  - `JsonValue type = "approximate"`

                  - `Optional<String> city`

                    The city of the user.

                    minLength: 1, maxLength: 255

                  - `Optional<String> 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<String> region`

                    The region of the user.

                    minLength: 1, maxLength: 255

                  - `Optional<String> timezone`

                    The [IANA timezone](https://nodatime.org/TimeZones) of the user.

                    minLength: 1, maxLength: 255

              - `class BetaWebFetchTool20250910`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<List<String>> allowedDomains`

                  List of domains to allow fetching from

                - `Optional<List<String>> blockedDomains`

                  List of domains to block fetching from

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<BetaCitationsConfigParam> citations`

                  Citations configuration for fetched documents. Citations are disabled by default.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> 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<Long> maxUses`

                  Maximum number of times the tool can be used in the API request.

                  minimum: 1

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

                - `Optional<BetaWebFetchUrlSources> urlSources`

                  Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                  - `Optional<ClientToolResults> clientToolResults`

                    Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

                    - `class BetaWebFetchUrlSourceAll`

                      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 BetaWebFetchUrlSourceNone`

                      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 BetaWebFetchUrlSourceOnly`

                      The tool filter variant under which only the named tools' results
                      contribute.

                      - `JsonValue type = "only"`

                      - `List<BetaWebFetchUrlSourceToolReference> tools`

                        - `JsonValue type = "tool_reference"`

                        - `String name`

                    - `class BetaWebFetchUrlSourceExcept`

                      The tool filter variant under which every result but the named
                      tools' contributes.

                      - `JsonValue type = "except"`

                      - `List<BetaWebFetchUrlSourceToolReference> tools`

                        - `JsonValue type = "tool_reference"`

                        - `String name`

                  - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

                      The `url_sources` variant under which a source contributes in
                      full: every result of the tool filter's source, or all user input.

                    - `class BetaWebFetchUrlSourceNone`

                      The `url_sources` variant under which a source contributes nothing:
                      no result of the tool filter's source, or no user input.

                    - `class BetaWebFetchUrlSourceOnly`

                      The tool filter variant under which only the named tools' results
                      contribute.

                    - `class BetaWebFetchUrlSourceExcept`

                      The tool filter variant under which every result but the named
                      tools' contributes.

                  - `Optional<UserInput> userInput`

                    Whether URLs in user messages are fetchable: "all" or "none".

                    - `class BetaWebFetchUrlSourceAll`

                      The `url_sources` variant under which a source contributes in
                      full: every result of the tool filter's source, or all user input.

                    - `class BetaWebFetchUrlSourceNone`

                      The `url_sources` variant under which a source contributes nothing:
                      no result of the tool filter's source, or no user input.

              - `class BetaWebSearchTool20260209`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<List<String>> allowedDomains`

                  If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                - `Optional<List<String>> blockedDomains`

                  If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> maxUses`

                  Maximum number of times the tool can be used in the API request.

                  minimum: 1

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

                - `Optional<BetaUserLocation> userLocation`

                  Parameters for the user's location. Used to provide more relevant search results.

              - `class BetaWebFetchTool20260209`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<List<String>> allowedDomains`

                  List of domains to allow fetching from

                - `Optional<List<String>> blockedDomains`

                  List of domains to block fetching from

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<BetaCitationsConfigParam> citations`

                  Citations configuration for fetched documents. Citations are disabled by default.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> 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<Long> maxUses`

                  Maximum number of times the tool can be used in the API request.

                  minimum: 1

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

                - `Optional<BetaWebFetchUrlSources> urlSources`

                  Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

              - `class BetaWebFetchTool20260309`

                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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<List<String>> allowedDomains`

                  List of domains to allow fetching from

                - `Optional<List<String>> blockedDomains`

                  List of domains to block fetching from

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<BetaCitationsConfigParam> citations`

                  Citations configuration for fetched documents. Citations are disabled by default.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> 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<Long> maxUses`

                  Maximum number of times the tool can be used in the API request.

                  minimum: 1

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

                - `Optional<BetaWebFetchUrlSources> urlSources`

                  Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                - `Optional<Boolean> 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 BetaWebSearchTool20260318`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<List<String>> allowedDomains`

                  If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                - `Optional<List<String>> blockedDomains`

                  If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> maxUses`

                  Maximum number of times the tool can be used in the API request.

                  minimum: 1

                - `Optional<ResponseInclusion> 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<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

                - `Optional<BetaUserLocation> userLocation`

                  Parameters for the user's location. Used to provide more relevant search results.

              - `class BetaWebFetchTool20260318`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<List<String>> allowedDomains`

                  List of domains to allow fetching from

                - `Optional<List<String>> blockedDomains`

                  List of domains to block fetching from

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<BetaCitationsConfigParam> citations`

                  Citations configuration for fetched documents. Citations are disabled by default.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> 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<Long> maxUses`

                  Maximum number of times the tool can be used in the API request.

                  minimum: 1

                - `Optional<ResponseInclusion> 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<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

                - `Optional<BetaWebFetchUrlSources> urlSources`

                  Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                - `Optional<Boolean> 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 BetaAdvisorTool20260301`

                - `JsonValue type = "advisor_20260301"`

                - `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 name = "advisor"`

                  Name of the tool.

                  This is how the tool will be called by the model and in `tool_use` blocks.

                - `Optional<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<BetaCacheControlEphemeral> caching`

                  Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Long> maxTokens`

                  Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

                  minimum: 1024

                - `Optional<Long> maxUses`

                  Maximum number of times the tool can be used in the API request.

                  minimum: 1

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaToolSearchToolRegex20251119`

                - `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<List<AllowedCaller>> allowedCallers`

                  - `DIRECT("direct")`

                  - `CODE_EXECUTION_20250825("code_execution_20250825")`

                  - `CODE_EXECUTION_20260120("code_execution_20260120")`

                  - `CODE_EXECUTION_20260521("code_execution_20260521")`

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Boolean> deferLoading`

                  If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                - `Optional<Boolean> strict`

                  When true, guarantees schema validation on tool names and inputs

              - `class BetaMcpToolset`

                Configuration for a group of tools from an MCP server.

                Allows configuring enabled status and defer_loading for all tools
                from an MCP server, with optional per-tool overrides.

                - `JsonValue type = "mcp_toolset"`

                - `String mcpServerName`

                  Name of the MCP server to configure tools for

                  minLength: 1, maxLength: 255

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<Configs> configs`

                  Configuration overrides for specific tools, keyed by tool name

                  - `Optional<Boolean> deferLoading`

                  - `Optional<Boolean> enabled`

                - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

                  Default configuration applied to all tools from this server

                  - `Optional<Boolean> deferLoading`

                  - `Optional<Boolean> enabled`

                - `Optional<List<BetaMcpToolParam>> tools`

                  The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

                  - `InputSchema inputSchema`

                    The tool's input schema as the MCP server lists it, verbatim.

                  - `String name`

                    The tool's name as the MCP server lists it (not prefixed with the server name).

                    minLength: 1

                  - `Optional<String> description`

                    The tool's description as the MCP server lists it.

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

      - `class BetaRequestToolRemovalBlock`

        Mid-conversation directive to withdraw a tool.

        `tool` references a tool (or MCP toolset) by name: one declared in the
        request's `tools` or defined earlier in `messages`. It is no longer
        offered to the model from this point in the conversation onward.

        - `JsonValue type = "tool_removal"`

        - `Tool tool`

          - `class BetaToolChangeToolReference`

            Reference to a single tool, by the name the model uses to call it: a
            tool declared in `tools` or defined by an earlier `tool_addition`
            block. Does not accept the composed `{server}_{name}` form the server
            assigns to MCP-resolved tools; use `mcp_tool_reference` or
            `mcp_toolset_reference` for those.

          - `class BetaToolChangeMcpToolReference`

            Reference to a single MCP tool by its server and remote name; the
            same `server_name`/`name` pair `mcp_tool_use` carries.

          - `class BetaToolChangeMcpToolsetReference`

            Reference to every tool in the named MCP server's toolset.

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

  - `class BetaRequestToolAdditionBlock`

    Mid-conversation directive to make a tool available.

    `tool` is a reference to a tool (or MCP toolset) declared in the
    request's `tools`. Under the `inline-tools-2026-09-15` beta it may
    instead be a reference to a tool defined earlier in `messages`, or a
    `tool_definition` object that carries an inline tool definition in
    `definition` (the same object a `tools` entry holds). An `mcp_toolset`
    definition also requires the `mcp-client-2026-09-15` beta. The tool is
    offered to the model from this point in the conversation onward.

  - `class BetaRequestToolRemovalBlock`

    Mid-conversation directive to withdraw a tool.

    `tool` references a tool (or MCP toolset) by name: one declared in the
    request's `tools` or defined earlier in `messages`. It is no longer
    offered to the model from this point in the conversation onward.

  - `class BetaMcpToolListingBlockParam`

    The tool listing an MCP server returned while an earlier response was
    produced, as that response carried it. Send the assistant message back
    unchanged, this block included, and the server uses this listing for the
    matching `mcp_toolset` instead of asking the MCP server again.

    - `JsonValue type = "mcp_tool_listing"`

    - `String mcpServerName`

      The name of the MCP server this listing came from, as `mcp_servers` declares it.

      minLength: 1, maxLength: 255

    - `List<BetaMcpToolParam> tools`

      The server's tools, exactly as the response listed them.

      - `InputSchema inputSchema`

        The tool's input schema as the MCP server lists it, verbatim.

      - `String name`

        The tool's name as the MCP server lists it (not prefixed with the server name).

        minLength: 1

      - `Optional<String> description`

        The tool's description as the MCP server lists it.

  - `class BetaFallbackBlockParam`

    A `fallback` block echoed back from a prior response.

    Accepted in `messages[].content` and not rendered into the prompt; not
    validated against the request's `fallbacks` chain or top-level `model`.

    Echo the assistant turn back verbatim, including this block in its
    original position. The block marks the boundary between content produced
    before and after a fallback hop, and the server relies on that boundary
    to validate the turn: when thinking runs flank the boundary, omitting
    the block merges them into one span the server cannot validate (the
    request is rejected), and moving it into the middle of a single run is
    likewise rejected; between non-thinking blocks the block's placement has
    no validation effect.

    - `JsonValue type = "fallback"`

    - `BetaFallbackInfoParam from`

      Identifies one hop of a fallback transition.

      - `Model model`

        The model that will complete your prompt.

        See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

    - `BetaFallbackInfoParam to`

      Identifies one hop of a fallback transition.

    - `Optional<JsonValue> trigger`

      The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed.

### Beta Content Block Source

- `class BetaContentBlockSource`

  - `JsonValue type = "content"`

  - `Content content`

    - `String`

    - `List<BetaContentBlockSourceContent>`

      - `class BetaTextBlockParam`

        - `JsonValue type = "text"`

        - `String text`

          minLength: 1

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

          - `JsonValue type = "ephemeral"`

          - `Optional<Ttl> 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<List<BetaTextCitationParam>> citations`

          - `class BetaCitationCharLocationParam`

            - `JsonValue type = "char_location"`

            - `String citedText`

            - `long documentIndex`

              minimum: 0

            - `Optional<String> documentTitle`

              minLength: 1, maxLength: 500

            - `long endCharIndex`

            - `long startCharIndex`

              minimum: 0

          - `class BetaCitationPageLocationParam`

            - `JsonValue type = "page_location"`

            - `String citedText`

            - `long documentIndex`

              minimum: 0

            - `Optional<String> documentTitle`

              minLength: 1, maxLength: 500

            - `long endPageNumber`

            - `long startPageNumber`

              minimum: 1

          - `class BetaCitationContentBlockLocationParam`

            - `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<String> 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 BetaCitationWebSearchResultLocationParam`

            - `JsonValue type = "web_search_result_location"`

            - `String citedText`

            - `String encryptedIndex`

            - `Optional<String> title`

              minLength: 1, maxLength: 512

            - `String url`

              minLength: 1

          - `class BetaCitationSearchResultLocationParam`

            - `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<String> title`

      - `class BetaImageBlockParam`

        - `JsonValue type = "image"`

        - `Source source`

          - `class BetaBase64ImageSource`

            - `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 BetaUrlImageSource`

            - `JsonValue type = "url"`

            - `String url`

          - `class BetaFileImageSource`

            - `JsonValue type = "file"`

            - `String fileId`

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<BetaImageTransformationsParam> 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> 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")`

### Beta Content Block Source Content

- `class BetaContentBlockSourceContent: union`

  - `class BetaTextBlockParam`

    - `JsonValue type = "text"`

    - `String text`

      minLength: 1

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

      - `JsonValue type = "ephemeral"`

      - `Optional<Ttl> 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<List<BetaTextCitationParam>> citations`

      - `class BetaCitationCharLocationParam`

        - `JsonValue type = "char_location"`

        - `String citedText`

        - `long documentIndex`

          minimum: 0

        - `Optional<String> documentTitle`

          minLength: 1, maxLength: 500

        - `long endCharIndex`

        - `long startCharIndex`

          minimum: 0

      - `class BetaCitationPageLocationParam`

        - `JsonValue type = "page_location"`

        - `String citedText`

        - `long documentIndex`

          minimum: 0

        - `Optional<String> documentTitle`

          minLength: 1, maxLength: 500

        - `long endPageNumber`

        - `long startPageNumber`

          minimum: 1

      - `class BetaCitationContentBlockLocationParam`

        - `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<String> 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 BetaCitationWebSearchResultLocationParam`

        - `JsonValue type = "web_search_result_location"`

        - `String citedText`

        - `String encryptedIndex`

        - `Optional<String> title`

          minLength: 1, maxLength: 512

        - `String url`

          minLength: 1

      - `class BetaCitationSearchResultLocationParam`

        - `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<String> title`

  - `class BetaImageBlockParam`

    - `JsonValue type = "image"`

    - `Source source`

      - `class BetaBase64ImageSource`

        - `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 BetaUrlImageSource`

        - `JsonValue type = "url"`

        - `String url`

      - `class BetaFileImageSource`

        - `JsonValue type = "file"`

        - `String fileId`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaImageTransformationsParam> 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> 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")`

### Beta Context Management Config

- `class BetaContextManagementConfig`

  - `Optional<List<Edit>> edits`

    List of context management edits to apply

    - `class BetaClearToolUses20250919Edit`

      - `JsonValue type = "clear_tool_uses_20250919"`

      - `Optional<BetaInputTokensClearAtLeast> clearAtLeast`

        Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.

        - `JsonValue type = "input_tokens"`

        - `long value`

          minimum: 0

      - `Optional<ClearToolInputs> clearToolInputs`

        Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)

        - `boolean`

        - `List<String>`

      - `Optional<List<String>> excludeTools`

        Tool names whose uses are preserved from clearing

      - `Optional<BetaToolUsesKeep> keep`

        Number of tool uses to retain in the conversation

        - `JsonValue type = "tool_uses"`

        - `long value`

          minimum: 0

      - `Optional<Trigger> trigger`

        Condition that triggers the context management strategy

        - `class BetaInputTokensTrigger`

          - `JsonValue type = "input_tokens"`

          - `long value`

            minimum: 1

        - `class BetaToolUsesTrigger`

          - `JsonValue type = "tool_uses"`

          - `long value`

            minimum: 1

    - `class BetaClearThinking20251015Edit`

      - `JsonValue type = "clear_thinking_20251015"`

      - `Optional<Keep> keep`

        Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.

        - `class BetaThinkingTurns`

          - `JsonValue type = "thinking_turns"`

          - `long value`

            minimum: 1

        - `class BetaAllThinkingTurns`

          - `JsonValue type = "all"`

        - `JsonValue`

    - `class BetaCompact20260112Edit`

      Automatically compact older context when reaching the configured trigger threshold.

      - `JsonValue type = "compact_20260112"`

      - `Optional<String> instructions`

        Additional instructions for summarization.

      - `Optional<Boolean> pauseAfterCompaction`

        Whether to pause after compaction and return the compaction block to the user.

      - `Optional<BetaInputTokensTrigger> trigger`

        When to trigger compaction. Defaults to 150000 input tokens.

### Beta Context Management Response

- `class BetaContextManagementResponse`

  - `List<AppliedEdit> appliedEdits`

    List of context management edits that were applied.

    - `class BetaClearToolUses20250919EditResponse`

      - `JsonValue type = "clear_tool_uses_20250919"`

        The type of context management edit applied.

      - `long clearedInputTokens`

        Number of input tokens cleared by this edit.

        minimum: 0

      - `long clearedToolUses`

        Number of tool uses that were cleared.

        minimum: 0

    - `class BetaClearThinking20251015EditResponse`

      - `JsonValue type = "clear_thinking_20251015"`

        The type of context management edit applied.

      - `long clearedInputTokens`

        Number of input tokens cleared by this edit.

        minimum: 0

      - `long clearedThinkingTurns`

        Number of thinking turns that were cleared.

        minimum: 0

### Beta Count Tokens Context Management Response

- `class BetaCountTokensContextManagementResponse`

  - `long originalInputTokens`

    The original token count before context management was applied

### Beta Diagnostics

- `class BetaDiagnostics`

  Request-level diagnostics: why the prompt cache could not fully reuse
  the prefix of the request named by `diagnostics.previous_message_id`.

  - `Optional<BetaCacheMissReason> 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 BetaCacheMissModelChanged`

      - `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 BetaCacheMissSystemChanged`

      - `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 BetaCacheMissToolsChanged`

      - `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 BetaCacheMissMessagesChanged`

      - `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 BetaCacheMissPreviousMessageNotFound`

      - `JsonValue type = "previous_message_not_found"`

    - `class BetaCacheMissUnavailable`

      - `JsonValue type = "unavailable"`

### Beta Diagnostics Param

- `class BetaDiagnosticsParam`

  Request-level diagnostics. Currently carries the previous response
  id for prompt-cache divergence reporting.

  - `Optional<String> 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

### Beta Direct Caller

- `class BetaDirectCaller`

  Tool invocation directly from the model.

  - `JsonValue type = "direct"`

### Beta Document Block

- `class BetaDocumentBlock`

  - `JsonValue type = "document"`

  - `Optional<BetaCitationConfig> citations`

    Citation configuration for the document

    - `boolean enabled`

  - `Source source`

    - `class BetaBase64PdfSource`

      - `JsonValue type = "base64"`

      - `String data`

        format: byte

      - `JsonValue mediaType = "application/pdf"`

    - `class BetaPlainTextSource`

      - `JsonValue type = "text"`

      - `String data`

      - `JsonValue mediaType = "text/plain"`

  - `Optional<String> title`

    The title of the document

### Beta Encrypted Code Execution Result Block

- `class BetaEncryptedCodeExecutionResultBlock`

  Code execution result with encrypted stdout for PFC + web_search results.

  - `JsonValue type = "encrypted_code_execution_result"`

  - `List<BetaCodeExecutionOutputBlock> content`

    - `JsonValue type = "code_execution_output"`

    - `String fileId`

  - `String encryptedStdout`

  - `long returnCode`

  - `String stderr`

### Beta Encrypted Code Execution Result Block Param

- `class BetaEncryptedCodeExecutionResultBlockParam`

  Code execution result with encrypted stdout for PFC + web_search results.

  - `JsonValue type = "encrypted_code_execution_result"`

  - `List<BetaCodeExecutionOutputBlockParam> content`

    - `JsonValue type = "code_execution_output"`

    - `String fileId`

  - `String encryptedStdout`

  - `long returnCode`

  - `String stderr`

### Beta Fallback Block

- `class BetaFallbackBlock`

  Marks the point in `content` where one model's output gives way to the next.

  One block appears per hop where a preceding model actually ran this turn and
  declined. A turn where no preceding model ran and declined has no such
  boundary and carries no block — the signal for whether a fallback model
  served the response is the presence of a `fallback_message` entry in
  `usage.iterations`, not this block.

  The block is treated like a server-tool content block for streaming: it
  arrives via the standard `content_block_start` / `content_block_stop`
  pair and carries no deltas.

  - `JsonValue type = "fallback"`

  - `BetaFallbackInfo from`

    The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id.

    - `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

  - `BetaFallbackInfo to`

    The fallback model producing the content that follows this block. Its `model` is always the canonical id.

  - `BetaFallbackRefusalTrigger trigger`

    What caused the `from` model to hand over at this hop.

    - `JsonValue type = "refusal"`

    - `Optional<Category> category`

      The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.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.

### Beta Fallback Block Param

- `class BetaFallbackBlockParam`

  A `fallback` block echoed back from a prior response.

  Accepted in `messages[].content` and not rendered into the prompt; not
  validated against the request's `fallbacks` chain or top-level `model`.

  Echo the assistant turn back verbatim, including this block in its
  original position. The block marks the boundary between content produced
  before and after a fallback hop, and the server relies on that boundary
  to validate the turn: when thinking runs flank the boundary, omitting
  the block merges them into one span the server cannot validate (the
  request is rejected), and moving it into the middle of a single run is
  likewise rejected; between non-thinking blocks the block's placement has
  no validation effect.

  - `JsonValue type = "fallback"`

  - `BetaFallbackInfoParam from`

    Identifies one hop of a fallback transition.

    - `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

  - `BetaFallbackInfoParam to`

    Identifies one hop of a fallback transition.

  - `Optional<JsonValue> trigger`

    The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed.

### Beta Fallback Credit Not Applied

- `class BetaFallbackCreditNotApplied`

  No reprice was applied; `reason` says why.

  - `JsonValue type = "not_applied"`

  - `Reason reason`

    Why the reprice was not applied.

    A closed enum; additions to the redemption-check vocabulary arrive as
    deliberate schema updates.

    - `BODY_MISMATCH("body_mismatch")`

    - `CONTINUATION_EXCLUDED("continuation_excluded")`

    - `CONTINUATION_ONLY("continuation_only")`

    - `EXPIRED("expired")`

    - `INVALID_TARGET_MODEL("invalid_target_model")`

    - `NOT_ENABLED("not_enabled")`

    - `REPRICE_UNAVAILABLE("reprice_unavailable")`

    - `TEMPORARILY_UNAVAILABLE("temporarily_unavailable")`

    - `VARIANT_FIELDS_PRESENT("variant_fields_present")`

    - `WRONG_ORGANIZATION("wrong_organization")`

    - `WRONG_PLATFORM("wrong_platform")`

    - `WRONG_WORKSPACE("wrong_workspace")`

  - `Optional<List<String>> removeToRedeem`

    Request fields to remove before retrying, so the retry can redeem this
    token.

    Present exactly when `reason` is `variant_fields_present` — never null,
    never an empty array; absent otherwise. Fields are named only from your own request, and only after
    the sealed variant hash matched. A served best-effort retry has already
    been billed at normal price; nothing redeems retroactively, but a corrected
    re-send inside the token's five-minute window can still redeem.

### Beta Fallback Credit Redeemed

- `class BetaFallbackCreditRedeemed`

  The reprice was applied: the retry is billed as if the conversation
  had been on the retry model all along.

  - `JsonValue type = "redeemed"`

### Beta Fallback Credit Token Param

- `class BetaFallbackCreditTokenParam`

  Object form of `fallback_credit_token`: the token plus a redemption
  mode.

  Requires `anthropic-beta: fallback-credit-2026-07-01`; without that
  header the field accepts the bare string only. The bare string and the
  mode-less object are equivalent (both select `strict`), so wrapping
  an existing token changes nothing by itself.

  - `String token`

    The opaque `fallback_credit_token` from a prior refusal's `stop_details` — the same string the bare-string form carries.

    minLength: 1, maxLength: 2048

  - `Optional<Mode> mode`

    How a failing token affects the retry. `strict` (the default, and the bare-string behavior): a failing redemption is a 400 and the retry is not served. `best_effort`: the retry is served either way — a token-layer failure no longer rejects the request; the retry proceeds at normal price and the outcome is reported on the response's `usage.fallback_credit`. Two failures stay hard in both modes: a malformed token, and combining `fallback_credit_token` with `fallbacks`.

    - `STRICT("strict")`

    - `BEST_EFFORT("best_effort")`

### Beta Fallback Credit Usage

- `class BetaFallbackCreditUsage`

  Outcome of the `fallback_credit_token` presented on this request.

  - `Status status`

    Whether the fallback-credit reprice was applied to this response's billing.

    A union discriminated on `type`. `redeemed`: the retry is billed as if
    the conversation had been on the retry model all along — including when the
    resulting shift is zero because there was nothing to move. `not_applied`:
    no reprice was applied; the arm's `reason` says why.

    - `class BetaFallbackCreditRedeemed`

      The reprice was applied: the retry is billed as if the conversation
      had been on the retry model all along.

      - `JsonValue type = "redeemed"`

    - `class BetaFallbackCreditNotApplied`

      No reprice was applied; `reason` says why.

      - `JsonValue type = "not_applied"`

      - `Reason reason`

        Why the reprice was not applied.

        A closed enum; additions to the redemption-check vocabulary arrive as
        deliberate schema updates.

        - `BODY_MISMATCH("body_mismatch")`

        - `CONTINUATION_EXCLUDED("continuation_excluded")`

        - `CONTINUATION_ONLY("continuation_only")`

        - `EXPIRED("expired")`

        - `INVALID_TARGET_MODEL("invalid_target_model")`

        - `NOT_ENABLED("not_enabled")`

        - `REPRICE_UNAVAILABLE("reprice_unavailable")`

        - `TEMPORARILY_UNAVAILABLE("temporarily_unavailable")`

        - `VARIANT_FIELDS_PRESENT("variant_fields_present")`

        - `WRONG_ORGANIZATION("wrong_organization")`

        - `WRONG_PLATFORM("wrong_platform")`

        - `WRONG_WORKSPACE("wrong_workspace")`

      - `Optional<List<String>> removeToRedeem`

        Request fields to remove before retrying, so the retry can redeem this
        token.

        Present exactly when `reason` is `variant_fields_present` — never null,
        never an empty array; absent otherwise. Fields are named only from your own request, and only after
        the sealed variant hash matched. A served best-effort retry has already
        been billed at normal price; nothing redeems retroactively, but a corrected
        re-send inside the token's five-minute window can still redeem.

### Beta Fallback Info

- `class BetaFallbackInfo`

  Identifies one hop of a fallback transition.

  - `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

### Beta Fallback Info Param

- `class BetaFallbackInfoParam`

  Identifies one hop of a fallback transition.

  - `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

### Beta Fallback Message Iteration Usage

- `class BetaFallbackMessageIterationUsage`

  Token usage for the fallback-model attempt of a server-side fallback request.

  The terminal entry of a fallback-served turn: when a fallback hop's
  output is the returned message, the entry for the iteration that
  completed it carries this type in place of `message`. A declined hop
  and the serving hop's earlier tool-loop iterations produce `message`
  entries. Whether a fallback model served the response is signalled by
  the presence of this entry in `usage.iterations`.

  - `JsonValue type = "fallback_message"`

    Usage for the fallback-model attempt that served the response

  - `Optional<BetaCacheCreation> 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

  - `long cacheCreationInputTokens`

    The number of input tokens used to create the cache entry.

    minimum: 0

  - `long cacheReadInputTokens`

    The number of input tokens read from the cache.

    minimum: 0

  - `long inputTokens`

    The number of input tokens which were used.

    minimum: 0

  - `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

  - `long outputTokens`

    The number of output tokens which were used.

    minimum: 0

### Beta Fallback Param

- `class BetaFallbackParam`

  One entry in the `fallbacks` chain on a `/v1/messages` request.

  `model` is required. The override fields (`max_tokens`, `thinking`,
  `output_config`, and `speed`) set the corresponding parameter for this
  attempt only and are validated as if the request were made to `model`.
  Any other key is rejected at parse time.

  - `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<Long> maxTokens`

  - `Optional<BetaOutputConfig> outputConfig`

    - `Optional<Effort> 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<BetaJsonOutputFormat> 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<BetaTokenTaskBudget> taskBudget`

      Configuration for token budget tracking across contexts.

      - `JsonValue type = "tokens"`

        The budget type. Currently only 'tokens' is supported.

      - `long total`

        Total token budget across all contexts in the session.

        minimum: 1024

      - `Optional<Long> remaining`

        Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided.

        minimum: 0

  - `Optional<Speed> speed`

    Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.

    - `STANDARD("standard")`

    - `FAST("fast")`

  - `Optional<Thinking> thinking`

    - `class BetaThinkingConfigEnabled`

      - `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<BetaThinkingBlockBinding> blockBinding`

        Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.

        - `Optional<BetaThinkingPrefixMismatchBehavior> prefixMismatchBehavior`

          "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`.

          - `ERROR("error")`

          - `DROP_BLOCK("drop_block")`

      - `Optional<Display> 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")`

        - `UPDATES("updates")`

    - `class BetaThinkingConfigDisabled`

      - `JsonValue type = "disabled"`

    - `class BetaThinkingConfigBetweenTools`

      - `JsonValue type = "between_tools"`

    - `class BetaThinkingConfigAdaptive`

      - `JsonValue type = "adaptive"`

      - `Optional<BetaThinkingBlockBinding> blockBinding`

        Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.

      - `Optional<Display> 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")`

        - `UPDATES("updates")`

### Beta Fallback Refusal Trigger

- `class BetaFallbackRefusalTrigger`

  The `from` model declined for policy reasons.

  - `JsonValue type = "refusal"`

  - `Optional<Category> category`

    The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.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.

### Beta Fallbacks Param

- `class BetaFallbacksParam: union`

  Opt-in server-side retry on one or more substitute models when the requested model declines for policy reasons. Tried in order: if the first entry also declines, the second is tried, and so on. Some models don't support fallbacks; on those models, a list of fallback models returns a 400 error. See [Server-side fallback](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=java#server-side-fallback). The string "default" requests the requested model's server-defined default fallback configuration. On a model that doesn't support fallbacks, the request runs on the requested model alone, so a declined request stays declined.

  - `List<BetaFallbackParam>`

    - `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<Long> maxTokens`

    - `Optional<BetaOutputConfig> outputConfig`

      - `Optional<Effort> 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<BetaJsonOutputFormat> 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<BetaTokenTaskBudget> taskBudget`

        Configuration for token budget tracking across contexts.

        - `JsonValue type = "tokens"`

          The budget type. Currently only 'tokens' is supported.

        - `long total`

          Total token budget across all contexts in the session.

          minimum: 1024

        - `Optional<Long> remaining`

          Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided.

          minimum: 0

    - `Optional<Speed> speed`

      Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.

      - `STANDARD("standard")`

      - `FAST("fast")`

    - `Optional<Thinking> thinking`

      - `class BetaThinkingConfigEnabled`

        - `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<BetaThinkingBlockBinding> blockBinding`

          Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.

          - `Optional<BetaThinkingPrefixMismatchBehavior> prefixMismatchBehavior`

            "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`.

            - `ERROR("error")`

            - `DROP_BLOCK("drop_block")`

        - `Optional<Display> 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")`

          - `UPDATES("updates")`

      - `class BetaThinkingConfigDisabled`

        - `JsonValue type = "disabled"`

      - `class BetaThinkingConfigBetweenTools`

        - `JsonValue type = "between_tools"`

      - `class BetaThinkingConfigAdaptive`

        - `JsonValue type = "adaptive"`

        - `Optional<BetaThinkingBlockBinding> blockBinding`

          Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.

        - `Optional<Display> 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")`

          - `UPDATES("updates")`

  - `JsonValue`

### Beta File Document Source

- `class BetaFileDocumentSource`

  - `JsonValue type = "file"`

  - `String fileId`

### Beta File Image Source

- `class BetaFileImageSource`

  - `JsonValue type = "file"`

  - `String fileId`

### Beta Image Block Param

- `class BetaImageBlockParam`

  - `JsonValue type = "image"`

  - `Source source`

    - `class BetaBase64ImageSource`

      - `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 BetaUrlImageSource`

      - `JsonValue type = "url"`

      - `String url`

    - `class BetaFileImageSource`

      - `JsonValue type = "file"`

      - `String fileId`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<BetaImageTransformationsParam> 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> 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")`

### Beta Image Transformations Param

- `class BetaImageTransformationsParam`

  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> 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")`

### Beta Input JSON Delta

- `class BetaInputJsonDelta`

  - `JsonValue type = "input_json_delta"`

  - `String partialJson`

### Beta Input Tokens Clear At Least

- `class BetaInputTokensClearAtLeast`

  - `JsonValue type = "input_tokens"`

  - `long value`

    minimum: 0

### Beta Input Tokens Trigger

- `class BetaInputTokensTrigger`

  - `JsonValue type = "input_tokens"`

  - `long value`

    minimum: 1

### Beta Input Transformation

- `class BetaInputTransformation: union`

  One entry of `input_transformations`: either a change the API made to the
  request's input before showing it to the model, or a block that failed a
  binding check and was still shown to the model unchanged. The `type` field
  says which.

  - `class BetaThinkingDroppedInputTransformation`

    - `JsonValue type = "thinking_dropped"`

      Always `thinking_dropped` for this entry type.

    - `String path`

      Where the removed block was in your request, as `messages.{i}.content.{j}`:
      `i` indexes the `messages` array you sent and `j` that message's `content`
      array — the same form error messages use.

    - `Reason reason`

      Which binding check removed the block: `model_binding_mismatch` — it was
      created by a model whose reasoning the requested model may not read;
      `prefix_binding_mismatch` — the conversation before it differs from the
      conversation it was created in (the rest of that turn's consecutive thinking
      blocks are removed with it, each with this reason);
      `organization_binding_mismatch` — it was created under a different
      organization (an Anthropic organization, AWS account or Google Cloud project)
      and this organization is not one of its additional organizations;
      `end_user_binding_mismatch` — it was created for a different end user, or
      was removed by the consumer-organization binding. A block that would fail
      several checks reports one reason, in this order of precedence:
      `organization_binding_mismatch`, `end_user_binding_mismatch`,
      `model_binding_mismatch`, `prefix_binding_mismatch`.

      - `MODEL_BINDING_MISMATCH("model_binding_mismatch")`

      - `PREFIX_BINDING_MISMATCH("prefix_binding_mismatch")`

      - `ORGANIZATION_BINDING_MISMATCH("organization_binding_mismatch")`

      - `END_USER_BINDING_MISMATCH("end_user_binding_mismatch")`

  - `class BetaThinkingMismatchAllowedInputTransformation`

    - `JsonValue type = "thinking_mismatch_allowed"`

      Always `thinking_mismatch_allowed` for this entry type.

    - `String path`

      Where the block is in your request, as `messages.{i}.content.{j}`:
      `i` indexes the `messages` array you sent and `j` that message's `content`
      array — the same form error messages use.

    - `Reason reason`

      Which binding check the block failed; the block was shown to the model all
      the same. Always `prefix_binding_mismatch` today — the conversation before
      the block differs from the conversation it was created in, or the block
      carries no record of one on a model that requires it. Were the check
      enforced for this request, the block would have been removed or the request
      rejected (`thinking.block_binding.prefix_mismatch_behavior`). A removal also
      takes the rest of that turn's consecutive thinking blocks, whereas here each
      block is checked on its own, so `thinking_mismatch_allowed` entries are a
      lower bound on what enforcement would remove.

      - `MODEL_BINDING_MISMATCH("model_binding_mismatch")`

      - `PREFIX_BINDING_MISMATCH("prefix_binding_mismatch")`

      - `ORGANIZATION_BINDING_MISMATCH("organization_binding_mismatch")`

      - `END_USER_BINDING_MISMATCH("end_user_binding_mismatch")`

### Beta JSON Output Format

- `class BetaJsonOutputFormat`

  - `JsonValue type = "json_schema"`

  - `Schema schema`

    The JSON schema of the format

### Beta MCP Tool

- `class BetaMcpTool`

  A tool as an MCP server lists it: its name on that server, its
  description, and its input schema.

  - `InputSchema inputSchema`

  - `String name`

  - `Optional<String> description`

### Beta MCP Tool Config

- `class BetaMcpToolConfig`

  Configuration for a specific tool in an MCP toolset.

  - `Optional<Boolean> deferLoading`

  - `Optional<Boolean> enabled`

### Beta MCP Tool Default Config

- `class BetaMcpToolDefaultConfig`

  Default configuration for tools in an MCP toolset.

  - `Optional<Boolean> deferLoading`

  - `Optional<Boolean> enabled`

### Beta MCP Tool Listing Block

- `class BetaMcpToolListingBlock`

  The tool listing the server fetched from an MCP server while producing
  this response. Send the assistant message back unchanged, this block
  included, so later requests use this listing instead of asking the MCP
  server again.

  - `JsonValue type = "mcp_tool_listing"`

  - `String mcpServerName`

  - `List<BetaMcpTool> tools`

    - `InputSchema inputSchema`

    - `String name`

    - `Optional<String> description`

### Beta MCP Tool Listing Block Param

- `class BetaMcpToolListingBlockParam`

  The tool listing an MCP server returned while an earlier response was
  produced, as that response carried it. Send the assistant message back
  unchanged, this block included, and the server uses this listing for the
  matching `mcp_toolset` instead of asking the MCP server again.

  - `JsonValue type = "mcp_tool_listing"`

  - `String mcpServerName`

    The name of the MCP server this listing came from, as `mcp_servers` declares it.

    minLength: 1, maxLength: 255

  - `List<BetaMcpToolParam> tools`

    The server's tools, exactly as the response listed them.

    - `InputSchema inputSchema`

      The tool's input schema as the MCP server lists it, verbatim.

    - `String name`

      The tool's name as the MCP server lists it (not prefixed with the server name).

      minLength: 1

    - `Optional<String> description`

      The tool's description as the MCP server lists it.

### Beta MCP Tool Param

- `class BetaMcpToolParam`

  A tool as an MCP server lists it: its name on that server, its
  description, and its input schema.

  - `InputSchema inputSchema`

    The tool's input schema as the MCP server lists it, verbatim.

  - `String name`

    The tool's name as the MCP server lists it (not prefixed with the server name).

    minLength: 1

  - `Optional<String> description`

    The tool's description as the MCP server lists it.

### Beta MCP Tool Result Block

- `class BetaMcpToolResultBlock`

  - `JsonValue type = "mcp_tool_result"`

  - `Content content`

    - `String`

    - `List<BetaTextBlock>`

      - `JsonValue type = "text"`

      - `Optional<List<BetaTextCitation>> 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 BetaCitationCharLocation`

          - `JsonValue type = "char_location"`

          - `String citedText`

          - `long documentIndex`

            minimum: 0

          - `Optional<String> documentTitle`

          - `long endCharIndex`

          - `Optional<String> fileId`

          - `long startCharIndex`

            minimum: 0

        - `class BetaCitationPageLocation`

          - `JsonValue type = "page_location"`

          - `String citedText`

          - `long documentIndex`

            minimum: 0

          - `Optional<String> documentTitle`

          - `long endPageNumber`

          - `Optional<String> fileId`

          - `long startPageNumber`

            minimum: 1

        - `class BetaCitationContentBlockLocation`

          - `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<String> 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<String> fileId`

          - `long startBlockIndex`

            0-based index of the first cited block in the source's `content` array.

            minimum: 0

        - `class BetaCitationsWebSearchResultLocation`

          - `JsonValue type = "web_search_result_location"`

          - `String citedText`

          - `String encryptedIndex`

          - `Optional<String> title`

            maxLength: 512

          - `String url`

        - `class BetaCitationSearchResultLocation`

          - `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<String> title`

      - `String text`

  - `boolean isError`

  - `String toolUseId`

    pattern: ^[a-zA-Z0-9_-]+$

### Beta MCP Tool Use Block

- `class BetaMcpToolUseBlock`

  - `JsonValue type = "mcp_tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `Input input`

  - `String name`

    The name of the MCP tool

  - `String serverName`

    The name of the MCP server

### Beta MCP Tool Use Block Param

- `class BetaMcpToolUseBlockParam`

  - `JsonValue type = "mcp_tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `Input input`

  - `String name`

  - `String serverName`

    The name of the MCP server

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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")`

### Beta MCP Toolset

- `class BetaMcpToolset`

  Configuration for a group of tools from an MCP server.

  Allows configuring enabled status and defer_loading for all tools
  from an MCP server, with optional per-tool overrides.

  - `JsonValue type = "mcp_toolset"`

  - `String mcpServerName`

    Name of the MCP server to configure tools for

    minLength: 1, maxLength: 255

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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> configs`

    Configuration overrides for specific tools, keyed by tool name

    - `Optional<Boolean> deferLoading`

    - `Optional<Boolean> enabled`

  - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

    Default configuration applied to all tools from this server

    - `Optional<Boolean> deferLoading`

    - `Optional<Boolean> enabled`

  - `Optional<List<BetaMcpToolParam>> tools`

    The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

    - `InputSchema inputSchema`

      The tool's input schema as the MCP server lists it, verbatim.

    - `String name`

      The tool's name as the MCP server lists it (not prefixed with the server name).

      minLength: 1

    - `Optional<String> description`

      The tool's description as the MCP server lists it.

### Beta Memory Tool 20250818

- `class BetaMemoryTool20250818`

  - `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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<List<InputExample>> inputExamples`

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Memory Tool 20250818 Command

- `class BetaMemoryTool20250818Command: union`

  - `class BetaMemoryTool20250818ViewCommand`

    - `JsonValue command = "view"`

      Command type identifier

    - `String path`

      Path to directory or file to view

    - `Optional<List<Long>> viewRange`

      Optional line range for viewing specific lines

      minItems: 2, maxItems: 2

  - `class BetaMemoryTool20250818CreateCommand`

    - `JsonValue command = "create"`

      Command type identifier

    - `String fileText`

      Content to write to the file

    - `String path`

      Path where the file should be created

  - `class BetaMemoryTool20250818StrReplaceCommand`

    - `JsonValue command = "str_replace"`

      Command type identifier

    - `String newStr`

      Text to replace with

    - `String oldStr`

      Text to search for and replace

    - `String path`

      Path to the file where text should be replaced

  - `class BetaMemoryTool20250818InsertCommand`

    - `JsonValue command = "insert"`

      Command type identifier

    - `long insertLine`

      Line number where text should be inserted

      minimum: 1

    - `String insertText`

      Text to insert at the specified line

    - `String path`

      Path to the file where text should be inserted

  - `class BetaMemoryTool20250818DeleteCommand`

    - `JsonValue command = "delete"`

      Command type identifier

    - `String path`

      Path to the file or directory to delete

  - `class BetaMemoryTool20250818RenameCommand`

    - `JsonValue command = "rename"`

      Command type identifier

    - `String newPath`

      New path for the file or directory

    - `String oldPath`

      Current path of the file or directory

### Beta Memory Tool 20250818 Create Command

- `class BetaMemoryTool20250818CreateCommand`

  - `JsonValue command = "create"`

    Command type identifier

  - `String fileText`

    Content to write to the file

  - `String path`

    Path where the file should be created

### Beta Memory Tool 20250818 Delete Command

- `class BetaMemoryTool20250818DeleteCommand`

  - `JsonValue command = "delete"`

    Command type identifier

  - `String path`

    Path to the file or directory to delete

### Beta Memory Tool 20250818 Insert Command

- `class BetaMemoryTool20250818InsertCommand`

  - `JsonValue command = "insert"`

    Command type identifier

  - `long insertLine`

    Line number where text should be inserted

    minimum: 1

  - `String insertText`

    Text to insert at the specified line

  - `String path`

    Path to the file where text should be inserted

### Beta Memory Tool 20250818 Rename Command

- `class BetaMemoryTool20250818RenameCommand`

  - `JsonValue command = "rename"`

    Command type identifier

  - `String newPath`

    New path for the file or directory

  - `String oldPath`

    Current path of the file or directory

### Beta Memory Tool 20250818 Str Replace Command

- `class BetaMemoryTool20250818StrReplaceCommand`

  - `JsonValue command = "str_replace"`

    Command type identifier

  - `String newStr`

    Text to replace with

  - `String oldStr`

    Text to search for and replace

  - `String path`

    Path to the file where text should be replaced

### Beta Memory Tool 20250818 View Command

- `class BetaMemoryTool20250818ViewCommand`

  - `JsonValue command = "view"`

    Command type identifier

  - `String path`

    Path to directory or file to view

  - `Optional<List<Long>> viewRange`

    Optional line range for viewing specific lines

    minItems: 2, maxItems: 2

### Beta Message

- `class BetaMessage`

  - `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<BetaContainer> 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<List<BetaContainerSkill>> 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<BetaContentBlock> 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 BetaTextBlock`

      - `JsonValue type = "text"`

      - `Optional<List<BetaTextCitation>> 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 BetaCitationCharLocation`

          - `JsonValue type = "char_location"`

          - `String citedText`

          - `long documentIndex`

            minimum: 0

          - `Optional<String> documentTitle`

          - `long endCharIndex`

          - `Optional<String> fileId`

          - `long startCharIndex`

            minimum: 0

        - `class BetaCitationPageLocation`

          - `JsonValue type = "page_location"`

          - `String citedText`

          - `long documentIndex`

            minimum: 0

          - `Optional<String> documentTitle`

          - `long endPageNumber`

          - `Optional<String> fileId`

          - `long startPageNumber`

            minimum: 1

        - `class BetaCitationContentBlockLocation`

          - `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<String> 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<String> fileId`

          - `long startBlockIndex`

            0-based index of the first cited block in the source's `content` array.

            minimum: 0

        - `class BetaCitationsWebSearchResultLocation`

          - `JsonValue type = "web_search_result_location"`

          - `String citedText`

          - `String encryptedIndex`

          - `Optional<String> title`

            maxLength: 512

          - `String url`

        - `class BetaCitationSearchResultLocation`

          - `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<String> title`

      - `String text`

    - `class BetaThinkingBlock`

      - `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 BetaRedactedThinkingBlock`

      - `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 BetaToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `Input input`

      - `String name`

        minLength: 1

      - `Optional<Caller> caller`

        - `class BetaDirectCaller`

          Tool invocation directly from the model.

          - `JsonValue type = "direct"`

        - `class BetaServerToolCaller`

          Tool invocation generated by a server-side tool.

          - `JsonValue type = "code_execution_20250825"`

          - `String toolId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `class BetaServerToolCaller20260120`

          - `JsonValue type = "code_execution_20260120"`

          - `String toolId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `Optional<String> toolsetName`

        For a toolset member tool_use, the toolset family.

        minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$

    - `class BetaServerToolUseBlock`

      - `JsonValue type = "server_tool_use"`

      - `String id`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `Input input`

      - `Name name`

        - `ADVISOR("advisor")`

        - `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<Caller> caller`

        - `class BetaDirectCaller`

          Tool invocation directly from the model.

        - `class BetaServerToolCaller`

          Tool invocation generated by a server-side tool.

        - `class BetaServerToolCaller20260120`

    - `class BetaWebSearchToolResultBlock`

      - `JsonValue type = "web_search_tool_result"`

      - `BetaWebSearchToolResultBlockContent content`

        - `class BetaWebSearchToolResultError`

          - `JsonValue type = "web_search_tool_result_error"`

          - `BetaWebSearchToolResultErrorCode 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<BetaWebSearchResultBlock>`

          - `JsonValue type = "web_search_result"`

          - `String encryptedContent`

          - `Optional<String> pageAge`

          - `String title`

          - `String url`

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `Optional<Caller> caller`

        - `class BetaDirectCaller`

          Tool invocation directly from the model.

        - `class BetaServerToolCaller`

          Tool invocation generated by a server-side tool.

        - `class BetaServerToolCaller20260120`

    - `class BetaWebFetchToolResultBlock`

      - `JsonValue type = "web_fetch_tool_result"`

      - `Content content`

        - `class BetaWebFetchToolResultErrorBlock`

          - `JsonValue type = "web_fetch_tool_result_error"`

          - `BetaWebFetchToolResultErrorCode 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 BetaWebFetchBlock`

          - `JsonValue type = "web_fetch_result"`

          - `BetaDocumentBlock content`

            - `JsonValue type = "document"`

            - `Optional<BetaCitationConfig> citations`

              Citation configuration for the document

              - `boolean enabled`

            - `Source source`

              - `class BetaBase64PdfSource`

                - `JsonValue type = "base64"`

                - `String data`

                  format: byte

                - `JsonValue mediaType = "application/pdf"`

              - `class BetaPlainTextSource`

                - `JsonValue type = "text"`

                - `String data`

                - `JsonValue mediaType = "text/plain"`

            - `Optional<String> title`

              The title of the document

          - `Optional<String> retrievedAt`

            ISO 8601 timestamp when the content was retrieved

          - `String url`

            Fetched content URL

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `Optional<Caller> caller`

        - `class BetaDirectCaller`

          Tool invocation directly from the model.

        - `class BetaServerToolCaller`

          Tool invocation generated by a server-side tool.

        - `class BetaServerToolCaller20260120`

    - `class BetaAdvisorToolResultBlock`

      - `JsonValue type = "advisor_tool_result"`

      - `Content content`

        - `class BetaAdvisorToolResultError`

          - `JsonValue type = "advisor_tool_result_error"`

          - `ErrorCode errorCode`

            - `MAX_USES_EXCEEDED("max_uses_exceeded")`

            - `PROMPT_TOO_LONG("prompt_too_long")`

            - `TOO_MANY_REQUESTS("too_many_requests")`

            - `OVERLOADED("overloaded")`

            - `UNAVAILABLE("unavailable")`

            - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

            - `MODEL_NOT_FOUND("model_not_found")`

        - `class BetaAdvisorResultBlock`

          - `JsonValue type = "advisor_result"`

          - `Optional<String> stopReason`

            The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap.

          - `String text`

        - `class BetaAdvisorRedactedResultBlock`

          - `JsonValue type = "advisor_redacted_result"`

          - `String encryptedContent`

            Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify.

          - `Optional<String> stopReason`

            The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`).

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaCodeExecutionToolResultBlock`

      - `JsonValue type = "code_execution_tool_result"`

      - `BetaCodeExecutionToolResultBlockContent content`

        - `class BetaCodeExecutionToolResultError`

          - `JsonValue type = "code_execution_tool_result_error"`

          - `BetaCodeExecutionToolResultErrorCode errorCode`

            - `INVALID_TOOL_INPUT("invalid_tool_input")`

            - `UNAVAILABLE("unavailable")`

            - `TOO_MANY_REQUESTS("too_many_requests")`

            - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

        - `class BetaCodeExecutionResultBlock`

          - `JsonValue type = "code_execution_result"`

          - `List<BetaCodeExecutionOutputBlock> content`

            - `JsonValue type = "code_execution_output"`

            - `String fileId`

          - `long returnCode`

          - `String stderr`

          - `String stdout`

        - `class BetaEncryptedCodeExecutionResultBlock`

          Code execution result with encrypted stdout for PFC + web_search results.

          - `JsonValue type = "encrypted_code_execution_result"`

          - `List<BetaCodeExecutionOutputBlock> content`

            - `JsonValue type = "code_execution_output"`

            - `String fileId`

          - `String encryptedStdout`

          - `long returnCode`

          - `String stderr`

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaBashCodeExecutionToolResultBlock`

      - `JsonValue type = "bash_code_execution_tool_result"`

      - `Content content`

        - `class BetaBashCodeExecutionToolResultError`

          - `JsonValue type = "bash_code_execution_tool_result_error"`

          - `ErrorCode 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 BetaBashCodeExecutionResultBlock`

          - `JsonValue type = "bash_code_execution_result"`

          - `List<BetaBashCodeExecutionOutputBlock> content`

            - `JsonValue type = "bash_code_execution_output"`

            - `String fileId`

          - `long returnCode`

          - `String stderr`

          - `String stdout`

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaTextEditorCodeExecutionToolResultBlock`

      - `JsonValue type = "text_editor_code_execution_tool_result"`

      - `Content content`

        - `class BetaTextEditorCodeExecutionToolResultError`

          - `JsonValue type = "text_editor_code_execution_tool_result_error"`

          - `ErrorCode 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<String> errorMessage`

        - `class BetaTextEditorCodeExecutionViewResultBlock`

          - `JsonValue type = "text_editor_code_execution_view_result"`

          - `String content`

          - `FileType fileType`

            - `TEXT("text")`

            - `IMAGE("image")`

            - `PDF("pdf")`

          - `Optional<Long> numLines`

          - `Optional<Long> startLine`

          - `Optional<Long> totalLines`

        - `class BetaTextEditorCodeExecutionCreateResultBlock`

          - `JsonValue type = "text_editor_code_execution_create_result"`

          - `boolean isFileUpdate`

        - `class BetaTextEditorCodeExecutionStrReplaceResultBlock`

          - `JsonValue type = "text_editor_code_execution_str_replace_result"`

          - `Optional<List<String>> lines`

          - `Optional<Long> newLines`

          - `Optional<Long> newStart`

          - `Optional<Long> oldLines`

          - `Optional<Long> oldStart`

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaToolSearchToolResultBlock`

      - `JsonValue type = "tool_search_tool_result"`

      - `Content content`

        - `class BetaToolSearchToolResultError`

          - `JsonValue type = "tool_search_tool_result_error"`

          - `ErrorCode errorCode`

            - `INVALID_TOOL_INPUT("invalid_tool_input")`

            - `UNAVAILABLE("unavailable")`

            - `TOO_MANY_REQUESTS("too_many_requests")`

            - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

          - `Optional<String> errorMessage`

        - `class BetaToolSearchToolSearchResultBlock`

          - `JsonValue type = "tool_search_tool_search_result"`

          - `List<BetaToolReferenceBlock> 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 BetaMcpToolUseBlock`

      - `JsonValue type = "mcp_tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `Input input`

      - `String name`

        The name of the MCP tool

      - `String serverName`

        The name of the MCP server

    - `class BetaMcpToolResultBlock`

      - `JsonValue type = "mcp_tool_result"`

      - `Content content`

        - `String`

        - `List<BetaTextBlock>`

          - `JsonValue type = "text"`

          - `Optional<List<BetaTextCitation>> 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`.

          - `String text`

      - `boolean isError`

      - `String toolUseId`

        pattern: ^[a-zA-Z0-9_-]+$

    - `class BetaContainerUploadBlock`

      Response model for a file uploaded to the container.

      - `JsonValue type = "container_upload"`

      - `String fileId`

    - `class BetaCompactionBlock`

      A compaction block returned when autocompact is triggered.

      When content is None, it indicates the compaction failed to produce a valid
      summary (e.g., malformed output from the model). Clients may round-trip
      compaction blocks with null content; the server treats them as no-ops.

      - `JsonValue type = "compaction"`

      - `Optional<String> content`

        Summary of compacted content, or null if compaction failed

      - `Optional<String> encryptedContent`

        Opaque metadata from prior compaction, to be round-tripped verbatim

      - `Optional<String> signature`

        Signature over the summary, to be sent back with the block verbatim

      - `Optional<List<ToolChange>> toolChanges`

        The tool changes of the compacted range: the `tool_addition` and `tool_removal` blocks that take the request's `tools` to the tool set in effect at the end of the range, or `[]` when the range changed no tool. Absent when the server did not compute them. Send the block back unchanged.

        - `class BetaResponseToolAdditionBlock`

          An entry of a `compaction` block's `tool_changes`: a tool the
          compacted range made available, as a reference to a `tools` entry or
          MCP toolset, or as the tool definition in effect at the end of the
          range, by value. Send it back unchanged.

          - `JsonValue type = "tool_addition"`

          - `Tool tool`

            The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value.

            - `class BetaResponseToolChangeToolReference`

              Reference to a single tool, by the name the model uses to call it, as
              a `compaction` block's `tool_changes` entry reports it: a tool
              declared in `tools` or defined by an earlier `tool_addition` block.
              Send it back unchanged with the block.

              - `JsonValue type = "tool_reference"`

              - `String name`

            - `class BetaResponseToolChangeMcpToolReference`

              Reference to a single MCP tool, by its server and its name on that
              server, as a `compaction` block's `tool_changes` entry reports it.
              Send it back unchanged with the block.

              - `JsonValue type = "mcp_tool_reference"`

              - `String name`

              - `String serverName`

            - `class BetaResponseToolChangeMcpToolsetReference`

              Reference to every tool in the named MCP server's toolset, as a
              `compaction` block's `tool_changes` entry reports it. Send it back
              unchanged with the block.

              - `JsonValue type = "mcp_toolset_reference"`

              - `String serverName`

            - `class BetaToolChangeToolDefinition`

              A tool defined by value, as a `compaction` block's `tool_changes` entry
              reports it: `definition` is the tool's definition as it was sent, in the
              form of a `tools` entry, without `cache_control`. Send it back unchanged
              with the block.

              - `JsonValue type = "tool_definition"`

              - `BetaResponseToolUnion definition`

                - `class BetaResponseTool`

                  A custom tool definition, as sent.

                  - `Optional<Type> type`

                  - `BetaResponseToolInputSchema 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> properties`

                    - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolBash20241022`

                  - `JsonValue type = "bash_20241022"`

                  - `JsonValue name = "bash"`

                    Name of the tool.

                    This is how the tool will be called by the model and in `tool_use` blocks.

                  - `Optional<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                    - `JsonValue type = "ephemeral"`

                    - `Optional<Ttl> 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<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolBash20250124`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaCodeExecutionTool20250522`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaCodeExecutionTool20250825`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaCodeExecutionTool20260120`

                  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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaCodeExecutionTool20260521`

                  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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaBrowserToolset20260801`

                  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<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

                      `type`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserCloseTabConfig> closeTab`

                      `close_tab`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

                      `double_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserFileUploadConfig> fileUpload`

                      `file_upload`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserFindConfig> find`

                      `find`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserFormInputConfig> formInput`

                      `form_input`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserGetPageTextConfig> getPageText`

                      `get_page_text`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserHoldKeyConfig> holdKey`

                      `hold_key`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserHoverConfig> hover`

                      `hover`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

                      `javascript_exec`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserKeyConfig> key`

                      `key`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserLeftClickConfig> leftClick`

                      `left_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

                      `left_click_drag`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

                      `left_mouse_down`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

                      `left_mouse_up`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserListTabsConfig> listTabs`

                      `list_tabs`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserMiddleClickConfig> middleClick`

                      `middle_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

                      `mouse_move`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserNavigateConfig> navigate`

                      `navigate`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserNewTabConfig> newTab`

                      `new_tab`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserReadConsoleConfig> readConsole`

                      `read_console`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

                      `read_network`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserReadPageConfig> readPage`

                      `read_page`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserRightClickConfig> rightClick`

                      `right_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserScreenshotConfig> screenshot`

                      `screenshot`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserScrollConfig> scroll`

                      `scroll`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserScrollToConfig> scrollTo`

                      `scroll_to`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserSwitchTabConfig> switchTab`

                      `switch_tab`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserTripleClickConfig> tripleClick`

                      `triple_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserWaitConfig> wait`

                      `wait`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserZoomConfig> zoom`

                      `zoom`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered 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 BetaToolComputerUse20241022`

                  - `JsonValue type = "computer_20241022"`

                  - `long displayHeightPx`

                    The height of the display in pixels.

                    minimum: 1

                  - `long displayWidthPx`

                    The width of the display in pixels.

                    minimum: 1

                  - `JsonValue name = "computer"`

                    Name of the tool.

                    This is how the tool will be called by the model and in `tool_use` blocks.

                  - `Optional<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> displayNumber`

                    The X11 display number (e.g. 0, 1) for the display.

                    minimum: 0

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaMemoryTool20250818`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolComputerUse20250124`

                  - `JsonValue type = "computer_20250124"`

                  - `long displayHeightPx`

                    The height of the display in pixels.

                    minimum: 1

                  - `long displayWidthPx`

                    The width of the display in pixels.

                    minimum: 1

                  - `JsonValue name = "computer"`

                    Name of the tool.

                    This is how the tool will be called by the model and in `tool_use` blocks.

                  - `Optional<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> displayNumber`

                    The X11 display number (e.g. 0, 1) for the display.

                    minimum: 0

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolTextEditor20241022`

                  - `JsonValue type = "text_editor_20241022"`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolComputerUse20251124`

                  - `JsonValue type = "computer_20251124"`

                  - `long displayHeightPx`

                    The height of the display in pixels.

                    minimum: 1

                  - `long displayWidthPx`

                    The width of the display in pixels.

                    minimum: 1

                  - `JsonValue name = "computer"`

                    Name of the tool.

                    This is how the tool will be called by the model and in `tool_use` blocks.

                  - `Optional<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> displayNumber`

                    The X11 display number (e.g. 0, 1) for the display.

                    minimum: 0

                  - `Optional<Boolean> enableZoom`

                    Whether to enable an action to take a zoomed-in screenshot of the screen.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaComputerToolset20260801`

                  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<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

                      `type`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

                      `cursor_position`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerDoubleClickConfig> doubleClick`

                      `double_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerHoldKeyConfig> holdKey`

                      `hold_key`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerKeyConfig> key`

                      `key`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerLeftClickConfig> leftClick`

                      `left_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

                      `left_click_drag`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

                      `left_mouse_down`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

                      `left_mouse_up`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerMiddleClickConfig> middleClick`

                      `middle_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerMouseMoveConfig> mouseMove`

                      `mouse_move`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerRightClickConfig> rightClick`

                      `right_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerScreenshotConfig> screenshot`

                      `screenshot`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerScrollConfig> scroll`

                      `scroll`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerTripleClickConfig> tripleClick`

                      `triple_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerWaitConfig> wait`

                      `wait`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerZoomConfig> zoom`

                      `zoom`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered 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 BetaToolTextEditor20250124`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolTextEditor20250429`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolTextEditor20250728`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Long> maxCharacters`

                    Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaWebSearchTool20250305`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                  - `Optional<List<String>> blockedDomains`

                    If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaUserLocation> userLocation`

                    Parameters for the user's location. Used to provide more relevant search results.

                    - `JsonValue type = "approximate"`

                    - `Optional<String> city`

                      The city of the user.

                      minLength: 1, maxLength: 255

                    - `Optional<String> 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<String> region`

                      The region of the user.

                      minLength: 1, maxLength: 255

                    - `Optional<String> timezone`

                      The [IANA timezone](https://nodatime.org/TimeZones) of the user.

                      minLength: 1, maxLength: 255

                - `class BetaWebFetchTool20250910`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    List of domains to allow fetching from

                  - `Optional<List<String>> blockedDomains`

                    List of domains to block fetching from

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaCitationsConfigParam> citations`

                    Citations configuration for fetched documents. Citations are disabled by default.

                    - `Optional<Boolean> enabled`

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> 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<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaWebFetchUrlSources> urlSources`

                    Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                    - `Optional<ClientToolResults> clientToolResults`

                      Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

                      - `class BetaWebFetchUrlSourceAll`

                        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 BetaWebFetchUrlSourceNone`

                        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 BetaWebFetchUrlSourceOnly`

                        The tool filter variant under which only the named tools' results
                        contribute.

                        - `JsonValue type = "only"`

                        - `List<BetaWebFetchUrlSourceToolReference> tools`

                          - `JsonValue type = "tool_reference"`

                          - `String name`

                      - `class BetaWebFetchUrlSourceExcept`

                        The tool filter variant under which every result but the named
                        tools' contributes.

                        - `JsonValue type = "except"`

                        - `List<BetaWebFetchUrlSourceToolReference> tools`

                          - `JsonValue type = "tool_reference"`

                          - `String name`

                    - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

                        The `url_sources` variant under which a source contributes in
                        full: every result of the tool filter's source, or all user input.

                      - `class BetaWebFetchUrlSourceNone`

                        The `url_sources` variant under which a source contributes nothing:
                        no result of the tool filter's source, or no user input.

                      - `class BetaWebFetchUrlSourceOnly`

                        The tool filter variant under which only the named tools' results
                        contribute.

                      - `class BetaWebFetchUrlSourceExcept`

                        The tool filter variant under which every result but the named
                        tools' contributes.

                    - `Optional<UserInput> userInput`

                      Whether URLs in user messages are fetchable: "all" or "none".

                      - `class BetaWebFetchUrlSourceAll`

                        The `url_sources` variant under which a source contributes in
                        full: every result of the tool filter's source, or all user input.

                      - `class BetaWebFetchUrlSourceNone`

                        The `url_sources` variant under which a source contributes nothing:
                        no result of the tool filter's source, or no user input.

                - `class BetaWebSearchTool20260209`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                  - `Optional<List<String>> blockedDomains`

                    If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaUserLocation> userLocation`

                    Parameters for the user's location. Used to provide more relevant search results.

                - `class BetaWebFetchTool20260209`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    List of domains to allow fetching from

                  - `Optional<List<String>> blockedDomains`

                    List of domains to block fetching from

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaCitationsConfigParam> citations`

                    Citations configuration for fetched documents. Citations are disabled by default.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> 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<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaWebFetchUrlSources> urlSources`

                    Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                - `class BetaWebFetchTool20260309`

                  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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    List of domains to allow fetching from

                  - `Optional<List<String>> blockedDomains`

                    List of domains to block fetching from

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaCitationsConfigParam> citations`

                    Citations configuration for fetched documents. Citations are disabled by default.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> 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<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaWebFetchUrlSources> urlSources`

                    Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                  - `Optional<Boolean> 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 BetaWebSearchTool20260318`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                  - `Optional<List<String>> blockedDomains`

                    If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<ResponseInclusion> 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<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaUserLocation> userLocation`

                    Parameters for the user's location. Used to provide more relevant search results.

                - `class BetaWebFetchTool20260318`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    List of domains to allow fetching from

                  - `Optional<List<String>> blockedDomains`

                    List of domains to block fetching from

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaCitationsConfigParam> citations`

                    Citations configuration for fetched documents. Citations are disabled by default.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> 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<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<ResponseInclusion> 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<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaWebFetchUrlSources> urlSources`

                    Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                  - `Optional<Boolean> 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 BetaAdvisorTool20260301`

                  - `JsonValue type = "advisor_20260301"`

                  - `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 name = "advisor"`

                    Name of the tool.

                    This is how the tool will be called by the model and in `tool_use` blocks.

                  - `Optional<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaCacheControlEphemeral> caching`

                    Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> maxTokens`

                    Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

                    minimum: 1024

                  - `Optional<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolSearchToolRegex20251119`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaMcpToolset`

                  Configuration for a group of tools from an MCP server.

                  Allows configuring enabled status and defer_loading for all tools
                  from an MCP server, with optional per-tool overrides.

                  - `JsonValue type = "mcp_toolset"`

                  - `String mcpServerName`

                    Name of the MCP server to configure tools for

                    minLength: 1, maxLength: 255

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Configs> configs`

                    Configuration overrides for specific tools, keyed by tool name

                    - `Optional<Boolean> deferLoading`

                    - `Optional<Boolean> enabled`

                  - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

                    Default configuration applied to all tools from this server

                    - `Optional<Boolean> deferLoading`

                    - `Optional<Boolean> enabled`

                  - `Optional<List<BetaMcpToolParam>> tools`

                    The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

                    - `InputSchema inputSchema`

                      The tool's input schema as the MCP server lists it, verbatim.

                    - `String name`

                      The tool's name as the MCP server lists it (not prefixed with the server name).

                      minLength: 1

                    - `Optional<String> description`

                      The tool's description as the MCP server lists it.

        - `class BetaResponseToolRemovalBlock`

          An entry of a `compaction` block's `tool_changes`: a tool of the
          request's `tools` (or an MCP tool or toolset) that the compacted range
          withdrew. Send it back unchanged.

          - `JsonValue type = "tool_removal"`

          - `Tool tool`

            A reference to the withdrawn `tools` entry, MCP tool or MCP toolset.

            - `class BetaResponseToolChangeToolReference`

              Reference to a single tool, by the name the model uses to call it, as
              a `compaction` block's `tool_changes` entry reports it: a tool
              declared in `tools` or defined by an earlier `tool_addition` block.
              Send it back unchanged with the block.

            - `class BetaResponseToolChangeMcpToolReference`

              Reference to a single MCP tool, by its server and its name on that
              server, as a `compaction` block's `tool_changes` entry reports it.
              Send it back unchanged with the block.

            - `class BetaResponseToolChangeMcpToolsetReference`

              Reference to every tool in the named MCP server's toolset, as a
              `compaction` block's `tool_changes` entry reports it. Send it back
              unchanged with the block.

    - `class BetaFallbackBlock`

      Marks the point in `content` where one model's output gives way to the next.

      One block appears per hop where a preceding model actually ran this turn and
      declined. A turn where no preceding model ran and declined has no such
      boundary and carries no block — the signal for whether a fallback model
      served the response is the presence of a `fallback_message` entry in
      `usage.iterations`, not this block.

      The block is treated like a server-tool content block for streaming: it
      arrives via the standard `content_block_start` / `content_block_stop`
      pair and carries no deltas.

      - `JsonValue type = "fallback"`

      - `BetaFallbackInfo from`

        The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id.

        - `Model model`

          The model that will complete your prompt.

          See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

      - `BetaFallbackInfo to`

        The fallback model producing the content that follows this block. Its `model` is always the canonical id.

      - `BetaFallbackRefusalTrigger trigger`

        What caused the `from` model to hand over at this hop.

        - `JsonValue type = "refusal"`

        - `Optional<Category> category`

          The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.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.

    - `class BetaMcpToolListingBlock`

      The tool listing the server fetched from an MCP server while producing
      this response. Send the assistant message back unchanged, this block
      included, so later requests use this listing instead of asking the MCP
      server again.

      - `JsonValue type = "mcp_tool_listing"`

      - `String mcpServerName`

      - `List<BetaMcpTool> tools`

        - `InputSchema inputSchema`

        - `String name`

        - `Optional<String> description`

  - `Optional<BetaContextManagementResponse> contextManagement`

    Context management response.

    Information about context management strategies applied during the request.

    - `List<AppliedEdit> appliedEdits`

      List of context management edits that were applied.

      - `class BetaClearToolUses20250919EditResponse`

        - `JsonValue type = "clear_tool_uses_20250919"`

          The type of context management edit applied.

        - `long clearedInputTokens`

          Number of input tokens cleared by this edit.

          minimum: 0

        - `long clearedToolUses`

          Number of tool uses that were cleared.

          minimum: 0

      - `class BetaClearThinking20251015EditResponse`

        - `JsonValue type = "clear_thinking_20251015"`

          The type of context management edit applied.

        - `long clearedInputTokens`

          Number of input tokens cleared by this edit.

          minimum: 0

        - `long clearedThinkingTurns`

          Number of thinking turns that were cleared.

          minimum: 0

  - `Optional<BetaDiagnostics> diagnostics`

    Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected.

    - `Optional<BetaCacheMissReason> 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 BetaCacheMissModelChanged`

        - `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 BetaCacheMissSystemChanged`

        - `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 BetaCacheMissToolsChanged`

        - `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 BetaCacheMissMessagesChanged`

        - `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 BetaCacheMissPreviousMessageNotFound`

        - `JsonValue type = "previous_message_not_found"`

      - `class BetaCacheMissUnavailable`

        - `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.

  - `JsonValue role = "assistant"`

    Conversational role of the generated message.

    This will always be `"assistant"`.

  - `Optional<BetaRefusalStopDetails> 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> 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<String> 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<String> fallbackCreditToken`

      Opaque code that refunds the cache-miss cost when retrying this refused
      request on the fallback model. Pass it as `fallback_credit_token` on the
      retry request. Expires 5 minutes after the refusal.

      The retry is sent either with the same request body (`system`, `messages`,
      `tools`, and other render-shaping fields), or with the same body plus one
      appended `assistant` message whose content is the partial text (with any
      trailing whitespace stripped from the final text block) and paired
      server-tool blocks from this refusal — which also authorizes that
      appended turn as an assistant-prefill continuation on models that otherwise
      disallow prefill. A token minted mid-server-tool-loop whose partial content
      was continuable may only be redeemed the second way — if a same-body retry
      is rejected with a 400 saying the token must be redeemed by continuing the
      partial response, retry the second way instead. Either way: same workspace,
      same platform; a mismatch is a 400. Resending a token for an already-warm
      prefix is permitted but yields no additional credit.

      `null` when the refused model isn't eligible for a fallback credit.

    - `Optional<Boolean> fallbackHasPrefillClaim`

      Whether the accompanying `fallback_credit_token` may be redeemed with the
      appended-assistant retry form. Only set when `fallback_credit_token` is
      present.

      `true`: retry by resending the same request body plus one appended
      `assistant` message whose content is this response's `content` with any
      trailing whitespace stripped from the final text block and unpaired
      `tool_use` blocks omitted (the same appended-turn shape described on
      `fallback_credit_token`), with the token attached. `false`: retry by
      resending the original request body unchanged, with the token attached —
      the appended-assistant form is not available for this refusal (no
      continuable partial content, or the request uses `output_format` or a
      `tool_choice` that forces tool use). One exception: when the request used
      `output_format` or a forced `tool_choice` and the refusal arrived after
      server tools (including MCP connector tools) had already executed, the
      token may not be redeemable by either retry form; if the exact-body retry
      is then rejected with a 400 saying the token must be redeemed by
      continuing the partial response, discard the token and retry without it.

      Advisory: if an appended-assistant retry is rejected with a 400 despite
      `true`, fall back to resending the original request body with the token.

    - `Optional<String> recommendedModel`

      The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise.

  - `Optional<BetaStopReason> 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")`

    - `COMPACTION("compaction")`

    - `REFUSAL("refusal")`

    - `MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")`

  - `Optional<String> 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.

  - `BetaUsage 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<BetaCacheCreation> 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<Long> cacheCreationInputTokens`

      The number of input tokens used to create the cache entry.

      minimum: 0

    - `Optional<Long> cacheReadInputTokens`

      The number of input tokens read from the cache.

      minimum: 0

    - `Optional<BetaFallbackCreditUsage> fallbackCredit`

      Outcome of the `fallback_credit_token` presented on this request.

      Present on every response to a non-batch request that carried a
      `fallback_credit_token`, in either redemption mode; absent otherwise (batch
      items accept and ignore the token and carry no outcome object).

      - `Status status`

        Whether the fallback-credit reprice was applied to this response's billing.

        A union discriminated on `type`. `redeemed`: the retry is billed as if
        the conversation had been on the retry model all along — including when the
        resulting shift is zero because there was nothing to move. `not_applied`:
        no reprice was applied; the arm's `reason` says why.

        - `class BetaFallbackCreditRedeemed`

          The reprice was applied: the retry is billed as if the conversation
          had been on the retry model all along.

          - `JsonValue type = "redeemed"`

        - `class BetaFallbackCreditNotApplied`

          No reprice was applied; `reason` says why.

          - `JsonValue type = "not_applied"`

          - `Reason reason`

            Why the reprice was not applied.

            A closed enum; additions to the redemption-check vocabulary arrive as
            deliberate schema updates.

            - `BODY_MISMATCH("body_mismatch")`

            - `CONTINUATION_EXCLUDED("continuation_excluded")`

            - `CONTINUATION_ONLY("continuation_only")`

            - `EXPIRED("expired")`

            - `INVALID_TARGET_MODEL("invalid_target_model")`

            - `NOT_ENABLED("not_enabled")`

            - `REPRICE_UNAVAILABLE("reprice_unavailable")`

            - `TEMPORARILY_UNAVAILABLE("temporarily_unavailable")`

            - `VARIANT_FIELDS_PRESENT("variant_fields_present")`

            - `WRONG_ORGANIZATION("wrong_organization")`

            - `WRONG_PLATFORM("wrong_platform")`

            - `WRONG_WORKSPACE("wrong_workspace")`

          - `Optional<List<String>> removeToRedeem`

            Request fields to remove before retrying, so the retry can redeem this
            token.

            Present exactly when `reason` is `variant_fields_present` — never null,
            never an empty array; absent otherwise. Fields are named only from your own request, and only after
            the sealed variant hash matched. A served best-effort retry has already
            been billed at normal price; nothing redeems retroactively, but a corrected
            re-send inside the token's five-minute window can still redeem.

    - `Optional<String> inferenceGeo`

      The geographic region where inference was performed for this request.

    - `long inputTokens`

      The number of input tokens which were used.

      minimum: 0

    - `Optional<List<Iteration>> iterations`

      Per-iteration token usage breakdown.

      Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to:

      - Calculate the context window size from the last `message` entry
      - Understand token accumulation across server-side tool use loops

      A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results.

      - `class BetaMessageIterationUsage`

        Token usage for a sampling iteration.

        - `JsonValue type = "message"`

          Usage for a sampling iteration

        - `Optional<BetaCacheCreation> cacheCreation`

          Breakdown of cached tokens by TTL

        - `long cacheCreationInputTokens`

          The number of input tokens used to create the cache entry.

          minimum: 0

        - `long cacheReadInputTokens`

          The number of input tokens read from the cache.

          minimum: 0

        - `long inputTokens`

          The number of input tokens which were used.

          minimum: 0

        - `Optional<Model> model`

          The model that will complete your prompt.

          See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

        - `long outputTokens`

          The number of output tokens which were used.

          minimum: 0

      - `class BetaCompactionIterationUsage`

        Token usage for a compaction iteration.

        - `JsonValue type = "compaction"`

          Usage for a compaction iteration

        - `Optional<BetaCacheCreation> cacheCreation`

          Breakdown of cached tokens by TTL

        - `long cacheCreationInputTokens`

          The number of input tokens used to create the cache entry.

          minimum: 0

        - `long cacheReadInputTokens`

          The number of input tokens read from the cache.

          minimum: 0

        - `long inputTokens`

          The number of input tokens which were used.

          minimum: 0

        - `long outputTokens`

          The number of output tokens which were used.

          minimum: 0

      - `class BetaAdvisorMessageIterationUsage`

        Token usage for an advisor sub-inference iteration.

        - `JsonValue type = "advisor_message"`

          Usage for an advisor sub-inference iteration

        - `Optional<BetaCacheCreation> cacheCreation`

          Breakdown of cached tokens by TTL

        - `long cacheCreationInputTokens`

          The number of input tokens used to create the cache entry.

          minimum: 0

        - `long cacheReadInputTokens`

          The number of input tokens read from the cache.

          minimum: 0

        - `long inputTokens`

          The number of input tokens which were used.

          minimum: 0

        - `Model model`

          The model that will complete your prompt.

          See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

        - `long outputTokens`

          The number of output tokens which were used.

          minimum: 0

      - `class BetaFallbackMessageIterationUsage`

        Token usage for the fallback-model attempt of a server-side fallback request.

        The terminal entry of a fallback-served turn: when a fallback hop's
        output is the returned message, the entry for the iteration that
        completed it carries this type in place of `message`. A declined hop
        and the serving hop's earlier tool-loop iterations produce `message`
        entries. Whether a fallback model served the response is signalled by
        the presence of this entry in `usage.iterations`.

        - `JsonValue type = "fallback_message"`

          Usage for the fallback-model attempt that served the response

        - `Optional<BetaCacheCreation> cacheCreation`

          Breakdown of cached tokens by TTL

        - `long cacheCreationInputTokens`

          The number of input tokens used to create the cache entry.

          minimum: 0

        - `long cacheReadInputTokens`

          The number of input tokens read from the cache.

          minimum: 0

        - `long inputTokens`

          The number of input tokens which were used.

          minimum: 0

        - `Model model`

          The model that will complete your prompt.

          See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

        - `long outputTokens`

          The number of output tokens which were used.

          minimum: 0

    - `long outputTokens`

      The number of output tokens which were used.

      minimum: 0

    - `Optional<BetaOutputTokensDetails> 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<BetaServerToolUsage> 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> serviceTier`

      If the request used the priority, standard, or batch tier.

      - `STANDARD("standard")`

      - `PRIORITY("priority")`

      - `BATCH("batch")`

    - `Optional<Speed> speed`

      The inference speed mode used for this request.

      - `STANDARD("standard")`

      - `FAST("fast")`

  - `Optional<List<BetaInputTransformation>> inputTransformations`

    Changes the API made to the request's input before showing it to the model,
    and blocks that failed a binding check but were left unchanged: one entry per
    block, in request order. Two entry types today. `thinking_dropped` — a
    `thinking`, `redacted_thinking` or `connector_text` block from the request's
    `messages` that was removed from the prompt instead of being shown to the
    model because it failed a binding check. `thinking_mismatch_allowed` — a
    `thinking` or `redacted_thinking` block that failed the conversation check
    (the conversation before it differs from the one it was created in, or it
    carries no record of one on a model that requires it) and was shown to the
    model all the same, because that check is not enforced for this request.
    More entry types may be added over time; ignore types you do not recognize.

    Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on
    every such response from a model that supports extended thinking, as `[]`
    when there is no entry to report; without the beta, blocks are removed or
    left in place all the same but nothing is reported. Removed blocks contribute
    nothing to `usage.input_tokens`; blocks left in place count as sent. When
    streaming, the array is final in `message_start`; the final `message_delta`
    event carries it only when a server-side model fallback happened mid-stream,
    in which case it holds the serving model's entries and replaces the one in
    `message_start`.

    - `class BetaThinkingDroppedInputTransformation`

      - `JsonValue type = "thinking_dropped"`

        Always `thinking_dropped` for this entry type.

      - `String path`

        Where the removed block was in your request, as `messages.{i}.content.{j}`:
        `i` indexes the `messages` array you sent and `j` that message's `content`
        array — the same form error messages use.

      - `Reason reason`

        Which binding check removed the block: `model_binding_mismatch` — it was
        created by a model whose reasoning the requested model may not read;
        `prefix_binding_mismatch` — the conversation before it differs from the
        conversation it was created in (the rest of that turn's consecutive thinking
        blocks are removed with it, each with this reason);
        `organization_binding_mismatch` — it was created under a different
        organization (an Anthropic organization, AWS account or Google Cloud project)
        and this organization is not one of its additional organizations;
        `end_user_binding_mismatch` — it was created for a different end user, or
        was removed by the consumer-organization binding. A block that would fail
        several checks reports one reason, in this order of precedence:
        `organization_binding_mismatch`, `end_user_binding_mismatch`,
        `model_binding_mismatch`, `prefix_binding_mismatch`.

        - `MODEL_BINDING_MISMATCH("model_binding_mismatch")`

        - `PREFIX_BINDING_MISMATCH("prefix_binding_mismatch")`

        - `ORGANIZATION_BINDING_MISMATCH("organization_binding_mismatch")`

        - `END_USER_BINDING_MISMATCH("end_user_binding_mismatch")`

    - `class BetaThinkingMismatchAllowedInputTransformation`

      - `JsonValue type = "thinking_mismatch_allowed"`

        Always `thinking_mismatch_allowed` for this entry type.

      - `String path`

        Where the block is in your request, as `messages.{i}.content.{j}`:
        `i` indexes the `messages` array you sent and `j` that message's `content`
        array — the same form error messages use.

      - `Reason reason`

        Which binding check the block failed; the block was shown to the model all
        the same. Always `prefix_binding_mismatch` today — the conversation before
        the block differs from the conversation it was created in, or the block
        carries no record of one on a model that requires it. Were the check
        enforced for this request, the block would have been removed or the request
        rejected (`thinking.block_binding.prefix_mismatch_behavior`). A removal also
        takes the rest of that turn's consecutive thinking blocks, whereas here each
        block is checked on its own, so `thinking_mismatch_allowed` entries are a
        lower bound on what enforcement would remove.

        - `MODEL_BINDING_MISMATCH("model_binding_mismatch")`

        - `PREFIX_BINDING_MISMATCH("prefix_binding_mismatch")`

        - `ORGANIZATION_BINDING_MISMATCH("organization_binding_mismatch")`

        - `END_USER_BINDING_MISMATCH("end_user_binding_mismatch")`

### Beta Message Delta Usage

- `class BetaMessageDeltaUsage`

  - `Optional<Long> cacheCreationInputTokens`

    The cumulative number of input tokens used to create the cache entry.

    minimum: 0

  - `Optional<Long> cacheReadInputTokens`

    The cumulative number of input tokens read from the cache.

    minimum: 0

  - `Optional<BetaFallbackCreditUsage> fallbackCredit`

    Outcome of the `fallback_credit_token` presented on this request.

    Present on every response to a non-batch request that carried a
    `fallback_credit_token`, in either redemption mode; absent otherwise (batch
    items accept and ignore the token and carry no outcome object).

    - `Status status`

      Whether the fallback-credit reprice was applied to this response's billing.

      A union discriminated on `type`. `redeemed`: the retry is billed as if
      the conversation had been on the retry model all along — including when the
      resulting shift is zero because there was nothing to move. `not_applied`:
      no reprice was applied; the arm's `reason` says why.

      - `class BetaFallbackCreditRedeemed`

        The reprice was applied: the retry is billed as if the conversation
        had been on the retry model all along.

        - `JsonValue type = "redeemed"`

      - `class BetaFallbackCreditNotApplied`

        No reprice was applied; `reason` says why.

        - `JsonValue type = "not_applied"`

        - `Reason reason`

          Why the reprice was not applied.

          A closed enum; additions to the redemption-check vocabulary arrive as
          deliberate schema updates.

          - `BODY_MISMATCH("body_mismatch")`

          - `CONTINUATION_EXCLUDED("continuation_excluded")`

          - `CONTINUATION_ONLY("continuation_only")`

          - `EXPIRED("expired")`

          - `INVALID_TARGET_MODEL("invalid_target_model")`

          - `NOT_ENABLED("not_enabled")`

          - `REPRICE_UNAVAILABLE("reprice_unavailable")`

          - `TEMPORARILY_UNAVAILABLE("temporarily_unavailable")`

          - `VARIANT_FIELDS_PRESENT("variant_fields_present")`

          - `WRONG_ORGANIZATION("wrong_organization")`

          - `WRONG_PLATFORM("wrong_platform")`

          - `WRONG_WORKSPACE("wrong_workspace")`

        - `Optional<List<String>> removeToRedeem`

          Request fields to remove before retrying, so the retry can redeem this
          token.

          Present exactly when `reason` is `variant_fields_present` — never null,
          never an empty array; absent otherwise. Fields are named only from your own request, and only after
          the sealed variant hash matched. A served best-effort retry has already
          been billed at normal price; nothing redeems retroactively, but a corrected
          re-send inside the token's five-minute window can still redeem.

  - `Optional<Long> inputTokens`

    The cumulative number of input tokens which were used.

    minimum: 0

  - `Optional<List<Iteration>> iterations`

    Per-iteration token usage breakdown.

    Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to:

    - Calculate the context window size from the last `message` entry
    - Understand token accumulation across server-side tool use loops

    A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results.

    - `class BetaMessageIterationUsage`

      Token usage for a sampling iteration.

      - `JsonValue type = "message"`

        Usage for a sampling iteration

      - `Optional<BetaCacheCreation> 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

      - `long cacheCreationInputTokens`

        The number of input tokens used to create the cache entry.

        minimum: 0

      - `long cacheReadInputTokens`

        The number of input tokens read from the cache.

        minimum: 0

      - `long inputTokens`

        The number of input tokens which were used.

        minimum: 0

      - `Optional<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

      - `long outputTokens`

        The number of output tokens which were used.

        minimum: 0

    - `class BetaCompactionIterationUsage`

      Token usage for a compaction iteration.

      - `JsonValue type = "compaction"`

        Usage for a compaction iteration

      - `Optional<BetaCacheCreation> cacheCreation`

        Breakdown of cached tokens by TTL

      - `long cacheCreationInputTokens`

        The number of input tokens used to create the cache entry.

        minimum: 0

      - `long cacheReadInputTokens`

        The number of input tokens read from the cache.

        minimum: 0

      - `long inputTokens`

        The number of input tokens which were used.

        minimum: 0

      - `long outputTokens`

        The number of output tokens which were used.

        minimum: 0

    - `class BetaAdvisorMessageIterationUsage`

      Token usage for an advisor sub-inference iteration.

      - `JsonValue type = "advisor_message"`

        Usage for an advisor sub-inference iteration

      - `Optional<BetaCacheCreation> cacheCreation`

        Breakdown of cached tokens by TTL

      - `long cacheCreationInputTokens`

        The number of input tokens used to create the cache entry.

        minimum: 0

      - `long cacheReadInputTokens`

        The number of input tokens read from the cache.

        minimum: 0

      - `long inputTokens`

        The number of input tokens which were used.

        minimum: 0

      - `Model model`

        The model that will complete your prompt.

        See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

      - `long outputTokens`

        The number of output tokens which were used.

        minimum: 0

    - `class BetaFallbackMessageIterationUsage`

      Token usage for the fallback-model attempt of a server-side fallback request.

      The terminal entry of a fallback-served turn: when a fallback hop's
      output is the returned message, the entry for the iteration that
      completed it carries this type in place of `message`. A declined hop
      and the serving hop's earlier tool-loop iterations produce `message`
      entries. Whether a fallback model served the response is signalled by
      the presence of this entry in `usage.iterations`.

      - `JsonValue type = "fallback_message"`

        Usage for the fallback-model attempt that served the response

      - `Optional<BetaCacheCreation> cacheCreation`

        Breakdown of cached tokens by TTL

      - `long cacheCreationInputTokens`

        The number of input tokens used to create the cache entry.

        minimum: 0

      - `long cacheReadInputTokens`

        The number of input tokens read from the cache.

        minimum: 0

      - `long inputTokens`

        The number of input tokens which were used.

        minimum: 0

      - `Model model`

        The model that will complete your prompt.

        See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

      - `long outputTokens`

        The number of output tokens which were used.

        minimum: 0

  - `long outputTokens`

    The cumulative number of output tokens which were used.

  - `Optional<BetaOutputTokensDetails> 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<BetaServerToolUsage> 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

### Beta Message Iteration Usage

- `class BetaMessageIterationUsage`

  Token usage for a sampling iteration.

  - `JsonValue type = "message"`

    Usage for a sampling iteration

  - `Optional<BetaCacheCreation> 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

  - `long cacheCreationInputTokens`

    The number of input tokens used to create the cache entry.

    minimum: 0

  - `long cacheReadInputTokens`

    The number of input tokens read from the cache.

    minimum: 0

  - `long inputTokens`

    The number of input tokens which were used.

    minimum: 0

  - `Optional<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

  - `long outputTokens`

    The number of output tokens which were used.

    minimum: 0

### Beta Message Param

- `class BetaMessageParam`

  - `Content content`

    - `String`

    - `List<BetaContentBlockParam>`

      - `class BetaTextBlockParam`

        - `JsonValue type = "text"`

        - `String text`

          minLength: 1

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

          - `JsonValue type = "ephemeral"`

          - `Optional<Ttl> 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<List<BetaTextCitationParam>> citations`

          - `class BetaCitationCharLocationParam`

            - `JsonValue type = "char_location"`

            - `String citedText`

            - `long documentIndex`

              minimum: 0

            - `Optional<String> documentTitle`

              minLength: 1, maxLength: 500

            - `long endCharIndex`

            - `long startCharIndex`

              minimum: 0

          - `class BetaCitationPageLocationParam`

            - `JsonValue type = "page_location"`

            - `String citedText`

            - `long documentIndex`

              minimum: 0

            - `Optional<String> documentTitle`

              minLength: 1, maxLength: 500

            - `long endPageNumber`

            - `long startPageNumber`

              minimum: 1

          - `class BetaCitationContentBlockLocationParam`

            - `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<String> 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 BetaCitationWebSearchResultLocationParam`

            - `JsonValue type = "web_search_result_location"`

            - `String citedText`

            - `String encryptedIndex`

            - `Optional<String> title`

              minLength: 1, maxLength: 512

            - `String url`

              minLength: 1

          - `class BetaCitationSearchResultLocationParam`

            - `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<String> title`

      - `class BetaImageBlockParam`

        - `JsonValue type = "image"`

        - `Source source`

          - `class BetaBase64ImageSource`

            - `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 BetaUrlImageSource`

            - `JsonValue type = "url"`

            - `String url`

          - `class BetaFileImageSource`

            - `JsonValue type = "file"`

            - `String fileId`

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<BetaImageTransformationsParam> 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> 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 BetaRequestDocumentBlock`

        - `JsonValue type = "document"`

        - `Source source`

          - `class BetaBase64PdfSource`

            - `JsonValue type = "base64"`

            - `String data`

              format: byte

            - `JsonValue mediaType = "application/pdf"`

          - `class BetaPlainTextSource`

            - `JsonValue type = "text"`

            - `String data`

            - `JsonValue mediaType = "text/plain"`

          - `class BetaContentBlockSource`

            - `JsonValue type = "content"`

            - `Content content`

              - `String`

              - `List<BetaContentBlockSourceContent>`

                - `class BetaTextBlockParam`

                - `class BetaImageBlockParam`

          - `class BetaUrlPdfSource`

            - `JsonValue type = "url"`

            - `String url`

          - `class BetaFileDocumentSource`

            - `JsonValue type = "file"`

            - `String fileId`

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<BetaCitationsConfigParam> citations`

          - `Optional<Boolean> enabled`

        - `Optional<String> context`

          minLength: 1

        - `Optional<String> title`

          minLength: 1, maxLength: 500

      - `class BetaSearchResultBlockParam`

        - `JsonValue type = "search_result"`

        - `List<BetaTextBlockParam> content`

          - `JsonValue type = "text"`

          - `String text`

            minLength: 1

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<List<BetaTextCitationParam>> citations`

        - `String source`

        - `String title`

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<BetaCitationsConfigParam> citations`

      - `class BetaThinkingBlockParam`

        - `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 BetaRedactedThinkingBlockParam`

        - `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 BetaToolUseBlockParam`

        - `JsonValue type = "tool_use"`

        - `String id`

          pattern: ^[a-zA-Z0-9_-]+$

        - `Input input`

        - `String name`

          minLength: 1, maxLength: 200

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<Caller> caller`

          - `class BetaDirectCaller`

            Tool invocation directly from the model.

            - `JsonValue type = "direct"`

          - `class BetaServerToolCaller`

            Tool invocation generated by a server-side tool.

            - `JsonValue type = "code_execution_20250825"`

            - `String toolId`

              pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `class BetaServerToolCaller20260120`

            - `JsonValue type = "code_execution_20260120"`

            - `String toolId`

              pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `Optional<String> toolsetName`

          For a toolset member tool_use, the toolset family this member belongs to.

          minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$

      - `class BetaToolResultBlockParam`

        - `JsonValue type = "tool_result"`

        - `String toolUseId`

          pattern: ^[a-zA-Z0-9_-]+$

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<Content> content`

          - `String`

          - `List<Block>`

            - `class BetaTextBlockParam`

            - `class BetaImageBlockParam`

            - `class BetaSearchResultBlockParam`

            - `class BetaRequestDocumentBlock`

            - `class BetaToolReferenceBlockParam`

              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<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

            - `class BetaBrowserStateBlockParam`

              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<BetaBrowserStateTabEntry> 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<Boolean> active`

                  Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<List<BetaBrowserStateChange>> 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 BetaBrowserStateChangeTabOpened`

                  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 BetaBrowserStateChangeDownloadStarted`

                  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 BetaBrowserStateChangeDownloadCompleted`

                  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<String> 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<Long> sizeBytes`

                    The completed download's size.

                    minimum: 0

                - `class BetaBrowserStateChangeDownloadFailed`

                  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<String> error`

                    The failure or cancellation detail, when known.

                    maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$

        - `Optional<Boolean> isError`

        - `Optional<String> 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 BetaServerToolUseBlockParam`

        - `JsonValue type = "server_tool_use"`

        - `String id`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `Input input`

        - `Name name`

          - `ADVISOR("advisor")`

          - `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<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<Caller> caller`

          - `class BetaDirectCaller`

            Tool invocation directly from the model.

          - `class BetaServerToolCaller`

            Tool invocation generated by a server-side tool.

          - `class BetaServerToolCaller20260120`

      - `class BetaWebSearchToolResultBlockParam`

        - `JsonValue type = "web_search_tool_result"`

        - `BetaWebSearchToolResultBlockParamContent content`

          - `List<BetaWebSearchResultBlockParam>`

            - `JsonValue type = "web_search_result"`

            - `String encryptedContent`

            - `String title`

            - `String url`

            - `Optional<String> pageAge`

          - `class BetaWebSearchToolRequestError`

            - `JsonValue type = "web_search_tool_result_error"`

            - `BetaWebSearchToolResultErrorCode 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<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<Caller> caller`

          - `class BetaDirectCaller`

            Tool invocation directly from the model.

          - `class BetaServerToolCaller`

            Tool invocation generated by a server-side tool.

          - `class BetaServerToolCaller20260120`

      - `class BetaWebFetchToolResultBlockParam`

        - `JsonValue type = "web_fetch_tool_result"`

        - `Content content`

          - `class BetaWebFetchToolResultErrorBlockParam`

            - `JsonValue type = "web_fetch_tool_result_error"`

            - `BetaWebFetchToolResultErrorCode 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 BetaWebFetchBlockParam`

            - `JsonValue type = "web_fetch_result"`

            - `BetaRequestDocumentBlock content`

            - `String url`

              Fetched content URL

            - `Optional<String> retrievedAt`

              ISO 8601 timestamp when the content was retrieved

        - `String toolUseId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<Caller> caller`

          - `class BetaDirectCaller`

            Tool invocation directly from the model.

          - `class BetaServerToolCaller`

            Tool invocation generated by a server-side tool.

          - `class BetaServerToolCaller20260120`

      - `class BetaAdvisorToolResultBlockParam`

        - `JsonValue type = "advisor_tool_result"`

        - `Content content`

          - `class BetaAdvisorToolResultErrorParam`

            - `JsonValue type = "advisor_tool_result_error"`

            - `ErrorCode errorCode`

              - `MAX_USES_EXCEEDED("max_uses_exceeded")`

              - `PROMPT_TOO_LONG("prompt_too_long")`

              - `TOO_MANY_REQUESTS("too_many_requests")`

              - `OVERLOADED("overloaded")`

              - `UNAVAILABLE("unavailable")`

              - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

              - `MODEL_NOT_FOUND("model_not_found")`

          - `class BetaAdvisorResultBlockParam`

            - `JsonValue type = "advisor_result"`

            - `String text`

            - `Optional<String> stopReason`

          - `class BetaAdvisorRedactedResultBlockParam`

            - `JsonValue type = "advisor_redacted_result"`

            - `String encryptedContent`

              Opaque blob produced by a prior response; must be round-tripped verbatim.

            - `Optional<String> stopReason`

        - `String toolUseId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

      - `class BetaCodeExecutionToolResultBlockParam`

        - `JsonValue type = "code_execution_tool_result"`

        - `BetaCodeExecutionToolResultBlockParamContent content`

          - `class BetaCodeExecutionToolResultErrorParam`

            - `JsonValue type = "code_execution_tool_result_error"`

            - `BetaCodeExecutionToolResultErrorCode errorCode`

              - `INVALID_TOOL_INPUT("invalid_tool_input")`

              - `UNAVAILABLE("unavailable")`

              - `TOO_MANY_REQUESTS("too_many_requests")`

              - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

          - `class BetaCodeExecutionResultBlockParam`

            - `JsonValue type = "code_execution_result"`

            - `List<BetaCodeExecutionOutputBlockParam> content`

              - `JsonValue type = "code_execution_output"`

              - `String fileId`

            - `long returnCode`

            - `String stderr`

            - `String stdout`

          - `class BetaEncryptedCodeExecutionResultBlockParam`

            Code execution result with encrypted stdout for PFC + web_search results.

            - `JsonValue type = "encrypted_code_execution_result"`

            - `List<BetaCodeExecutionOutputBlockParam> content`

              - `JsonValue type = "code_execution_output"`

              - `String fileId`

            - `String encryptedStdout`

            - `long returnCode`

            - `String stderr`

        - `String toolUseId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

      - `class BetaBashCodeExecutionToolResultBlockParam`

        - `JsonValue type = "bash_code_execution_tool_result"`

        - `Content content`

          - `class BetaBashCodeExecutionToolResultErrorParam`

            - `JsonValue type = "bash_code_execution_tool_result_error"`

            - `ErrorCode 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 BetaBashCodeExecutionResultBlockParam`

            - `JsonValue type = "bash_code_execution_result"`

            - `List<BetaBashCodeExecutionOutputBlockParam> content`

              - `JsonValue type = "bash_code_execution_output"`

              - `String fileId`

            - `long returnCode`

            - `String stderr`

            - `String stdout`

        - `String toolUseId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

      - `class BetaTextEditorCodeExecutionToolResultBlockParam`

        - `JsonValue type = "text_editor_code_execution_tool_result"`

        - `Content content`

          - `class BetaTextEditorCodeExecutionToolResultErrorParam`

            - `JsonValue type = "text_editor_code_execution_tool_result_error"`

            - `ErrorCode 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<String> errorMessage`

          - `class BetaTextEditorCodeExecutionViewResultBlockParam`

            - `JsonValue type = "text_editor_code_execution_view_result"`

            - `String content`

            - `FileType fileType`

              - `TEXT("text")`

              - `IMAGE("image")`

              - `PDF("pdf")`

            - `Optional<Long> numLines`

            - `Optional<Long> startLine`

            - `Optional<Long> totalLines`

          - `class BetaTextEditorCodeExecutionCreateResultBlockParam`

            - `JsonValue type = "text_editor_code_execution_create_result"`

            - `boolean isFileUpdate`

          - `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam`

            - `JsonValue type = "text_editor_code_execution_str_replace_result"`

            - `Optional<List<String>> lines`

            - `Optional<Long> newLines`

            - `Optional<Long> newStart`

            - `Optional<Long> oldLines`

            - `Optional<Long> oldStart`

        - `String toolUseId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

      - `class BetaToolSearchToolResultBlockParam`

        - `JsonValue type = "tool_search_tool_result"`

        - `Content content`

          - `class BetaToolSearchToolResultErrorParam`

            - `JsonValue type = "tool_search_tool_result_error"`

            - `ErrorCode errorCode`

              - `INVALID_TOOL_INPUT("invalid_tool_input")`

              - `UNAVAILABLE("unavailable")`

              - `TOO_MANY_REQUESTS("too_many_requests")`

              - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

            - `Optional<String> errorMessage`

          - `class BetaToolSearchToolSearchResultBlockParam`

            - `JsonValue type = "tool_search_tool_search_result"`

            - `List<BetaToolReferenceBlockParam> toolReferences`

              - `JsonValue type = "tool_reference"`

              - `String toolName`

                minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

        - `String toolUseId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

      - `class BetaMcpToolUseBlockParam`

        - `JsonValue type = "mcp_tool_use"`

        - `String id`

          pattern: ^[a-zA-Z0-9_-]+$

        - `Input input`

        - `String name`

        - `String serverName`

          The name of the MCP server

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

      - `class BetaRequestMcpToolResultBlockParam`

        - `JsonValue type = "mcp_tool_result"`

        - `String toolUseId`

          pattern: ^[a-zA-Z0-9_-]+$

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<Content> content`

          - `String`

          - `List<BetaTextBlockParam>`

            - `JsonValue type = "text"`

            - `String text`

              minLength: 1

            - `Optional<BetaCacheControlEphemeral> cacheControl`

              Create a cache control breakpoint at this content block.

            - `Optional<List<BetaTextCitationParam>> citations`

        - `Optional<Boolean> isError`

      - `class BetaContainerUploadBlockParam`

        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<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

      - `class BetaCompactionBlockParam`

        A compaction block containing summary of previous context.

        Users should round-trip these blocks from responses to subsequent requests
        to maintain context across compaction boundaries.

        When content is None, the block represents a failed compaction. The server
        treats these as no-ops. Empty string content is not allowed.

        - `JsonValue type = "compaction"`

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<String> content`

          Summary of previously compacted content, or null if compaction failed

        - `Optional<String> encryptedContent`

          Opaque metadata from prior compaction, to be round-tripped verbatim

        - `Optional<String> signature`

          The block's signature as returned, to be sent back verbatim

        - `Optional<List<ToolChange>> toolChanges`

          The tool changes of the compacted range, as the server returned them on this block: the `tool_addition` and `tool_removal` entries that take the request's `tools` to the tool set in effect at the end of the range. Send them back unchanged with the block.

          - `class BetaRequestToolAdditionBlock`

            Mid-conversation directive to make a tool available.

            `tool` is a reference to a tool (or MCP toolset) declared in the
            request's `tools`. Under the `inline-tools-2026-09-15` beta it may
            instead be a reference to a tool defined earlier in `messages`, or a
            `tool_definition` object that carries an inline tool definition in
            `definition` (the same object a `tools` entry holds). An `mcp_toolset`
            definition also requires the `mcp-client-2026-09-15` beta. The tool is
            offered to the model from this point in the conversation onward.

            - `JsonValue type = "tool_addition"`

            - `Tool tool`

              - `class BetaToolChangeToolReference`

                Reference to a single tool, by the name the model uses to call it: a
                tool declared in `tools` or defined by an earlier `tool_addition`
                block. Does not accept the composed `{server}_{name}` form the server
                assigns to MCP-resolved tools; use `mcp_tool_reference` or
                `mcp_toolset_reference` for those.

                - `JsonValue type = "tool_reference"`

                - `String name`

                  pattern: ^[a-zA-Z0-9_-]{1,128}$

              - `class BetaToolChangeMcpToolReference`

                Reference to a single MCP tool by its server and remote name; the
                same `server_name`/`name` pair `mcp_tool_use` carries.

                - `JsonValue type = "mcp_tool_reference"`

                - `String name`

                - `String serverName`

              - `class BetaToolChangeMcpToolsetReference`

                Reference to every tool in the named MCP server's toolset.

                - `JsonValue type = "mcp_toolset_reference"`

                - `String serverName`

              - `class BetaToolChangeToolDefinitionParam`

                A tool defined by value: `definition` is a `tools` entry (any kind
                `tools` accepts, an MCP toolset included). An `mcp_toolset` given here
                also requires the `mcp-client-2026-09-15` beta.

                - `JsonValue type = "tool_definition"`

                - `BetaToolUnion definition`

                  - `class BetaTool`

                    - `Optional<Type> 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> properties`

                      - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolBash20241022`

                    - `JsonValue type = "bash_20241022"`

                    - `JsonValue name = "bash"`

                      Name of the tool.

                      This is how the tool will be called by the model and in `tool_use` blocks.

                    - `Optional<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolBash20250124`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaCodeExecutionTool20250522`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaCodeExecutionTool20250825`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaCodeExecutionTool20260120`

                    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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaCodeExecutionTool20260521`

                    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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaBrowserToolset20260801`

                    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<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

                        `type`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserCloseTabConfig> closeTab`

                        `close_tab`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

                        `double_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserFileUploadConfig> fileUpload`

                        `file_upload`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserFindConfig> find`

                        `find`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserFormInputConfig> formInput`

                        `form_input`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserGetPageTextConfig> getPageText`

                        `get_page_text`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserHoldKeyConfig> holdKey`

                        `hold_key`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserHoverConfig> hover`

                        `hover`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

                        `javascript_exec`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserKeyConfig> key`

                        `key`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserLeftClickConfig> leftClick`

                        `left_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

                        `left_click_drag`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

                        `left_mouse_down`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

                        `left_mouse_up`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserListTabsConfig> listTabs`

                        `list_tabs`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserMiddleClickConfig> middleClick`

                        `middle_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

                        `mouse_move`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserNavigateConfig> navigate`

                        `navigate`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserNewTabConfig> newTab`

                        `new_tab`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserReadConsoleConfig> readConsole`

                        `read_console`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

                        `read_network`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserReadPageConfig> readPage`

                        `read_page`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserRightClickConfig> rightClick`

                        `right_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserScreenshotConfig> screenshot`

                        `screenshot`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserScrollConfig> scroll`

                        `scroll`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserScrollToConfig> scrollTo`

                        `scroll_to`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserSwitchTabConfig> switchTab`

                        `switch_tab`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserTripleClickConfig> tripleClick`

                        `triple_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserWaitConfig> wait`

                        `wait`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserZoomConfig> zoom`

                        `zoom`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered 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 BetaToolComputerUse20241022`

                    - `JsonValue type = "computer_20241022"`

                    - `long displayHeightPx`

                      The height of the display in pixels.

                      minimum: 1

                    - `long displayWidthPx`

                      The width of the display in pixels.

                      minimum: 1

                    - `JsonValue name = "computer"`

                      Name of the tool.

                      This is how the tool will be called by the model and in `tool_use` blocks.

                    - `Optional<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> displayNumber`

                      The X11 display number (e.g. 0, 1) for the display.

                      minimum: 0

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaMemoryTool20250818`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolComputerUse20250124`

                    - `JsonValue type = "computer_20250124"`

                    - `long displayHeightPx`

                      The height of the display in pixels.

                      minimum: 1

                    - `long displayWidthPx`

                      The width of the display in pixels.

                      minimum: 1

                    - `JsonValue name = "computer"`

                      Name of the tool.

                      This is how the tool will be called by the model and in `tool_use` blocks.

                    - `Optional<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> displayNumber`

                      The X11 display number (e.g. 0, 1) for the display.

                      minimum: 0

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolTextEditor20241022`

                    - `JsonValue type = "text_editor_20241022"`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolComputerUse20251124`

                    - `JsonValue type = "computer_20251124"`

                    - `long displayHeightPx`

                      The height of the display in pixels.

                      minimum: 1

                    - `long displayWidthPx`

                      The width of the display in pixels.

                      minimum: 1

                    - `JsonValue name = "computer"`

                      Name of the tool.

                      This is how the tool will be called by the model and in `tool_use` blocks.

                    - `Optional<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> displayNumber`

                      The X11 display number (e.g. 0, 1) for the display.

                      minimum: 0

                    - `Optional<Boolean> enableZoom`

                      Whether to enable an action to take a zoomed-in screenshot of the screen.

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaComputerToolset20260801`

                    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<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

                        `type`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

                        `cursor_position`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerDoubleClickConfig> doubleClick`

                        `double_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerHoldKeyConfig> holdKey`

                        `hold_key`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerKeyConfig> key`

                        `key`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerLeftClickConfig> leftClick`

                        `left_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

                        `left_click_drag`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

                        `left_mouse_down`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

                        `left_mouse_up`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerMiddleClickConfig> middleClick`

                        `middle_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerMouseMoveConfig> mouseMove`

                        `mouse_move`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerRightClickConfig> rightClick`

                        `right_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerScreenshotConfig> screenshot`

                        `screenshot`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerScrollConfig> scroll`

                        `scroll`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerTripleClickConfig> tripleClick`

                        `triple_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerWaitConfig> wait`

                        `wait`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerZoomConfig> zoom`

                        `zoom`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered 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 BetaToolTextEditor20250124`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolTextEditor20250429`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolTextEditor20250728`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Long> maxCharacters`

                      Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

                      minimum: 1

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaWebSearchTool20250305`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<List<String>> allowedDomains`

                      If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                    - `Optional<List<String>> blockedDomains`

                      If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> maxUses`

                      Maximum number of times the tool can be used in the API request.

                      minimum: 1

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                    - `Optional<BetaUserLocation> userLocation`

                      Parameters for the user's location. Used to provide more relevant search results.

                      - `JsonValue type = "approximate"`

                      - `Optional<String> city`

                        The city of the user.

                        minLength: 1, maxLength: 255

                      - `Optional<String> 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<String> region`

                        The region of the user.

                        minLength: 1, maxLength: 255

                      - `Optional<String> timezone`

                        The [IANA timezone](https://nodatime.org/TimeZones) of the user.

                        minLength: 1, maxLength: 255

                  - `class BetaWebFetchTool20250910`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<List<String>> allowedDomains`

                      List of domains to allow fetching from

                    - `Optional<List<String>> blockedDomains`

                      List of domains to block fetching from

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<BetaCitationsConfigParam> citations`

                      Citations configuration for fetched documents. Citations are disabled by default.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> 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<Long> maxUses`

                      Maximum number of times the tool can be used in the API request.

                      minimum: 1

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                    - `Optional<BetaWebFetchUrlSources> urlSources`

                      Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                      - `Optional<ClientToolResults> clientToolResults`

                        Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

                        - `class BetaWebFetchUrlSourceAll`

                          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 BetaWebFetchUrlSourceNone`

                          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 BetaWebFetchUrlSourceOnly`

                          The tool filter variant under which only the named tools' results
                          contribute.

                          - `JsonValue type = "only"`

                          - `List<BetaWebFetchUrlSourceToolReference> tools`

                            - `JsonValue type = "tool_reference"`

                            - `String name`

                        - `class BetaWebFetchUrlSourceExcept`

                          The tool filter variant under which every result but the named
                          tools' contributes.

                          - `JsonValue type = "except"`

                          - `List<BetaWebFetchUrlSourceToolReference> tools`

                            - `JsonValue type = "tool_reference"`

                            - `String name`

                      - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

                          The `url_sources` variant under which a source contributes in
                          full: every result of the tool filter's source, or all user input.

                        - `class BetaWebFetchUrlSourceNone`

                          The `url_sources` variant under which a source contributes nothing:
                          no result of the tool filter's source, or no user input.

                        - `class BetaWebFetchUrlSourceOnly`

                          The tool filter variant under which only the named tools' results
                          contribute.

                        - `class BetaWebFetchUrlSourceExcept`

                          The tool filter variant under which every result but the named
                          tools' contributes.

                      - `Optional<UserInput> userInput`

                        Whether URLs in user messages are fetchable: "all" or "none".

                        - `class BetaWebFetchUrlSourceAll`

                          The `url_sources` variant under which a source contributes in
                          full: every result of the tool filter's source, or all user input.

                        - `class BetaWebFetchUrlSourceNone`

                          The `url_sources` variant under which a source contributes nothing:
                          no result of the tool filter's source, or no user input.

                  - `class BetaWebSearchTool20260209`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<List<String>> allowedDomains`

                      If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                    - `Optional<List<String>> blockedDomains`

                      If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> maxUses`

                      Maximum number of times the tool can be used in the API request.

                      minimum: 1

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                    - `Optional<BetaUserLocation> userLocation`

                      Parameters for the user's location. Used to provide more relevant search results.

                  - `class BetaWebFetchTool20260209`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<List<String>> allowedDomains`

                      List of domains to allow fetching from

                    - `Optional<List<String>> blockedDomains`

                      List of domains to block fetching from

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<BetaCitationsConfigParam> citations`

                      Citations configuration for fetched documents. Citations are disabled by default.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> 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<Long> maxUses`

                      Maximum number of times the tool can be used in the API request.

                      minimum: 1

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                    - `Optional<BetaWebFetchUrlSources> urlSources`

                      Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                  - `class BetaWebFetchTool20260309`

                    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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<List<String>> allowedDomains`

                      List of domains to allow fetching from

                    - `Optional<List<String>> blockedDomains`

                      List of domains to block fetching from

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<BetaCitationsConfigParam> citations`

                      Citations configuration for fetched documents. Citations are disabled by default.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> 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<Long> maxUses`

                      Maximum number of times the tool can be used in the API request.

                      minimum: 1

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                    - `Optional<BetaWebFetchUrlSources> urlSources`

                      Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                    - `Optional<Boolean> 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 BetaWebSearchTool20260318`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<List<String>> allowedDomains`

                      If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                    - `Optional<List<String>> blockedDomains`

                      If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> maxUses`

                      Maximum number of times the tool can be used in the API request.

                      minimum: 1

                    - `Optional<ResponseInclusion> 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<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                    - `Optional<BetaUserLocation> userLocation`

                      Parameters for the user's location. Used to provide more relevant search results.

                  - `class BetaWebFetchTool20260318`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<List<String>> allowedDomains`

                      List of domains to allow fetching from

                    - `Optional<List<String>> blockedDomains`

                      List of domains to block fetching from

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<BetaCitationsConfigParam> citations`

                      Citations configuration for fetched documents. Citations are disabled by default.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> 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<Long> maxUses`

                      Maximum number of times the tool can be used in the API request.

                      minimum: 1

                    - `Optional<ResponseInclusion> 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<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                    - `Optional<BetaWebFetchUrlSources> urlSources`

                      Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                    - `Optional<Boolean> 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 BetaAdvisorTool20260301`

                    - `JsonValue type = "advisor_20260301"`

                    - `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 name = "advisor"`

                      Name of the tool.

                      This is how the tool will be called by the model and in `tool_use` blocks.

                    - `Optional<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<BetaCacheControlEphemeral> caching`

                      Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> maxTokens`

                      Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

                      minimum: 1024

                    - `Optional<Long> maxUses`

                      Maximum number of times the tool can be used in the API request.

                      minimum: 1

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolSearchToolRegex20251119`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaMcpToolset`

                    Configuration for a group of tools from an MCP server.

                    Allows configuring enabled status and defer_loading for all tools
                    from an MCP server, with optional per-tool overrides.

                    - `JsonValue type = "mcp_toolset"`

                    - `String mcpServerName`

                      Name of the MCP server to configure tools for

                      minLength: 1, maxLength: 255

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Configs> configs`

                      Configuration overrides for specific tools, keyed by tool name

                      - `Optional<Boolean> deferLoading`

                      - `Optional<Boolean> enabled`

                    - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

                      Default configuration applied to all tools from this server

                      - `Optional<Boolean> deferLoading`

                      - `Optional<Boolean> enabled`

                    - `Optional<List<BetaMcpToolParam>> tools`

                      The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

                      - `InputSchema inputSchema`

                        The tool's input schema as the MCP server lists it, verbatim.

                      - `String name`

                        The tool's name as the MCP server lists it (not prefixed with the server name).

                        minLength: 1

                      - `Optional<String> description`

                        The tool's description as the MCP server lists it.

            - `Optional<BetaCacheControlEphemeral> cacheControl`

              Create a cache control breakpoint at this content block.

          - `class BetaRequestToolRemovalBlock`

            Mid-conversation directive to withdraw a tool.

            `tool` references a tool (or MCP toolset) by name: one declared in the
            request's `tools` or defined earlier in `messages`. It is no longer
            offered to the model from this point in the conversation onward.

            - `JsonValue type = "tool_removal"`

            - `Tool tool`

              - `class BetaToolChangeToolReference`

                Reference to a single tool, by the name the model uses to call it: a
                tool declared in `tools` or defined by an earlier `tool_addition`
                block. Does not accept the composed `{server}_{name}` form the server
                assigns to MCP-resolved tools; use `mcp_tool_reference` or
                `mcp_toolset_reference` for those.

              - `class BetaToolChangeMcpToolReference`

                Reference to a single MCP tool by its server and remote name; the
                same `server_name`/`name` pair `mcp_tool_use` carries.

              - `class BetaToolChangeMcpToolsetReference`

                Reference to every tool in the named MCP server's toolset.

            - `Optional<BetaCacheControlEphemeral> cacheControl`

              Create a cache control breakpoint at this content block.

      - `class BetaRequestToolAdditionBlock`

        Mid-conversation directive to make a tool available.

        `tool` is a reference to a tool (or MCP toolset) declared in the
        request's `tools`. Under the `inline-tools-2026-09-15` beta it may
        instead be a reference to a tool defined earlier in `messages`, or a
        `tool_definition` object that carries an inline tool definition in
        `definition` (the same object a `tools` entry holds). An `mcp_toolset`
        definition also requires the `mcp-client-2026-09-15` beta. The tool is
        offered to the model from this point in the conversation onward.

      - `class BetaRequestToolRemovalBlock`

        Mid-conversation directive to withdraw a tool.

        `tool` references a tool (or MCP toolset) by name: one declared in the
        request's `tools` or defined earlier in `messages`. It is no longer
        offered to the model from this point in the conversation onward.

      - `class BetaMcpToolListingBlockParam`

        The tool listing an MCP server returned while an earlier response was
        produced, as that response carried it. Send the assistant message back
        unchanged, this block included, and the server uses this listing for the
        matching `mcp_toolset` instead of asking the MCP server again.

        - `JsonValue type = "mcp_tool_listing"`

        - `String mcpServerName`

          The name of the MCP server this listing came from, as `mcp_servers` declares it.

          minLength: 1, maxLength: 255

        - `List<BetaMcpToolParam> tools`

          The server's tools, exactly as the response listed them.

          - `InputSchema inputSchema`

            The tool's input schema as the MCP server lists it, verbatim.

          - `String name`

            The tool's name as the MCP server lists it (not prefixed with the server name).

            minLength: 1

          - `Optional<String> description`

            The tool's description as the MCP server lists it.

      - `class BetaFallbackBlockParam`

        A `fallback` block echoed back from a prior response.

        Accepted in `messages[].content` and not rendered into the prompt; not
        validated against the request's `fallbacks` chain or top-level `model`.

        Echo the assistant turn back verbatim, including this block in its
        original position. The block marks the boundary between content produced
        before and after a fallback hop, and the server relies on that boundary
        to validate the turn: when thinking runs flank the boundary, omitting
        the block merges them into one span the server cannot validate (the
        request is rejected), and moving it into the middle of a single run is
        likewise rejected; between non-thinking blocks the block's placement has
        no validation effect.

        - `JsonValue type = "fallback"`

        - `BetaFallbackInfoParam from`

          Identifies one hop of a fallback transition.

          - `Model model`

            The model that will complete your prompt.

            See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

        - `BetaFallbackInfoParam to`

          Identifies one hop of a fallback transition.

        - `Optional<JsonValue> trigger`

          The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed.

  - `Role role`

    - `USER("user")`

    - `ASSISTANT("assistant")`

    - `SYSTEM("system")`

  - `Optional<ClearAt> clearAt`

    How long this system message's text stays in front of the model. `"never"` (the default) renders it on every request that includes it. `"next_user_message"` renders it only for the user turn it follows: once a later `role: "user"` message exists in `messages` the message stays in the array (send it unchanged) but is no longer shown to the model. Only permitted on `role: "system"` messages.

    - `NEXT_USER_MESSAGE("next_user_message")`

    - `NEVER("never")`

  - `Optional<BetaSystemMessageOutputConfig> outputConfig`

    Per-message output configuration on a role:"system" input message.

    Fields here apply per-turn; `format` remains top-level only. An
    empty `{}` is accepted on a message that carries content; a message
    with neither content nor output_config fields is rejected.

    - `Optional<Effort> 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")`

### Beta Message Tokens Count

- `class BetaMessageTokensCount`

  - `Optional<BetaCountTokensContextManagementResponse> contextManagement`

    Information about context management applied to the message.

    - `long originalInputTokens`

      The original token count before context management was applied

  - `long inputTokens`

    The total number of tokens across the provided list of messages, system prompt, and tools.

### Beta Metadata

- `class BetaMetadata`

  - `Optional<String> 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

### Beta Output Config

- `class BetaOutputConfig`

  - `Optional<Effort> 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<BetaJsonOutputFormat> 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<BetaTokenTaskBudget> taskBudget`

    Configuration for token budget tracking across contexts.

    - `JsonValue type = "tokens"`

      The budget type. Currently only 'tokens' is supported.

    - `long total`

      Total token budget across all contexts in the session.

      minimum: 1024

    - `Optional<Long> remaining`

      Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided.

      minimum: 0

### Beta Output Tokens Details

- `class BetaOutputTokensDetails`

  - `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

### Beta Plain Text Source

- `class BetaPlainTextSource`

  - `JsonValue type = "text"`

  - `String data`

  - `JsonValue mediaType = "text/plain"`

### Beta Raw Content Block Delta

- `class BetaRawContentBlockDelta: union`

  - `class BetaTextDelta`

    - `JsonValue type = "text_delta"`

    - `String text`

  - `class BetaInputJsonDelta`

    - `JsonValue type = "input_json_delta"`

    - `String partialJson`

  - `class BetaCitationsDelta`

    - `JsonValue type = "citations_delta"`

    - `Citation citation`

      - `class BetaCitationCharLocation`

        - `JsonValue type = "char_location"`

        - `String citedText`

        - `long documentIndex`

          minimum: 0

        - `Optional<String> documentTitle`

        - `long endCharIndex`

        - `Optional<String> fileId`

        - `long startCharIndex`

          minimum: 0

      - `class BetaCitationPageLocation`

        - `JsonValue type = "page_location"`

        - `String citedText`

        - `long documentIndex`

          minimum: 0

        - `Optional<String> documentTitle`

        - `long endPageNumber`

        - `Optional<String> fileId`

        - `long startPageNumber`

          minimum: 1

      - `class BetaCitationContentBlockLocation`

        - `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<String> 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<String> fileId`

        - `long startBlockIndex`

          0-based index of the first cited block in the source's `content` array.

          minimum: 0

      - `class BetaCitationsWebSearchResultLocation`

        - `JsonValue type = "web_search_result_location"`

        - `String citedText`

        - `String encryptedIndex`

        - `Optional<String> title`

          maxLength: 512

        - `String url`

      - `class BetaCitationSearchResultLocation`

        - `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<String> title`

  - `class BetaThinkingDelta`

    - `JsonValue type = "thinking_delta"`

    - `Optional<Long> estimatedTokens`

      Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative.

    - `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 BetaSignatureDelta`

    - `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.

  - `class BetaCompactionContentBlockDelta`

    - `JsonValue type = "compaction_delta"`

    - `Optional<String> content`

    - `Optional<String> encryptedContent`

      Opaque metadata from prior compaction, to be round-tripped verbatim

### Beta Raw Content Block Delta Event

- `class BetaRawContentBlockDeltaEvent`

  - `JsonValue type = "content_block_delta"`

  - `BetaRawContentBlockDelta delta`

    - `class BetaTextDelta`

      - `JsonValue type = "text_delta"`

      - `String text`

    - `class BetaInputJsonDelta`

      - `JsonValue type = "input_json_delta"`

      - `String partialJson`

    - `class BetaCitationsDelta`

      - `JsonValue type = "citations_delta"`

      - `Citation citation`

        - `class BetaCitationCharLocation`

          - `JsonValue type = "char_location"`

          - `String citedText`

          - `long documentIndex`

            minimum: 0

          - `Optional<String> documentTitle`

          - `long endCharIndex`

          - `Optional<String> fileId`

          - `long startCharIndex`

            minimum: 0

        - `class BetaCitationPageLocation`

          - `JsonValue type = "page_location"`

          - `String citedText`

          - `long documentIndex`

            minimum: 0

          - `Optional<String> documentTitle`

          - `long endPageNumber`

          - `Optional<String> fileId`

          - `long startPageNumber`

            minimum: 1

        - `class BetaCitationContentBlockLocation`

          - `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<String> 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<String> fileId`

          - `long startBlockIndex`

            0-based index of the first cited block in the source's `content` array.

            minimum: 0

        - `class BetaCitationsWebSearchResultLocation`

          - `JsonValue type = "web_search_result_location"`

          - `String citedText`

          - `String encryptedIndex`

          - `Optional<String> title`

            maxLength: 512

          - `String url`

        - `class BetaCitationSearchResultLocation`

          - `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<String> title`

    - `class BetaThinkingDelta`

      - `JsonValue type = "thinking_delta"`

      - `Optional<Long> estimatedTokens`

        Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative.

      - `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 BetaSignatureDelta`

      - `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.

    - `class BetaCompactionContentBlockDelta`

      - `JsonValue type = "compaction_delta"`

      - `Optional<String> content`

      - `Optional<String> encryptedContent`

        Opaque metadata from prior compaction, to be round-tripped verbatim

  - `long index`

### Beta Raw Content Block Start Event

- `class BetaRawContentBlockStartEvent`

  - `JsonValue type = "content_block_start"`

  - `ContentBlock contentBlock`

    - `class BetaTextBlock`

      - `JsonValue type = "text"`

      - `Optional<List<BetaTextCitation>> 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 BetaCitationCharLocation`

          - `JsonValue type = "char_location"`

          - `String citedText`

          - `long documentIndex`

            minimum: 0

          - `Optional<String> documentTitle`

          - `long endCharIndex`

          - `Optional<String> fileId`

          - `long startCharIndex`

            minimum: 0

        - `class BetaCitationPageLocation`

          - `JsonValue type = "page_location"`

          - `String citedText`

          - `long documentIndex`

            minimum: 0

          - `Optional<String> documentTitle`

          - `long endPageNumber`

          - `Optional<String> fileId`

          - `long startPageNumber`

            minimum: 1

        - `class BetaCitationContentBlockLocation`

          - `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<String> 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<String> fileId`

          - `long startBlockIndex`

            0-based index of the first cited block in the source's `content` array.

            minimum: 0

        - `class BetaCitationsWebSearchResultLocation`

          - `JsonValue type = "web_search_result_location"`

          - `String citedText`

          - `String encryptedIndex`

          - `Optional<String> title`

            maxLength: 512

          - `String url`

        - `class BetaCitationSearchResultLocation`

          - `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<String> title`

      - `String text`

    - `class BetaThinkingBlock`

      - `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 BetaRedactedThinkingBlock`

      - `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 BetaToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `Input input`

      - `String name`

        minLength: 1

      - `Optional<Caller> caller`

        - `class BetaDirectCaller`

          Tool invocation directly from the model.

          - `JsonValue type = "direct"`

        - `class BetaServerToolCaller`

          Tool invocation generated by a server-side tool.

          - `JsonValue type = "code_execution_20250825"`

          - `String toolId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `class BetaServerToolCaller20260120`

          - `JsonValue type = "code_execution_20260120"`

          - `String toolId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `Optional<String> toolsetName`

        For a toolset member tool_use, the toolset family.

        minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$

    - `class BetaServerToolUseBlock`

      - `JsonValue type = "server_tool_use"`

      - `String id`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `Input input`

      - `Name name`

        - `ADVISOR("advisor")`

        - `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<Caller> caller`

        - `class BetaDirectCaller`

          Tool invocation directly from the model.

        - `class BetaServerToolCaller`

          Tool invocation generated by a server-side tool.

        - `class BetaServerToolCaller20260120`

    - `class BetaWebSearchToolResultBlock`

      - `JsonValue type = "web_search_tool_result"`

      - `BetaWebSearchToolResultBlockContent content`

        - `class BetaWebSearchToolResultError`

          - `JsonValue type = "web_search_tool_result_error"`

          - `BetaWebSearchToolResultErrorCode 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<BetaWebSearchResultBlock>`

          - `JsonValue type = "web_search_result"`

          - `String encryptedContent`

          - `Optional<String> pageAge`

          - `String title`

          - `String url`

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `Optional<Caller> caller`

        - `class BetaDirectCaller`

          Tool invocation directly from the model.

        - `class BetaServerToolCaller`

          Tool invocation generated by a server-side tool.

        - `class BetaServerToolCaller20260120`

    - `class BetaWebFetchToolResultBlock`

      - `JsonValue type = "web_fetch_tool_result"`

      - `Content content`

        - `class BetaWebFetchToolResultErrorBlock`

          - `JsonValue type = "web_fetch_tool_result_error"`

          - `BetaWebFetchToolResultErrorCode 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 BetaWebFetchBlock`

          - `JsonValue type = "web_fetch_result"`

          - `BetaDocumentBlock content`

            - `JsonValue type = "document"`

            - `Optional<BetaCitationConfig> citations`

              Citation configuration for the document

              - `boolean enabled`

            - `Source source`

              - `class BetaBase64PdfSource`

                - `JsonValue type = "base64"`

                - `String data`

                  format: byte

                - `JsonValue mediaType = "application/pdf"`

              - `class BetaPlainTextSource`

                - `JsonValue type = "text"`

                - `String data`

                - `JsonValue mediaType = "text/plain"`

            - `Optional<String> title`

              The title of the document

          - `Optional<String> retrievedAt`

            ISO 8601 timestamp when the content was retrieved

          - `String url`

            Fetched content URL

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `Optional<Caller> caller`

        - `class BetaDirectCaller`

          Tool invocation directly from the model.

        - `class BetaServerToolCaller`

          Tool invocation generated by a server-side tool.

        - `class BetaServerToolCaller20260120`

    - `class BetaAdvisorToolResultBlock`

      - `JsonValue type = "advisor_tool_result"`

      - `Content content`

        - `class BetaAdvisorToolResultError`

          - `JsonValue type = "advisor_tool_result_error"`

          - `ErrorCode errorCode`

            - `MAX_USES_EXCEEDED("max_uses_exceeded")`

            - `PROMPT_TOO_LONG("prompt_too_long")`

            - `TOO_MANY_REQUESTS("too_many_requests")`

            - `OVERLOADED("overloaded")`

            - `UNAVAILABLE("unavailable")`

            - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

            - `MODEL_NOT_FOUND("model_not_found")`

        - `class BetaAdvisorResultBlock`

          - `JsonValue type = "advisor_result"`

          - `Optional<String> stopReason`

            The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap.

          - `String text`

        - `class BetaAdvisorRedactedResultBlock`

          - `JsonValue type = "advisor_redacted_result"`

          - `String encryptedContent`

            Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify.

          - `Optional<String> stopReason`

            The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`).

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaCodeExecutionToolResultBlock`

      - `JsonValue type = "code_execution_tool_result"`

      - `BetaCodeExecutionToolResultBlockContent content`

        - `class BetaCodeExecutionToolResultError`

          - `JsonValue type = "code_execution_tool_result_error"`

          - `BetaCodeExecutionToolResultErrorCode errorCode`

            - `INVALID_TOOL_INPUT("invalid_tool_input")`

            - `UNAVAILABLE("unavailable")`

            - `TOO_MANY_REQUESTS("too_many_requests")`

            - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

        - `class BetaCodeExecutionResultBlock`

          - `JsonValue type = "code_execution_result"`

          - `List<BetaCodeExecutionOutputBlock> content`

            - `JsonValue type = "code_execution_output"`

            - `String fileId`

          - `long returnCode`

          - `String stderr`

          - `String stdout`

        - `class BetaEncryptedCodeExecutionResultBlock`

          Code execution result with encrypted stdout for PFC + web_search results.

          - `JsonValue type = "encrypted_code_execution_result"`

          - `List<BetaCodeExecutionOutputBlock> content`

            - `JsonValue type = "code_execution_output"`

            - `String fileId`

          - `String encryptedStdout`

          - `long returnCode`

          - `String stderr`

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaBashCodeExecutionToolResultBlock`

      - `JsonValue type = "bash_code_execution_tool_result"`

      - `Content content`

        - `class BetaBashCodeExecutionToolResultError`

          - `JsonValue type = "bash_code_execution_tool_result_error"`

          - `ErrorCode 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 BetaBashCodeExecutionResultBlock`

          - `JsonValue type = "bash_code_execution_result"`

          - `List<BetaBashCodeExecutionOutputBlock> content`

            - `JsonValue type = "bash_code_execution_output"`

            - `String fileId`

          - `long returnCode`

          - `String stderr`

          - `String stdout`

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaTextEditorCodeExecutionToolResultBlock`

      - `JsonValue type = "text_editor_code_execution_tool_result"`

      - `Content content`

        - `class BetaTextEditorCodeExecutionToolResultError`

          - `JsonValue type = "text_editor_code_execution_tool_result_error"`

          - `ErrorCode 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<String> errorMessage`

        - `class BetaTextEditorCodeExecutionViewResultBlock`

          - `JsonValue type = "text_editor_code_execution_view_result"`

          - `String content`

          - `FileType fileType`

            - `TEXT("text")`

            - `IMAGE("image")`

            - `PDF("pdf")`

          - `Optional<Long> numLines`

          - `Optional<Long> startLine`

          - `Optional<Long> totalLines`

        - `class BetaTextEditorCodeExecutionCreateResultBlock`

          - `JsonValue type = "text_editor_code_execution_create_result"`

          - `boolean isFileUpdate`

        - `class BetaTextEditorCodeExecutionStrReplaceResultBlock`

          - `JsonValue type = "text_editor_code_execution_str_replace_result"`

          - `Optional<List<String>> lines`

          - `Optional<Long> newLines`

          - `Optional<Long> newStart`

          - `Optional<Long> oldLines`

          - `Optional<Long> oldStart`

      - `String toolUseId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaToolSearchToolResultBlock`

      - `JsonValue type = "tool_search_tool_result"`

      - `Content content`

        - `class BetaToolSearchToolResultError`

          - `JsonValue type = "tool_search_tool_result_error"`

          - `ErrorCode errorCode`

            - `INVALID_TOOL_INPUT("invalid_tool_input")`

            - `UNAVAILABLE("unavailable")`

            - `TOO_MANY_REQUESTS("too_many_requests")`

            - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

          - `Optional<String> errorMessage`

        - `class BetaToolSearchToolSearchResultBlock`

          - `JsonValue type = "tool_search_tool_search_result"`

          - `List<BetaToolReferenceBlock> 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 BetaMcpToolUseBlock`

      - `JsonValue type = "mcp_tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `Input input`

      - `String name`

        The name of the MCP tool

      - `String serverName`

        The name of the MCP server

    - `class BetaMcpToolResultBlock`

      - `JsonValue type = "mcp_tool_result"`

      - `Content content`

        - `String`

        - `List<BetaTextBlock>`

          - `JsonValue type = "text"`

          - `Optional<List<BetaTextCitation>> 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`.

          - `String text`

      - `boolean isError`

      - `String toolUseId`

        pattern: ^[a-zA-Z0-9_-]+$

    - `class BetaContainerUploadBlock`

      Response model for a file uploaded to the container.

      - `JsonValue type = "container_upload"`

      - `String fileId`

    - `class BetaCompactionBlock`

      A compaction block returned when autocompact is triggered.

      When content is None, it indicates the compaction failed to produce a valid
      summary (e.g., malformed output from the model). Clients may round-trip
      compaction blocks with null content; the server treats them as no-ops.

      - `JsonValue type = "compaction"`

      - `Optional<String> content`

        Summary of compacted content, or null if compaction failed

      - `Optional<String> encryptedContent`

        Opaque metadata from prior compaction, to be round-tripped verbatim

      - `Optional<String> signature`

        Signature over the summary, to be sent back with the block verbatim

      - `Optional<List<ToolChange>> toolChanges`

        The tool changes of the compacted range: the `tool_addition` and `tool_removal` blocks that take the request's `tools` to the tool set in effect at the end of the range, or `[]` when the range changed no tool. Absent when the server did not compute them. Send the block back unchanged.

        - `class BetaResponseToolAdditionBlock`

          An entry of a `compaction` block's `tool_changes`: a tool the
          compacted range made available, as a reference to a `tools` entry or
          MCP toolset, or as the tool definition in effect at the end of the
          range, by value. Send it back unchanged.

          - `JsonValue type = "tool_addition"`

          - `Tool tool`

            The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value.

            - `class BetaResponseToolChangeToolReference`

              Reference to a single tool, by the name the model uses to call it, as
              a `compaction` block's `tool_changes` entry reports it: a tool
              declared in `tools` or defined by an earlier `tool_addition` block.
              Send it back unchanged with the block.

              - `JsonValue type = "tool_reference"`

              - `String name`

            - `class BetaResponseToolChangeMcpToolReference`

              Reference to a single MCP tool, by its server and its name on that
              server, as a `compaction` block's `tool_changes` entry reports it.
              Send it back unchanged with the block.

              - `JsonValue type = "mcp_tool_reference"`

              - `String name`

              - `String serverName`

            - `class BetaResponseToolChangeMcpToolsetReference`

              Reference to every tool in the named MCP server's toolset, as a
              `compaction` block's `tool_changes` entry reports it. Send it back
              unchanged with the block.

              - `JsonValue type = "mcp_toolset_reference"`

              - `String serverName`

            - `class BetaToolChangeToolDefinition`

              A tool defined by value, as a `compaction` block's `tool_changes` entry
              reports it: `definition` is the tool's definition as it was sent, in the
              form of a `tools` entry, without `cache_control`. Send it back unchanged
              with the block.

              - `JsonValue type = "tool_definition"`

              - `BetaResponseToolUnion definition`

                - `class BetaResponseTool`

                  A custom tool definition, as sent.

                  - `Optional<Type> type`

                  - `BetaResponseToolInputSchema 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> properties`

                    - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolBash20241022`

                  - `JsonValue type = "bash_20241022"`

                  - `JsonValue name = "bash"`

                    Name of the tool.

                    This is how the tool will be called by the model and in `tool_use` blocks.

                  - `Optional<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                    - `JsonValue type = "ephemeral"`

                    - `Optional<Ttl> 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<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolBash20250124`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaCodeExecutionTool20250522`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaCodeExecutionTool20250825`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaCodeExecutionTool20260120`

                  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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaCodeExecutionTool20260521`

                  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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaBrowserToolset20260801`

                  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<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

                      `type`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserCloseTabConfig> closeTab`

                      `close_tab`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

                      `double_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserFileUploadConfig> fileUpload`

                      `file_upload`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserFindConfig> find`

                      `find`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserFormInputConfig> formInput`

                      `form_input`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserGetPageTextConfig> getPageText`

                      `get_page_text`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserHoldKeyConfig> holdKey`

                      `hold_key`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserHoverConfig> hover`

                      `hover`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

                      `javascript_exec`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserKeyConfig> key`

                      `key`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserLeftClickConfig> leftClick`

                      `left_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

                      `left_click_drag`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

                      `left_mouse_down`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

                      `left_mouse_up`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserListTabsConfig> listTabs`

                      `list_tabs`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserMiddleClickConfig> middleClick`

                      `middle_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

                      `mouse_move`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserNavigateConfig> navigate`

                      `navigate`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserNewTabConfig> newTab`

                      `new_tab`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserReadConsoleConfig> readConsole`

                      `read_console`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

                      `read_network`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserReadPageConfig> readPage`

                      `read_page`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserRightClickConfig> rightClick`

                      `right_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserScreenshotConfig> screenshot`

                      `screenshot`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserScrollConfig> scroll`

                      `scroll`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserScrollToConfig> scrollTo`

                      `scroll_to`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserSwitchTabConfig> switchTab`

                      `switch_tab`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserTripleClickConfig> tripleClick`

                      `triple_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserWaitConfig> wait`

                      `wait`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaBrowserZoomConfig> zoom`

                      `zoom`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered 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 BetaToolComputerUse20241022`

                  - `JsonValue type = "computer_20241022"`

                  - `long displayHeightPx`

                    The height of the display in pixels.

                    minimum: 1

                  - `long displayWidthPx`

                    The width of the display in pixels.

                    minimum: 1

                  - `JsonValue name = "computer"`

                    Name of the tool.

                    This is how the tool will be called by the model and in `tool_use` blocks.

                  - `Optional<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> displayNumber`

                    The X11 display number (e.g. 0, 1) for the display.

                    minimum: 0

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaMemoryTool20250818`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolComputerUse20250124`

                  - `JsonValue type = "computer_20250124"`

                  - `long displayHeightPx`

                    The height of the display in pixels.

                    minimum: 1

                  - `long displayWidthPx`

                    The width of the display in pixels.

                    minimum: 1

                  - `JsonValue name = "computer"`

                    Name of the tool.

                    This is how the tool will be called by the model and in `tool_use` blocks.

                  - `Optional<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> displayNumber`

                    The X11 display number (e.g. 0, 1) for the display.

                    minimum: 0

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolTextEditor20241022`

                  - `JsonValue type = "text_editor_20241022"`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolComputerUse20251124`

                  - `JsonValue type = "computer_20251124"`

                  - `long displayHeightPx`

                    The height of the display in pixels.

                    minimum: 1

                  - `long displayWidthPx`

                    The width of the display in pixels.

                    minimum: 1

                  - `JsonValue name = "computer"`

                    Name of the tool.

                    This is how the tool will be called by the model and in `tool_use` blocks.

                  - `Optional<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> displayNumber`

                    The X11 display number (e.g. 0, 1) for the display.

                    minimum: 0

                  - `Optional<Boolean> enableZoom`

                    Whether to enable an action to take a zoomed-in screenshot of the screen.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaComputerToolset20260801`

                  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<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

                      `type`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

                      `cursor_position`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerDoubleClickConfig> doubleClick`

                      `double_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerHoldKeyConfig> holdKey`

                      `hold_key`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerKeyConfig> key`

                      `key`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerLeftClickConfig> leftClick`

                      `left_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

                      `left_click_drag`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

                      `left_mouse_down`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

                      `left_mouse_up`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerMiddleClickConfig> middleClick`

                      `middle_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerMouseMoveConfig> mouseMove`

                      `mouse_move`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerRightClickConfig> rightClick`

                      `right_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerScreenshotConfig> screenshot`

                      `screenshot`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerScrollConfig> scroll`

                      `scroll`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerTripleClickConfig> tripleClick`

                      `triple_click`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerWaitConfig> wait`

                      `wait`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                    - `Optional<BetaComputerZoomConfig> zoom`

                      `zoom`'s config overrides.

                      - `Optional<Boolean> deferLoading`

                        Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                      - `Optional<Boolean> enabled`

                        Whether this member is offered 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 BetaToolTextEditor20250124`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolTextEditor20250429`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolTextEditor20250728`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<List<InputExample>> inputExamples`

                  - `Optional<Long> maxCharacters`

                    Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaWebSearchTool20250305`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                  - `Optional<List<String>> blockedDomains`

                    If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaUserLocation> userLocation`

                    Parameters for the user's location. Used to provide more relevant search results.

                    - `JsonValue type = "approximate"`

                    - `Optional<String> city`

                      The city of the user.

                      minLength: 1, maxLength: 255

                    - `Optional<String> 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<String> region`

                      The region of the user.

                      minLength: 1, maxLength: 255

                    - `Optional<String> timezone`

                      The [IANA timezone](https://nodatime.org/TimeZones) of the user.

                      minLength: 1, maxLength: 255

                - `class BetaWebFetchTool20250910`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    List of domains to allow fetching from

                  - `Optional<List<String>> blockedDomains`

                    List of domains to block fetching from

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaCitationsConfigParam> citations`

                    Citations configuration for fetched documents. Citations are disabled by default.

                    - `Optional<Boolean> enabled`

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> 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<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaWebFetchUrlSources> urlSources`

                    Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                    - `Optional<ClientToolResults> clientToolResults`

                      Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

                      - `class BetaWebFetchUrlSourceAll`

                        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 BetaWebFetchUrlSourceNone`

                        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 BetaWebFetchUrlSourceOnly`

                        The tool filter variant under which only the named tools' results
                        contribute.

                        - `JsonValue type = "only"`

                        - `List<BetaWebFetchUrlSourceToolReference> tools`

                          - `JsonValue type = "tool_reference"`

                          - `String name`

                      - `class BetaWebFetchUrlSourceExcept`

                        The tool filter variant under which every result but the named
                        tools' contributes.

                        - `JsonValue type = "except"`

                        - `List<BetaWebFetchUrlSourceToolReference> tools`

                          - `JsonValue type = "tool_reference"`

                          - `String name`

                    - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

                        The `url_sources` variant under which a source contributes in
                        full: every result of the tool filter's source, or all user input.

                      - `class BetaWebFetchUrlSourceNone`

                        The `url_sources` variant under which a source contributes nothing:
                        no result of the tool filter's source, or no user input.

                      - `class BetaWebFetchUrlSourceOnly`

                        The tool filter variant under which only the named tools' results
                        contribute.

                      - `class BetaWebFetchUrlSourceExcept`

                        The tool filter variant under which every result but the named
                        tools' contributes.

                    - `Optional<UserInput> userInput`

                      Whether URLs in user messages are fetchable: "all" or "none".

                      - `class BetaWebFetchUrlSourceAll`

                        The `url_sources` variant under which a source contributes in
                        full: every result of the tool filter's source, or all user input.

                      - `class BetaWebFetchUrlSourceNone`

                        The `url_sources` variant under which a source contributes nothing:
                        no result of the tool filter's source, or no user input.

                - `class BetaWebSearchTool20260209`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                  - `Optional<List<String>> blockedDomains`

                    If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaUserLocation> userLocation`

                    Parameters for the user's location. Used to provide more relevant search results.

                - `class BetaWebFetchTool20260209`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    List of domains to allow fetching from

                  - `Optional<List<String>> blockedDomains`

                    List of domains to block fetching from

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaCitationsConfigParam> citations`

                    Citations configuration for fetched documents. Citations are disabled by default.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> 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<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaWebFetchUrlSources> urlSources`

                    Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                - `class BetaWebFetchTool20260309`

                  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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    List of domains to allow fetching from

                  - `Optional<List<String>> blockedDomains`

                    List of domains to block fetching from

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaCitationsConfigParam> citations`

                    Citations configuration for fetched documents. Citations are disabled by default.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> 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<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaWebFetchUrlSources> urlSources`

                    Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                  - `Optional<Boolean> 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 BetaWebSearchTool20260318`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                  - `Optional<List<String>> blockedDomains`

                    If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<ResponseInclusion> 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<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaUserLocation> userLocation`

                    Parameters for the user's location. Used to provide more relevant search results.

                - `class BetaWebFetchTool20260318`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<List<String>> allowedDomains`

                    List of domains to allow fetching from

                  - `Optional<List<String>> blockedDomains`

                    List of domains to block fetching from

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaCitationsConfigParam> citations`

                    Citations configuration for fetched documents. Citations are disabled by default.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> 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<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<ResponseInclusion> 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<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                  - `Optional<BetaWebFetchUrlSources> urlSources`

                    Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                  - `Optional<Boolean> 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 BetaAdvisorTool20260301`

                  - `JsonValue type = "advisor_20260301"`

                  - `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 name = "advisor"`

                    Name of the tool.

                    This is how the tool will be called by the model and in `tool_use` blocks.

                  - `Optional<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaCacheControlEphemeral> caching`

                    Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Long> maxTokens`

                    Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

                    minimum: 1024

                  - `Optional<Long> maxUses`

                    Maximum number of times the tool can be used in the API request.

                    minimum: 1

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaToolSearchToolRegex20251119`

                  - `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<List<AllowedCaller>> allowedCallers`

                    - `DIRECT("direct")`

                    - `CODE_EXECUTION_20250825("code_execution_20250825")`

                    - `CODE_EXECUTION_20260120("code_execution_20260120")`

                    - `CODE_EXECUTION_20260521("code_execution_20260521")`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Boolean> deferLoading`

                    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                  - `Optional<Boolean> strict`

                    When true, guarantees schema validation on tool names and inputs

                - `class BetaMcpToolset`

                  Configuration for a group of tools from an MCP server.

                  Allows configuring enabled status and defer_loading for all tools
                  from an MCP server, with optional per-tool overrides.

                  - `JsonValue type = "mcp_toolset"`

                  - `String mcpServerName`

                    Name of the MCP server to configure tools for

                    minLength: 1, maxLength: 255

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<Configs> configs`

                    Configuration overrides for specific tools, keyed by tool name

                    - `Optional<Boolean> deferLoading`

                    - `Optional<Boolean> enabled`

                  - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

                    Default configuration applied to all tools from this server

                    - `Optional<Boolean> deferLoading`

                    - `Optional<Boolean> enabled`

                  - `Optional<List<BetaMcpToolParam>> tools`

                    The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

                    - `InputSchema inputSchema`

                      The tool's input schema as the MCP server lists it, verbatim.

                    - `String name`

                      The tool's name as the MCP server lists it (not prefixed with the server name).

                      minLength: 1

                    - `Optional<String> description`

                      The tool's description as the MCP server lists it.

        - `class BetaResponseToolRemovalBlock`

          An entry of a `compaction` block's `tool_changes`: a tool of the
          request's `tools` (or an MCP tool or toolset) that the compacted range
          withdrew. Send it back unchanged.

          - `JsonValue type = "tool_removal"`

          - `Tool tool`

            A reference to the withdrawn `tools` entry, MCP tool or MCP toolset.

            - `class BetaResponseToolChangeToolReference`

              Reference to a single tool, by the name the model uses to call it, as
              a `compaction` block's `tool_changes` entry reports it: a tool
              declared in `tools` or defined by an earlier `tool_addition` block.
              Send it back unchanged with the block.

            - `class BetaResponseToolChangeMcpToolReference`

              Reference to a single MCP tool, by its server and its name on that
              server, as a `compaction` block's `tool_changes` entry reports it.
              Send it back unchanged with the block.

            - `class BetaResponseToolChangeMcpToolsetReference`

              Reference to every tool in the named MCP server's toolset, as a
              `compaction` block's `tool_changes` entry reports it. Send it back
              unchanged with the block.

    - `class BetaFallbackBlock`

      Marks the point in `content` where one model's output gives way to the next.

      One block appears per hop where a preceding model actually ran this turn and
      declined. A turn where no preceding model ran and declined has no such
      boundary and carries no block — the signal for whether a fallback model
      served the response is the presence of a `fallback_message` entry in
      `usage.iterations`, not this block.

      The block is treated like a server-tool content block for streaming: it
      arrives via the standard `content_block_start` / `content_block_stop`
      pair and carries no deltas.

      - `JsonValue type = "fallback"`

      - `BetaFallbackInfo from`

        The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id.

        - `Model model`

          The model that will complete your prompt.

          See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

      - `BetaFallbackInfo to`

        The fallback model producing the content that follows this block. Its `model` is always the canonical id.

      - `BetaFallbackRefusalTrigger trigger`

        What caused the `from` model to hand over at this hop.

        - `JsonValue type = "refusal"`

        - `Optional<Category> category`

          The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.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.

    - `class BetaMcpToolListingBlock`

      The tool listing the server fetched from an MCP server while producing
      this response. Send the assistant message back unchanged, this block
      included, so later requests use this listing instead of asking the MCP
      server again.

      - `JsonValue type = "mcp_tool_listing"`

      - `String mcpServerName`

      - `List<BetaMcpTool> tools`

        - `InputSchema inputSchema`

        - `String name`

        - `Optional<String> description`

  - `long index`

### Beta Raw Content Block Stop Event

- `class BetaRawContentBlockStopEvent`

  - `JsonValue type = "content_block_stop"`

  - `long index`

### Beta Raw Message Delta Event

- `class BetaRawMessageDeltaEvent`

  - `JsonValue type = "message_delta"`

  - `Optional<BetaContextManagementResponse> contextManagement`

    Information about context management strategies applied during the request

    - `List<AppliedEdit> appliedEdits`

      List of context management edits that were applied.

      - `class BetaClearToolUses20250919EditResponse`

        - `JsonValue type = "clear_tool_uses_20250919"`

          The type of context management edit applied.

        - `long clearedInputTokens`

          Number of input tokens cleared by this edit.

          minimum: 0

        - `long clearedToolUses`

          Number of tool uses that were cleared.

          minimum: 0

      - `class BetaClearThinking20251015EditResponse`

        - `JsonValue type = "clear_thinking_20251015"`

          The type of context management edit applied.

        - `long clearedInputTokens`

          Number of input tokens cleared by this edit.

          minimum: 0

        - `long clearedThinkingTurns`

          Number of thinking turns that were cleared.

          minimum: 0

  - `Delta delta`

    - `Optional<BetaContainer> 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<List<BetaContainerSkill>> 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<BetaRefusalStopDetails> 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> 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<String> 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<String> fallbackCreditToken`

        Opaque code that refunds the cache-miss cost when retrying this refused
        request on the fallback model. Pass it as `fallback_credit_token` on the
        retry request. Expires 5 minutes after the refusal.

        The retry is sent either with the same request body (`system`, `messages`,
        `tools`, and other render-shaping fields), or with the same body plus one
        appended `assistant` message whose content is the partial text (with any
        trailing whitespace stripped from the final text block) and paired
        server-tool blocks from this refusal — which also authorizes that
        appended turn as an assistant-prefill continuation on models that otherwise
        disallow prefill. A token minted mid-server-tool-loop whose partial content
        was continuable may only be redeemed the second way — if a same-body retry
        is rejected with a 400 saying the token must be redeemed by continuing the
        partial response, retry the second way instead. Either way: same workspace,
        same platform; a mismatch is a 400. Resending a token for an already-warm
        prefix is permitted but yields no additional credit.

        `null` when the refused model isn't eligible for a fallback credit.

      - `Optional<Boolean> fallbackHasPrefillClaim`

        Whether the accompanying `fallback_credit_token` may be redeemed with the
        appended-assistant retry form. Only set when `fallback_credit_token` is
        present.

        `true`: retry by resending the same request body plus one appended
        `assistant` message whose content is this response's `content` with any
        trailing whitespace stripped from the final text block and unpaired
        `tool_use` blocks omitted (the same appended-turn shape described on
        `fallback_credit_token`), with the token attached. `false`: retry by
        resending the original request body unchanged, with the token attached —
        the appended-assistant form is not available for this refusal (no
        continuable partial content, or the request uses `output_format` or a
        `tool_choice` that forces tool use). One exception: when the request used
        `output_format` or a forced `tool_choice` and the refusal arrived after
        server tools (including MCP connector tools) had already executed, the
        token may not be redeemable by either retry form; if the exact-body retry
        is then rejected with a 400 saying the token must be redeemed by
        continuing the partial response, discard the token and retry without it.

        Advisory: if an appended-assistant retry is rejected with a 400 despite
        `true`, fall back to resending the original request body with the token.

      - `Optional<String> recommendedModel`

        The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise.

    - `Optional<BetaStopReason> stopReason`

      - `END_TURN("end_turn")`

      - `MAX_TOKENS("max_tokens")`

      - `STOP_SEQUENCE("stop_sequence")`

      - `TOOL_USE("tool_use")`

      - `PAUSE_TURN("pause_turn")`

      - `COMPACTION("compaction")`

      - `REFUSAL("refusal")`

      - `MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")`

    - `Optional<String> stopSequence`

  - `BetaMessageDeltaUsage 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<Long> cacheCreationInputTokens`

      The cumulative number of input tokens used to create the cache entry.

      minimum: 0

    - `Optional<Long> cacheReadInputTokens`

      The cumulative number of input tokens read from the cache.

      minimum: 0

    - `Optional<BetaFallbackCreditUsage> fallbackCredit`

      Outcome of the `fallback_credit_token` presented on this request.

      Present on every response to a non-batch request that carried a
      `fallback_credit_token`, in either redemption mode; absent otherwise (batch
      items accept and ignore the token and carry no outcome object).

      - `Status status`

        Whether the fallback-credit reprice was applied to this response's billing.

        A union discriminated on `type`. `redeemed`: the retry is billed as if
        the conversation had been on the retry model all along — including when the
        resulting shift is zero because there was nothing to move. `not_applied`:
        no reprice was applied; the arm's `reason` says why.

        - `class BetaFallbackCreditRedeemed`

          The reprice was applied: the retry is billed as if the conversation
          had been on the retry model all along.

          - `JsonValue type = "redeemed"`

        - `class BetaFallbackCreditNotApplied`

          No reprice was applied; `reason` says why.

          - `JsonValue type = "not_applied"`

          - `Reason reason`

            Why the reprice was not applied.

            A closed enum; additions to the redemption-check vocabulary arrive as
            deliberate schema updates.

            - `BODY_MISMATCH("body_mismatch")`

            - `CONTINUATION_EXCLUDED("continuation_excluded")`

            - `CONTINUATION_ONLY("continuation_only")`

            - `EXPIRED("expired")`

            - `INVALID_TARGET_MODEL("invalid_target_model")`

            - `NOT_ENABLED("not_enabled")`

            - `REPRICE_UNAVAILABLE("reprice_unavailable")`

            - `TEMPORARILY_UNAVAILABLE("temporarily_unavailable")`

            - `VARIANT_FIELDS_PRESENT("variant_fields_present")`

            - `WRONG_ORGANIZATION("wrong_organization")`

            - `WRONG_PLATFORM("wrong_platform")`

            - `WRONG_WORKSPACE("wrong_workspace")`

          - `Optional<List<String>> removeToRedeem`

            Request fields to remove before retrying, so the retry can redeem this
            token.

            Present exactly when `reason` is `variant_fields_present` — never null,
            never an empty array; absent otherwise. Fields are named only from your own request, and only after
            the sealed variant hash matched. A served best-effort retry has already
            been billed at normal price; nothing redeems retroactively, but a corrected
            re-send inside the token's five-minute window can still redeem.

    - `Optional<Long> inputTokens`

      The cumulative number of input tokens which were used.

      minimum: 0

    - `Optional<List<Iteration>> iterations`

      Per-iteration token usage breakdown.

      Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to:

      - Calculate the context window size from the last `message` entry
      - Understand token accumulation across server-side tool use loops

      A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results.

      - `class BetaMessageIterationUsage`

        Token usage for a sampling iteration.

        - `JsonValue type = "message"`

          Usage for a sampling iteration

        - `Optional<BetaCacheCreation> 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

        - `long cacheCreationInputTokens`

          The number of input tokens used to create the cache entry.

          minimum: 0

        - `long cacheReadInputTokens`

          The number of input tokens read from the cache.

          minimum: 0

        - `long inputTokens`

          The number of input tokens which were used.

          minimum: 0

        - `Optional<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

        - `long outputTokens`

          The number of output tokens which were used.

          minimum: 0

      - `class BetaCompactionIterationUsage`

        Token usage for a compaction iteration.

        - `JsonValue type = "compaction"`

          Usage for a compaction iteration

        - `Optional<BetaCacheCreation> cacheCreation`

          Breakdown of cached tokens by TTL

        - `long cacheCreationInputTokens`

          The number of input tokens used to create the cache entry.

          minimum: 0

        - `long cacheReadInputTokens`

          The number of input tokens read from the cache.

          minimum: 0

        - `long inputTokens`

          The number of input tokens which were used.

          minimum: 0

        - `long outputTokens`

          The number of output tokens which were used.

          minimum: 0

      - `class BetaAdvisorMessageIterationUsage`

        Token usage for an advisor sub-inference iteration.

        - `JsonValue type = "advisor_message"`

          Usage for an advisor sub-inference iteration

        - `Optional<BetaCacheCreation> cacheCreation`

          Breakdown of cached tokens by TTL

        - `long cacheCreationInputTokens`

          The number of input tokens used to create the cache entry.

          minimum: 0

        - `long cacheReadInputTokens`

          The number of input tokens read from the cache.

          minimum: 0

        - `long inputTokens`

          The number of input tokens which were used.

          minimum: 0

        - `Model model`

          The model that will complete your prompt.

          See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

        - `long outputTokens`

          The number of output tokens which were used.

          minimum: 0

      - `class BetaFallbackMessageIterationUsage`

        Token usage for the fallback-model attempt of a server-side fallback request.

        The terminal entry of a fallback-served turn: when a fallback hop's
        output is the returned message, the entry for the iteration that
        completed it carries this type in place of `message`. A declined hop
        and the serving hop's earlier tool-loop iterations produce `message`
        entries. Whether a fallback model served the response is signalled by
        the presence of this entry in `usage.iterations`.

        - `JsonValue type = "fallback_message"`

          Usage for the fallback-model attempt that served the response

        - `Optional<BetaCacheCreation> cacheCreation`

          Breakdown of cached tokens by TTL

        - `long cacheCreationInputTokens`

          The number of input tokens used to create the cache entry.

          minimum: 0

        - `long cacheReadInputTokens`

          The number of input tokens read from the cache.

          minimum: 0

        - `long inputTokens`

          The number of input tokens which were used.

          minimum: 0

        - `Model model`

          The model that will complete your prompt.

          See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

        - `long outputTokens`

          The number of output tokens which were used.

          minimum: 0

    - `long outputTokens`

      The cumulative number of output tokens which were used.

    - `Optional<BetaOutputTokensDetails> 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<BetaServerToolUsage> 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<List<BetaInputTransformation>> inputTransformations`

    Changes the API made to the request's input before showing it to the model,
    and blocks that failed a binding check but were left unchanged: one entry per
    block, in request order. Two entry types today. `thinking_dropped` — a
    `thinking`, `redacted_thinking` or `connector_text` block from the request's
    `messages` that was removed from the prompt instead of being shown to the
    model because it failed a binding check. `thinking_mismatch_allowed` — a
    `thinking` or `redacted_thinking` block that failed the conversation check
    (the conversation before it differs from the one it was created in, or it
    carries no record of one on a model that requires it) and was shown to the
    model all the same, because that check is not enforced for this request.
    More entry types may be added over time; ignore types you do not recognize.

    Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on
    every such response from a model that supports extended thinking, as `[]`
    when there is no entry to report; without the beta, blocks are removed or
    left in place all the same but nothing is reported. Removed blocks contribute
    nothing to `usage.input_tokens`; blocks left in place count as sent. When
    streaming, the array is final in `message_start`; the final `message_delta`
    event carries it only when a server-side model fallback happened mid-stream,
    in which case it holds the serving model's entries and replaces the one in
    `message_start`.

    - `class BetaThinkingDroppedInputTransformation`

      - `JsonValue type = "thinking_dropped"`

        Always `thinking_dropped` for this entry type.

      - `String path`

        Where the removed block was in your request, as `messages.{i}.content.{j}`:
        `i` indexes the `messages` array you sent and `j` that message's `content`
        array — the same form error messages use.

      - `Reason reason`

        Which binding check removed the block: `model_binding_mismatch` — it was
        created by a model whose reasoning the requested model may not read;
        `prefix_binding_mismatch` — the conversation before it differs from the
        conversation it was created in (the rest of that turn's consecutive thinking
        blocks are removed with it, each with this reason);
        `organization_binding_mismatch` — it was created under a different
        organization (an Anthropic organization, AWS account or Google Cloud project)
        and this organization is not one of its additional organizations;
        `end_user_binding_mismatch` — it was created for a different end user, or
        was removed by the consumer-organization binding. A block that would fail
        several checks reports one reason, in this order of precedence:
        `organization_binding_mismatch`, `end_user_binding_mismatch`,
        `model_binding_mismatch`, `prefix_binding_mismatch`.

        - `MODEL_BINDING_MISMATCH("model_binding_mismatch")`

        - `PREFIX_BINDING_MISMATCH("prefix_binding_mismatch")`

        - `ORGANIZATION_BINDING_MISMATCH("organization_binding_mismatch")`

        - `END_USER_BINDING_MISMATCH("end_user_binding_mismatch")`

    - `class BetaThinkingMismatchAllowedInputTransformation`

      - `JsonValue type = "thinking_mismatch_allowed"`

        Always `thinking_mismatch_allowed` for this entry type.

      - `String path`

        Where the block is in your request, as `messages.{i}.content.{j}`:
        `i` indexes the `messages` array you sent and `j` that message's `content`
        array — the same form error messages use.

      - `Reason reason`

        Which binding check the block failed; the block was shown to the model all
        the same. Always `prefix_binding_mismatch` today — the conversation before
        the block differs from the conversation it was created in, or the block
        carries no record of one on a model that requires it. Were the check
        enforced for this request, the block would have been removed or the request
        rejected (`thinking.block_binding.prefix_mismatch_behavior`). A removal also
        takes the rest of that turn's consecutive thinking blocks, whereas here each
        block is checked on its own, so `thinking_mismatch_allowed` entries are a
        lower bound on what enforcement would remove.

        - `MODEL_BINDING_MISMATCH("model_binding_mismatch")`

        - `PREFIX_BINDING_MISMATCH("prefix_binding_mismatch")`

        - `ORGANIZATION_BINDING_MISMATCH("organization_binding_mismatch")`

        - `END_USER_BINDING_MISMATCH("end_user_binding_mismatch")`

### Beta Raw Message Start Event

- `class BetaRawMessageStartEvent`

  - `JsonValue type = "message_start"`

  - `BetaMessage 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<BetaContainer> 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<List<BetaContainerSkill>> 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<BetaContentBlock> 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 BetaTextBlock`

        - `JsonValue type = "text"`

        - `Optional<List<BetaTextCitation>> 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 BetaCitationCharLocation`

            - `JsonValue type = "char_location"`

            - `String citedText`

            - `long documentIndex`

              minimum: 0

            - `Optional<String> documentTitle`

            - `long endCharIndex`

            - `Optional<String> fileId`

            - `long startCharIndex`

              minimum: 0

          - `class BetaCitationPageLocation`

            - `JsonValue type = "page_location"`

            - `String citedText`

            - `long documentIndex`

              minimum: 0

            - `Optional<String> documentTitle`

            - `long endPageNumber`

            - `Optional<String> fileId`

            - `long startPageNumber`

              minimum: 1

          - `class BetaCitationContentBlockLocation`

            - `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<String> 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<String> fileId`

            - `long startBlockIndex`

              0-based index of the first cited block in the source's `content` array.

              minimum: 0

          - `class BetaCitationsWebSearchResultLocation`

            - `JsonValue type = "web_search_result_location"`

            - `String citedText`

            - `String encryptedIndex`

            - `Optional<String> title`

              maxLength: 512

            - `String url`

          - `class BetaCitationSearchResultLocation`

            - `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<String> title`

        - `String text`

      - `class BetaThinkingBlock`

        - `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 BetaRedactedThinkingBlock`

        - `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 BetaToolUseBlock`

        - `JsonValue type = "tool_use"`

        - `String id`

          pattern: ^[a-zA-Z0-9_-]+$

        - `Input input`

        - `String name`

          minLength: 1

        - `Optional<Caller> caller`

          - `class BetaDirectCaller`

            Tool invocation directly from the model.

            - `JsonValue type = "direct"`

          - `class BetaServerToolCaller`

            Tool invocation generated by a server-side tool.

            - `JsonValue type = "code_execution_20250825"`

            - `String toolId`

              pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `class BetaServerToolCaller20260120`

            - `JsonValue type = "code_execution_20260120"`

            - `String toolId`

              pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `Optional<String> toolsetName`

          For a toolset member tool_use, the toolset family.

          minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$

      - `class BetaServerToolUseBlock`

        - `JsonValue type = "server_tool_use"`

        - `String id`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `Input input`

        - `Name name`

          - `ADVISOR("advisor")`

          - `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<Caller> caller`

          - `class BetaDirectCaller`

            Tool invocation directly from the model.

          - `class BetaServerToolCaller`

            Tool invocation generated by a server-side tool.

          - `class BetaServerToolCaller20260120`

      - `class BetaWebSearchToolResultBlock`

        - `JsonValue type = "web_search_tool_result"`

        - `BetaWebSearchToolResultBlockContent content`

          - `class BetaWebSearchToolResultError`

            - `JsonValue type = "web_search_tool_result_error"`

            - `BetaWebSearchToolResultErrorCode 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<BetaWebSearchResultBlock>`

            - `JsonValue type = "web_search_result"`

            - `String encryptedContent`

            - `Optional<String> pageAge`

            - `String title`

            - `String url`

        - `String toolUseId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `Optional<Caller> caller`

          - `class BetaDirectCaller`

            Tool invocation directly from the model.

          - `class BetaServerToolCaller`

            Tool invocation generated by a server-side tool.

          - `class BetaServerToolCaller20260120`

      - `class BetaWebFetchToolResultBlock`

        - `JsonValue type = "web_fetch_tool_result"`

        - `Content content`

          - `class BetaWebFetchToolResultErrorBlock`

            - `JsonValue type = "web_fetch_tool_result_error"`

            - `BetaWebFetchToolResultErrorCode 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 BetaWebFetchBlock`

            - `JsonValue type = "web_fetch_result"`

            - `BetaDocumentBlock content`

              - `JsonValue type = "document"`

              - `Optional<BetaCitationConfig> citations`

                Citation configuration for the document

                - `boolean enabled`

              - `Source source`

                - `class BetaBase64PdfSource`

                  - `JsonValue type = "base64"`

                  - `String data`

                    format: byte

                  - `JsonValue mediaType = "application/pdf"`

                - `class BetaPlainTextSource`

                  - `JsonValue type = "text"`

                  - `String data`

                  - `JsonValue mediaType = "text/plain"`

              - `Optional<String> title`

                The title of the document

            - `Optional<String> retrievedAt`

              ISO 8601 timestamp when the content was retrieved

            - `String url`

              Fetched content URL

        - `String toolUseId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `Optional<Caller> caller`

          - `class BetaDirectCaller`

            Tool invocation directly from the model.

          - `class BetaServerToolCaller`

            Tool invocation generated by a server-side tool.

          - `class BetaServerToolCaller20260120`

      - `class BetaAdvisorToolResultBlock`

        - `JsonValue type = "advisor_tool_result"`

        - `Content content`

          - `class BetaAdvisorToolResultError`

            - `JsonValue type = "advisor_tool_result_error"`

            - `ErrorCode errorCode`

              - `MAX_USES_EXCEEDED("max_uses_exceeded")`

              - `PROMPT_TOO_LONG("prompt_too_long")`

              - `TOO_MANY_REQUESTS("too_many_requests")`

              - `OVERLOADED("overloaded")`

              - `UNAVAILABLE("unavailable")`

              - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

              - `MODEL_NOT_FOUND("model_not_found")`

          - `class BetaAdvisorResultBlock`

            - `JsonValue type = "advisor_result"`

            - `Optional<String> stopReason`

              The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap.

            - `String text`

          - `class BetaAdvisorRedactedResultBlock`

            - `JsonValue type = "advisor_redacted_result"`

            - `String encryptedContent`

              Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify.

            - `Optional<String> stopReason`

              The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`).

        - `String toolUseId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `class BetaCodeExecutionToolResultBlock`

        - `JsonValue type = "code_execution_tool_result"`

        - `BetaCodeExecutionToolResultBlockContent content`

          - `class BetaCodeExecutionToolResultError`

            - `JsonValue type = "code_execution_tool_result_error"`

            - `BetaCodeExecutionToolResultErrorCode errorCode`

              - `INVALID_TOOL_INPUT("invalid_tool_input")`

              - `UNAVAILABLE("unavailable")`

              - `TOO_MANY_REQUESTS("too_many_requests")`

              - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

          - `class BetaCodeExecutionResultBlock`

            - `JsonValue type = "code_execution_result"`

            - `List<BetaCodeExecutionOutputBlock> content`

              - `JsonValue type = "code_execution_output"`

              - `String fileId`

            - `long returnCode`

            - `String stderr`

            - `String stdout`

          - `class BetaEncryptedCodeExecutionResultBlock`

            Code execution result with encrypted stdout for PFC + web_search results.

            - `JsonValue type = "encrypted_code_execution_result"`

            - `List<BetaCodeExecutionOutputBlock> content`

              - `JsonValue type = "code_execution_output"`

              - `String fileId`

            - `String encryptedStdout`

            - `long returnCode`

            - `String stderr`

        - `String toolUseId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `class BetaBashCodeExecutionToolResultBlock`

        - `JsonValue type = "bash_code_execution_tool_result"`

        - `Content content`

          - `class BetaBashCodeExecutionToolResultError`

            - `JsonValue type = "bash_code_execution_tool_result_error"`

            - `ErrorCode 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 BetaBashCodeExecutionResultBlock`

            - `JsonValue type = "bash_code_execution_result"`

            - `List<BetaBashCodeExecutionOutputBlock> content`

              - `JsonValue type = "bash_code_execution_output"`

              - `String fileId`

            - `long returnCode`

            - `String stderr`

            - `String stdout`

        - `String toolUseId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `class BetaTextEditorCodeExecutionToolResultBlock`

        - `JsonValue type = "text_editor_code_execution_tool_result"`

        - `Content content`

          - `class BetaTextEditorCodeExecutionToolResultError`

            - `JsonValue type = "text_editor_code_execution_tool_result_error"`

            - `ErrorCode 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<String> errorMessage`

          - `class BetaTextEditorCodeExecutionViewResultBlock`

            - `JsonValue type = "text_editor_code_execution_view_result"`

            - `String content`

            - `FileType fileType`

              - `TEXT("text")`

              - `IMAGE("image")`

              - `PDF("pdf")`

            - `Optional<Long> numLines`

            - `Optional<Long> startLine`

            - `Optional<Long> totalLines`

          - `class BetaTextEditorCodeExecutionCreateResultBlock`

            - `JsonValue type = "text_editor_code_execution_create_result"`

            - `boolean isFileUpdate`

          - `class BetaTextEditorCodeExecutionStrReplaceResultBlock`

            - `JsonValue type = "text_editor_code_execution_str_replace_result"`

            - `Optional<List<String>> lines`

            - `Optional<Long> newLines`

            - `Optional<Long> newStart`

            - `Optional<Long> oldLines`

            - `Optional<Long> oldStart`

        - `String toolUseId`

          pattern: ^srvtoolu_[a-zA-Z0-9_]+$

      - `class BetaToolSearchToolResultBlock`

        - `JsonValue type = "tool_search_tool_result"`

        - `Content content`

          - `class BetaToolSearchToolResultError`

            - `JsonValue type = "tool_search_tool_result_error"`

            - `ErrorCode errorCode`

              - `INVALID_TOOL_INPUT("invalid_tool_input")`

              - `UNAVAILABLE("unavailable")`

              - `TOO_MANY_REQUESTS("too_many_requests")`

              - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

            - `Optional<String> errorMessage`

          - `class BetaToolSearchToolSearchResultBlock`

            - `JsonValue type = "tool_search_tool_search_result"`

            - `List<BetaToolReferenceBlock> 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 BetaMcpToolUseBlock`

        - `JsonValue type = "mcp_tool_use"`

        - `String id`

          pattern: ^[a-zA-Z0-9_-]+$

        - `Input input`

        - `String name`

          The name of the MCP tool

        - `String serverName`

          The name of the MCP server

      - `class BetaMcpToolResultBlock`

        - `JsonValue type = "mcp_tool_result"`

        - `Content content`

          - `String`

          - `List<BetaTextBlock>`

            - `JsonValue type = "text"`

            - `Optional<List<BetaTextCitation>> 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`.

            - `String text`

        - `boolean isError`

        - `String toolUseId`

          pattern: ^[a-zA-Z0-9_-]+$

      - `class BetaContainerUploadBlock`

        Response model for a file uploaded to the container.

        - `JsonValue type = "container_upload"`

        - `String fileId`

      - `class BetaCompactionBlock`

        A compaction block returned when autocompact is triggered.

        When content is None, it indicates the compaction failed to produce a valid
        summary (e.g., malformed output from the model). Clients may round-trip
        compaction blocks with null content; the server treats them as no-ops.

        - `JsonValue type = "compaction"`

        - `Optional<String> content`

          Summary of compacted content, or null if compaction failed

        - `Optional<String> encryptedContent`

          Opaque metadata from prior compaction, to be round-tripped verbatim

        - `Optional<String> signature`

          Signature over the summary, to be sent back with the block verbatim

        - `Optional<List<ToolChange>> toolChanges`

          The tool changes of the compacted range: the `tool_addition` and `tool_removal` blocks that take the request's `tools` to the tool set in effect at the end of the range, or `[]` when the range changed no tool. Absent when the server did not compute them. Send the block back unchanged.

          - `class BetaResponseToolAdditionBlock`

            An entry of a `compaction` block's `tool_changes`: a tool the
            compacted range made available, as a reference to a `tools` entry or
            MCP toolset, or as the tool definition in effect at the end of the
            range, by value. Send it back unchanged.

            - `JsonValue type = "tool_addition"`

            - `Tool tool`

              The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value.

              - `class BetaResponseToolChangeToolReference`

                Reference to a single tool, by the name the model uses to call it, as
                a `compaction` block's `tool_changes` entry reports it: a tool
                declared in `tools` or defined by an earlier `tool_addition` block.
                Send it back unchanged with the block.

                - `JsonValue type = "tool_reference"`

                - `String name`

              - `class BetaResponseToolChangeMcpToolReference`

                Reference to a single MCP tool, by its server and its name on that
                server, as a `compaction` block's `tool_changes` entry reports it.
                Send it back unchanged with the block.

                - `JsonValue type = "mcp_tool_reference"`

                - `String name`

                - `String serverName`

              - `class BetaResponseToolChangeMcpToolsetReference`

                Reference to every tool in the named MCP server's toolset, as a
                `compaction` block's `tool_changes` entry reports it. Send it back
                unchanged with the block.

                - `JsonValue type = "mcp_toolset_reference"`

                - `String serverName`

              - `class BetaToolChangeToolDefinition`

                A tool defined by value, as a `compaction` block's `tool_changes` entry
                reports it: `definition` is the tool's definition as it was sent, in the
                form of a `tools` entry, without `cache_control`. Send it back unchanged
                with the block.

                - `JsonValue type = "tool_definition"`

                - `BetaResponseToolUnion definition`

                  - `class BetaResponseTool`

                    A custom tool definition, as sent.

                    - `Optional<Type> type`

                    - `BetaResponseToolInputSchema 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> properties`

                      - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolBash20241022`

                    - `JsonValue type = "bash_20241022"`

                    - `JsonValue name = "bash"`

                      Name of the tool.

                      This is how the tool will be called by the model and in `tool_use` blocks.

                    - `Optional<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                      - `JsonValue type = "ephemeral"`

                      - `Optional<Ttl> 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<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolBash20250124`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaCodeExecutionTool20250522`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaCodeExecutionTool20250825`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaCodeExecutionTool20260120`

                    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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaCodeExecutionTool20260521`

                    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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaBrowserToolset20260801`

                    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<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

                        `type`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserCloseTabConfig> closeTab`

                        `close_tab`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

                        `double_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserFileUploadConfig> fileUpload`

                        `file_upload`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserFindConfig> find`

                        `find`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserFormInputConfig> formInput`

                        `form_input`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserGetPageTextConfig> getPageText`

                        `get_page_text`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserHoldKeyConfig> holdKey`

                        `hold_key`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserHoverConfig> hover`

                        `hover`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

                        `javascript_exec`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserKeyConfig> key`

                        `key`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserLeftClickConfig> leftClick`

                        `left_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

                        `left_click_drag`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

                        `left_mouse_down`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

                        `left_mouse_up`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserListTabsConfig> listTabs`

                        `list_tabs`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserMiddleClickConfig> middleClick`

                        `middle_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

                        `mouse_move`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserNavigateConfig> navigate`

                        `navigate`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserNewTabConfig> newTab`

                        `new_tab`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserReadConsoleConfig> readConsole`

                        `read_console`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

                        `read_network`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserReadPageConfig> readPage`

                        `read_page`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserRightClickConfig> rightClick`

                        `right_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserScreenshotConfig> screenshot`

                        `screenshot`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserScrollConfig> scroll`

                        `scroll`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserScrollToConfig> scrollTo`

                        `scroll_to`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserSwitchTabConfig> switchTab`

                        `switch_tab`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserTripleClickConfig> tripleClick`

                        `triple_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserWaitConfig> wait`

                        `wait`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaBrowserZoomConfig> zoom`

                        `zoom`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered 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 BetaToolComputerUse20241022`

                    - `JsonValue type = "computer_20241022"`

                    - `long displayHeightPx`

                      The height of the display in pixels.

                      minimum: 1

                    - `long displayWidthPx`

                      The width of the display in pixels.

                      minimum: 1

                    - `JsonValue name = "computer"`

                      Name of the tool.

                      This is how the tool will be called by the model and in `tool_use` blocks.

                    - `Optional<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> displayNumber`

                      The X11 display number (e.g. 0, 1) for the display.

                      minimum: 0

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaMemoryTool20250818`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolComputerUse20250124`

                    - `JsonValue type = "computer_20250124"`

                    - `long displayHeightPx`

                      The height of the display in pixels.

                      minimum: 1

                    - `long displayWidthPx`

                      The width of the display in pixels.

                      minimum: 1

                    - `JsonValue name = "computer"`

                      Name of the tool.

                      This is how the tool will be called by the model and in `tool_use` blocks.

                    - `Optional<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> displayNumber`

                      The X11 display number (e.g. 0, 1) for the display.

                      minimum: 0

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolTextEditor20241022`

                    - `JsonValue type = "text_editor_20241022"`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolComputerUse20251124`

                    - `JsonValue type = "computer_20251124"`

                    - `long displayHeightPx`

                      The height of the display in pixels.

                      minimum: 1

                    - `long displayWidthPx`

                      The width of the display in pixels.

                      minimum: 1

                    - `JsonValue name = "computer"`

                      Name of the tool.

                      This is how the tool will be called by the model and in `tool_use` blocks.

                    - `Optional<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> displayNumber`

                      The X11 display number (e.g. 0, 1) for the display.

                      minimum: 0

                    - `Optional<Boolean> enableZoom`

                      Whether to enable an action to take a zoomed-in screenshot of the screen.

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaComputerToolset20260801`

                    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<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

                        `type`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

                        `cursor_position`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerDoubleClickConfig> doubleClick`

                        `double_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerHoldKeyConfig> holdKey`

                        `hold_key`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerKeyConfig> key`

                        `key`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerLeftClickConfig> leftClick`

                        `left_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

                        `left_click_drag`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

                        `left_mouse_down`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

                        `left_mouse_up`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerMiddleClickConfig> middleClick`

                        `middle_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerMouseMoveConfig> mouseMove`

                        `mouse_move`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerRightClickConfig> rightClick`

                        `right_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerScreenshotConfig> screenshot`

                        `screenshot`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerScrollConfig> scroll`

                        `scroll`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerTripleClickConfig> tripleClick`

                        `triple_click`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerWaitConfig> wait`

                        `wait`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                      - `Optional<BetaComputerZoomConfig> zoom`

                        `zoom`'s config overrides.

                        - `Optional<Boolean> deferLoading`

                          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                        - `Optional<Boolean> enabled`

                          Whether this member is offered 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 BetaToolTextEditor20250124`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolTextEditor20250429`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolTextEditor20250728`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<List<InputExample>> inputExamples`

                    - `Optional<Long> maxCharacters`

                      Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

                      minimum: 1

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaWebSearchTool20250305`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<List<String>> allowedDomains`

                      If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                    - `Optional<List<String>> blockedDomains`

                      If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> maxUses`

                      Maximum number of times the tool can be used in the API request.

                      minimum: 1

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                    - `Optional<BetaUserLocation> userLocation`

                      Parameters for the user's location. Used to provide more relevant search results.

                      - `JsonValue type = "approximate"`

                      - `Optional<String> city`

                        The city of the user.

                        minLength: 1, maxLength: 255

                      - `Optional<String> 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<String> region`

                        The region of the user.

                        minLength: 1, maxLength: 255

                      - `Optional<String> timezone`

                        The [IANA timezone](https://nodatime.org/TimeZones) of the user.

                        minLength: 1, maxLength: 255

                  - `class BetaWebFetchTool20250910`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<List<String>> allowedDomains`

                      List of domains to allow fetching from

                    - `Optional<List<String>> blockedDomains`

                      List of domains to block fetching from

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<BetaCitationsConfigParam> citations`

                      Citations configuration for fetched documents. Citations are disabled by default.

                      - `Optional<Boolean> enabled`

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> 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<Long> maxUses`

                      Maximum number of times the tool can be used in the API request.

                      minimum: 1

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                    - `Optional<BetaWebFetchUrlSources> urlSources`

                      Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                      - `Optional<ClientToolResults> clientToolResults`

                        Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

                        - `class BetaWebFetchUrlSourceAll`

                          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 BetaWebFetchUrlSourceNone`

                          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 BetaWebFetchUrlSourceOnly`

                          The tool filter variant under which only the named tools' results
                          contribute.

                          - `JsonValue type = "only"`

                          - `List<BetaWebFetchUrlSourceToolReference> tools`

                            - `JsonValue type = "tool_reference"`

                            - `String name`

                        - `class BetaWebFetchUrlSourceExcept`

                          The tool filter variant under which every result but the named
                          tools' contributes.

                          - `JsonValue type = "except"`

                          - `List<BetaWebFetchUrlSourceToolReference> tools`

                            - `JsonValue type = "tool_reference"`

                            - `String name`

                      - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

                          The `url_sources` variant under which a source contributes in
                          full: every result of the tool filter's source, or all user input.

                        - `class BetaWebFetchUrlSourceNone`

                          The `url_sources` variant under which a source contributes nothing:
                          no result of the tool filter's source, or no user input.

                        - `class BetaWebFetchUrlSourceOnly`

                          The tool filter variant under which only the named tools' results
                          contribute.

                        - `class BetaWebFetchUrlSourceExcept`

                          The tool filter variant under which every result but the named
                          tools' contributes.

                      - `Optional<UserInput> userInput`

                        Whether URLs in user messages are fetchable: "all" or "none".

                        - `class BetaWebFetchUrlSourceAll`

                          The `url_sources` variant under which a source contributes in
                          full: every result of the tool filter's source, or all user input.

                        - `class BetaWebFetchUrlSourceNone`

                          The `url_sources` variant under which a source contributes nothing:
                          no result of the tool filter's source, or no user input.

                  - `class BetaWebSearchTool20260209`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<List<String>> allowedDomains`

                      If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                    - `Optional<List<String>> blockedDomains`

                      If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> maxUses`

                      Maximum number of times the tool can be used in the API request.

                      minimum: 1

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                    - `Optional<BetaUserLocation> userLocation`

                      Parameters for the user's location. Used to provide more relevant search results.

                  - `class BetaWebFetchTool20260209`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<List<String>> allowedDomains`

                      List of domains to allow fetching from

                    - `Optional<List<String>> blockedDomains`

                      List of domains to block fetching from

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<BetaCitationsConfigParam> citations`

                      Citations configuration for fetched documents. Citations are disabled by default.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> 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<Long> maxUses`

                      Maximum number of times the tool can be used in the API request.

                      minimum: 1

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                    - `Optional<BetaWebFetchUrlSources> urlSources`

                      Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                  - `class BetaWebFetchTool20260309`

                    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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<List<String>> allowedDomains`

                      List of domains to allow fetching from

                    - `Optional<List<String>> blockedDomains`

                      List of domains to block fetching from

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<BetaCitationsConfigParam> citations`

                      Citations configuration for fetched documents. Citations are disabled by default.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> 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<Long> maxUses`

                      Maximum number of times the tool can be used in the API request.

                      minimum: 1

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                    - `Optional<BetaWebFetchUrlSources> urlSources`

                      Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                    - `Optional<Boolean> 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 BetaWebSearchTool20260318`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<List<String>> allowedDomains`

                      If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                    - `Optional<List<String>> blockedDomains`

                      If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> maxUses`

                      Maximum number of times the tool can be used in the API request.

                      minimum: 1

                    - `Optional<ResponseInclusion> 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<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                    - `Optional<BetaUserLocation> userLocation`

                      Parameters for the user's location. Used to provide more relevant search results.

                  - `class BetaWebFetchTool20260318`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<List<String>> allowedDomains`

                      List of domains to allow fetching from

                    - `Optional<List<String>> blockedDomains`

                      List of domains to block fetching from

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<BetaCitationsConfigParam> citations`

                      Citations configuration for fetched documents. Citations are disabled by default.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> 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<Long> maxUses`

                      Maximum number of times the tool can be used in the API request.

                      minimum: 1

                    - `Optional<ResponseInclusion> 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<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                    - `Optional<BetaWebFetchUrlSources> urlSources`

                      Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                    - `Optional<Boolean> 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 BetaAdvisorTool20260301`

                    - `JsonValue type = "advisor_20260301"`

                    - `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 name = "advisor"`

                      Name of the tool.

                      This is how the tool will be called by the model and in `tool_use` blocks.

                    - `Optional<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<BetaCacheControlEphemeral> caching`

                      Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Long> maxTokens`

                      Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

                      minimum: 1024

                    - `Optional<Long> maxUses`

                      Maximum number of times the tool can be used in the API request.

                      minimum: 1

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaToolSearchToolRegex20251119`

                    - `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<List<AllowedCaller>> allowedCallers`

                      - `DIRECT("direct")`

                      - `CODE_EXECUTION_20250825("code_execution_20250825")`

                      - `CODE_EXECUTION_20260120("code_execution_20260120")`

                      - `CODE_EXECUTION_20260521("code_execution_20260521")`

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Boolean> deferLoading`

                      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                    - `Optional<Boolean> strict`

                      When true, guarantees schema validation on tool names and inputs

                  - `class BetaMcpToolset`

                    Configuration for a group of tools from an MCP server.

                    Allows configuring enabled status and defer_loading for all tools
                    from an MCP server, with optional per-tool overrides.

                    - `JsonValue type = "mcp_toolset"`

                    - `String mcpServerName`

                      Name of the MCP server to configure tools for

                      minLength: 1, maxLength: 255

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<Configs> configs`

                      Configuration overrides for specific tools, keyed by tool name

                      - `Optional<Boolean> deferLoading`

                      - `Optional<Boolean> enabled`

                    - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

                      Default configuration applied to all tools from this server

                      - `Optional<Boolean> deferLoading`

                      - `Optional<Boolean> enabled`

                    - `Optional<List<BetaMcpToolParam>> tools`

                      The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

                      - `InputSchema inputSchema`

                        The tool's input schema as the MCP server lists it, verbatim.

                      - `String name`

                        The tool's name as the MCP server lists it (not prefixed with the server name).

                        minLength: 1

                      - `Optional<String> description`

                        The tool's description as the MCP server lists it.

          - `class BetaResponseToolRemovalBlock`

            An entry of a `compaction` block's `tool_changes`: a tool of the
            request's `tools` (or an MCP tool or toolset) that the compacted range
            withdrew. Send it back unchanged.

            - `JsonValue type = "tool_removal"`

            - `Tool tool`

              A reference to the withdrawn `tools` entry, MCP tool or MCP toolset.

              - `class BetaResponseToolChangeToolReference`

                Reference to a single tool, by the name the model uses to call it, as
                a `compaction` block's `tool_changes` entry reports it: a tool
                declared in `tools` or defined by an earlier `tool_addition` block.
                Send it back unchanged with the block.

              - `class BetaResponseToolChangeMcpToolReference`

                Reference to a single MCP tool, by its server and its name on that
                server, as a `compaction` block's `tool_changes` entry reports it.
                Send it back unchanged with the block.

              - `class BetaResponseToolChangeMcpToolsetReference`

                Reference to every tool in the named MCP server's toolset, as a
                `compaction` block's `tool_changes` entry reports it. Send it back
                unchanged with the block.

      - `class BetaFallbackBlock`

        Marks the point in `content` where one model's output gives way to the next.

        One block appears per hop where a preceding model actually ran this turn and
        declined. A turn where no preceding model ran and declined has no such
        boundary and carries no block — the signal for whether a fallback model
        served the response is the presence of a `fallback_message` entry in
        `usage.iterations`, not this block.

        The block is treated like a server-tool content block for streaming: it
        arrives via the standard `content_block_start` / `content_block_stop`
        pair and carries no deltas.

        - `JsonValue type = "fallback"`

        - `BetaFallbackInfo from`

          The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id.

          - `Model model`

            The model that will complete your prompt.

            See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

        - `BetaFallbackInfo to`

          The fallback model producing the content that follows this block. Its `model` is always the canonical id.

        - `BetaFallbackRefusalTrigger trigger`

          What caused the `from` model to hand over at this hop.

          - `JsonValue type = "refusal"`

          - `Optional<Category> category`

            The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.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.

      - `class BetaMcpToolListingBlock`

        The tool listing the server fetched from an MCP server while producing
        this response. Send the assistant message back unchanged, this block
        included, so later requests use this listing instead of asking the MCP
        server again.

        - `JsonValue type = "mcp_tool_listing"`

        - `String mcpServerName`

        - `List<BetaMcpTool> tools`

          - `InputSchema inputSchema`

          - `String name`

          - `Optional<String> description`

    - `Optional<BetaContextManagementResponse> contextManagement`

      Context management response.

      Information about context management strategies applied during the request.

      - `List<AppliedEdit> appliedEdits`

        List of context management edits that were applied.

        - `class BetaClearToolUses20250919EditResponse`

          - `JsonValue type = "clear_tool_uses_20250919"`

            The type of context management edit applied.

          - `long clearedInputTokens`

            Number of input tokens cleared by this edit.

            minimum: 0

          - `long clearedToolUses`

            Number of tool uses that were cleared.

            minimum: 0

        - `class BetaClearThinking20251015EditResponse`

          - `JsonValue type = "clear_thinking_20251015"`

            The type of context management edit applied.

          - `long clearedInputTokens`

            Number of input tokens cleared by this edit.

            minimum: 0

          - `long clearedThinkingTurns`

            Number of thinking turns that were cleared.

            minimum: 0

    - `Optional<BetaDiagnostics> diagnostics`

      Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected.

      - `Optional<BetaCacheMissReason> 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 BetaCacheMissModelChanged`

          - `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 BetaCacheMissSystemChanged`

          - `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 BetaCacheMissToolsChanged`

          - `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 BetaCacheMissMessagesChanged`

          - `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 BetaCacheMissPreviousMessageNotFound`

          - `JsonValue type = "previous_message_not_found"`

        - `class BetaCacheMissUnavailable`

          - `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.

    - `JsonValue role = "assistant"`

      Conversational role of the generated message.

      This will always be `"assistant"`.

    - `Optional<BetaRefusalStopDetails> 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> 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<String> 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<String> fallbackCreditToken`

        Opaque code that refunds the cache-miss cost when retrying this refused
        request on the fallback model. Pass it as `fallback_credit_token` on the
        retry request. Expires 5 minutes after the refusal.

        The retry is sent either with the same request body (`system`, `messages`,
        `tools`, and other render-shaping fields), or with the same body plus one
        appended `assistant` message whose content is the partial text (with any
        trailing whitespace stripped from the final text block) and paired
        server-tool blocks from this refusal — which also authorizes that
        appended turn as an assistant-prefill continuation on models that otherwise
        disallow prefill. A token minted mid-server-tool-loop whose partial content
        was continuable may only be redeemed the second way — if a same-body retry
        is rejected with a 400 saying the token must be redeemed by continuing the
        partial response, retry the second way instead. Either way: same workspace,
        same platform; a mismatch is a 400. Resending a token for an already-warm
        prefix is permitted but yields no additional credit.

        `null` when the refused model isn't eligible for a fallback credit.

      - `Optional<Boolean> fallbackHasPrefillClaim`

        Whether the accompanying `fallback_credit_token` may be redeemed with the
        appended-assistant retry form. Only set when `fallback_credit_token` is
        present.

        `true`: retry by resending the same request body plus one appended
        `assistant` message whose content is this response's `content` with any
        trailing whitespace stripped from the final text block and unpaired
        `tool_use` blocks omitted (the same appended-turn shape described on
        `fallback_credit_token`), with the token attached. `false`: retry by
        resending the original request body unchanged, with the token attached —
        the appended-assistant form is not available for this refusal (no
        continuable partial content, or the request uses `output_format` or a
        `tool_choice` that forces tool use). One exception: when the request used
        `output_format` or a forced `tool_choice` and the refusal arrived after
        server tools (including MCP connector tools) had already executed, the
        token may not be redeemable by either retry form; if the exact-body retry
        is then rejected with a 400 saying the token must be redeemed by
        continuing the partial response, discard the token and retry without it.

        Advisory: if an appended-assistant retry is rejected with a 400 despite
        `true`, fall back to resending the original request body with the token.

      - `Optional<String> recommendedModel`

        The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise.

    - `Optional<BetaStopReason> 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")`

      - `COMPACTION("compaction")`

      - `REFUSAL("refusal")`

      - `MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")`

    - `Optional<String> 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.

    - `BetaUsage 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<BetaCacheCreation> 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<Long> cacheCreationInputTokens`

        The number of input tokens used to create the cache entry.

        minimum: 0

      - `Optional<Long> cacheReadInputTokens`

        The number of input tokens read from the cache.

        minimum: 0

      - `Optional<BetaFallbackCreditUsage> fallbackCredit`

        Outcome of the `fallback_credit_token` presented on this request.

        Present on every response to a non-batch request that carried a
        `fallback_credit_token`, in either redemption mode; absent otherwise (batch
        items accept and ignore the token and carry no outcome object).

        - `Status status`

          Whether the fallback-credit reprice was applied to this response's billing.

          A union discriminated on `type`. `redeemed`: the retry is billed as if
          the conversation had been on the retry model all along — including when the
          resulting shift is zero because there was nothing to move. `not_applied`:
          no reprice was applied; the arm's `reason` says why.

          - `class BetaFallbackCreditRedeemed`

            The reprice was applied: the retry is billed as if the conversation
            had been on the retry model all along.

            - `JsonValue type = "redeemed"`

          - `class BetaFallbackCreditNotApplied`

            No reprice was applied; `reason` says why.

            - `JsonValue type = "not_applied"`

            - `Reason reason`

              Why the reprice was not applied.

              A closed enum; additions to the redemption-check vocabulary arrive as
              deliberate schema updates.

              - `BODY_MISMATCH("body_mismatch")`

              - `CONTINUATION_EXCLUDED("continuation_excluded")`

              - `CONTINUATION_ONLY("continuation_only")`

              - `EXPIRED("expired")`

              - `INVALID_TARGET_MODEL("invalid_target_model")`

              - `NOT_ENABLED("not_enabled")`

              - `REPRICE_UNAVAILABLE("reprice_unavailable")`

              - `TEMPORARILY_UNAVAILABLE("temporarily_unavailable")`

              - `VARIANT_FIELDS_PRESENT("variant_fields_present")`

              - `WRONG_ORGANIZATION("wrong_organization")`

              - `WRONG_PLATFORM("wrong_platform")`

              - `WRONG_WORKSPACE("wrong_workspace")`

            - `Optional<List<String>> removeToRedeem`

              Request fields to remove before retrying, so the retry can redeem this
              token.

              Present exactly when `reason` is `variant_fields_present` — never null,
              never an empty array; absent otherwise. Fields are named only from your own request, and only after
              the sealed variant hash matched. A served best-effort retry has already
              been billed at normal price; nothing redeems retroactively, but a corrected
              re-send inside the token's five-minute window can still redeem.

      - `Optional<String> inferenceGeo`

        The geographic region where inference was performed for this request.

      - `long inputTokens`

        The number of input tokens which were used.

        minimum: 0

      - `Optional<List<Iteration>> iterations`

        Per-iteration token usage breakdown.

        Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to:

        - Calculate the context window size from the last `message` entry
        - Understand token accumulation across server-side tool use loops

        A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results.

        - `class BetaMessageIterationUsage`

          Token usage for a sampling iteration.

          - `JsonValue type = "message"`

            Usage for a sampling iteration

          - `Optional<BetaCacheCreation> cacheCreation`

            Breakdown of cached tokens by TTL

          - `long cacheCreationInputTokens`

            The number of input tokens used to create the cache entry.

            minimum: 0

          - `long cacheReadInputTokens`

            The number of input tokens read from the cache.

            minimum: 0

          - `long inputTokens`

            The number of input tokens which were used.

            minimum: 0

          - `Optional<Model> model`

            The model that will complete your prompt.

            See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

          - `long outputTokens`

            The number of output tokens which were used.

            minimum: 0

        - `class BetaCompactionIterationUsage`

          Token usage for a compaction iteration.

          - `JsonValue type = "compaction"`

            Usage for a compaction iteration

          - `Optional<BetaCacheCreation> cacheCreation`

            Breakdown of cached tokens by TTL

          - `long cacheCreationInputTokens`

            The number of input tokens used to create the cache entry.

            minimum: 0

          - `long cacheReadInputTokens`

            The number of input tokens read from the cache.

            minimum: 0

          - `long inputTokens`

            The number of input tokens which were used.

            minimum: 0

          - `long outputTokens`

            The number of output tokens which were used.

            minimum: 0

        - `class BetaAdvisorMessageIterationUsage`

          Token usage for an advisor sub-inference iteration.

          - `JsonValue type = "advisor_message"`

            Usage for an advisor sub-inference iteration

          - `Optional<BetaCacheCreation> cacheCreation`

            Breakdown of cached tokens by TTL

          - `long cacheCreationInputTokens`

            The number of input tokens used to create the cache entry.

            minimum: 0

          - `long cacheReadInputTokens`

            The number of input tokens read from the cache.

            minimum: 0

          - `long inputTokens`

            The number of input tokens which were used.

            minimum: 0

          - `Model model`

            The model that will complete your prompt.

            See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

          - `long outputTokens`

            The number of output tokens which were used.

            minimum: 0

        - `class BetaFallbackMessageIterationUsage`

          Token usage for the fallback-model attempt of a server-side fallback request.

          The terminal entry of a fallback-served turn: when a fallback hop's
          output is the returned message, the entry for the iteration that
          completed it carries this type in place of `message`. A declined hop
          and the serving hop's earlier tool-loop iterations produce `message`
          entries. Whether a fallback model served the response is signalled by
          the presence of this entry in `usage.iterations`.

          - `JsonValue type = "fallback_message"`

            Usage for the fallback-model attempt that served the response

          - `Optional<BetaCacheCreation> cacheCreation`

            Breakdown of cached tokens by TTL

          - `long cacheCreationInputTokens`

            The number of input tokens used to create the cache entry.

            minimum: 0

          - `long cacheReadInputTokens`

            The number of input tokens read from the cache.

            minimum: 0

          - `long inputTokens`

            The number of input tokens which were used.

            minimum: 0

          - `Model model`

            The model that will complete your prompt.

            See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

          - `long outputTokens`

            The number of output tokens which were used.

            minimum: 0

      - `long outputTokens`

        The number of output tokens which were used.

        minimum: 0

      - `Optional<BetaOutputTokensDetails> 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<BetaServerToolUsage> 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> serviceTier`

        If the request used the priority, standard, or batch tier.

        - `STANDARD("standard")`

        - `PRIORITY("priority")`

        - `BATCH("batch")`

      - `Optional<Speed> speed`

        The inference speed mode used for this request.

        - `STANDARD("standard")`

        - `FAST("fast")`

    - `Optional<List<BetaInputTransformation>> inputTransformations`

      Changes the API made to the request's input before showing it to the model,
      and blocks that failed a binding check but were left unchanged: one entry per
      block, in request order. Two entry types today. `thinking_dropped` — a
      `thinking`, `redacted_thinking` or `connector_text` block from the request's
      `messages` that was removed from the prompt instead of being shown to the
      model because it failed a binding check. `thinking_mismatch_allowed` — a
      `thinking` or `redacted_thinking` block that failed the conversation check
      (the conversation before it differs from the one it was created in, or it
      carries no record of one on a model that requires it) and was shown to the
      model all the same, because that check is not enforced for this request.
      More entry types may be added over time; ignore types you do not recognize.

      Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on
      every such response from a model that supports extended thinking, as `[]`
      when there is no entry to report; without the beta, blocks are removed or
      left in place all the same but nothing is reported. Removed blocks contribute
      nothing to `usage.input_tokens`; blocks left in place count as sent. When
      streaming, the array is final in `message_start`; the final `message_delta`
      event carries it only when a server-side model fallback happened mid-stream,
      in which case it holds the serving model's entries and replaces the one in
      `message_start`.

      - `class BetaThinkingDroppedInputTransformation`

        - `JsonValue type = "thinking_dropped"`

          Always `thinking_dropped` for this entry type.

        - `String path`

          Where the removed block was in your request, as `messages.{i}.content.{j}`:
          `i` indexes the `messages` array you sent and `j` that message's `content`
          array — the same form error messages use.

        - `Reason reason`

          Which binding check removed the block: `model_binding_mismatch` — it was
          created by a model whose reasoning the requested model may not read;
          `prefix_binding_mismatch` — the conversation before it differs from the
          conversation it was created in (the rest of that turn's consecutive thinking
          blocks are removed with it, each with this reason);
          `organization_binding_mismatch` — it was created under a different
          organization (an Anthropic organization, AWS account or Google Cloud project)
          and this organization is not one of its additional organizations;
          `end_user_binding_mismatch` — it was created for a different end user, or
          was removed by the consumer-organization binding. A block that would fail
          several checks reports one reason, in this order of precedence:
          `organization_binding_mismatch`, `end_user_binding_mismatch`,
          `model_binding_mismatch`, `prefix_binding_mismatch`.

          - `MODEL_BINDING_MISMATCH("model_binding_mismatch")`

          - `PREFIX_BINDING_MISMATCH("prefix_binding_mismatch")`

          - `ORGANIZATION_BINDING_MISMATCH("organization_binding_mismatch")`

          - `END_USER_BINDING_MISMATCH("end_user_binding_mismatch")`

      - `class BetaThinkingMismatchAllowedInputTransformation`

        - `JsonValue type = "thinking_mismatch_allowed"`

          Always `thinking_mismatch_allowed` for this entry type.

        - `String path`

          Where the block is in your request, as `messages.{i}.content.{j}`:
          `i` indexes the `messages` array you sent and `j` that message's `content`
          array — the same form error messages use.

        - `Reason reason`

          Which binding check the block failed; the block was shown to the model all
          the same. Always `prefix_binding_mismatch` today — the conversation before
          the block differs from the conversation it was created in, or the block
          carries no record of one on a model that requires it. Were the check
          enforced for this request, the block would have been removed or the request
          rejected (`thinking.block_binding.prefix_mismatch_behavior`). A removal also
          takes the rest of that turn's consecutive thinking blocks, whereas here each
          block is checked on its own, so `thinking_mismatch_allowed` entries are a
          lower bound on what enforcement would remove.

          - `MODEL_BINDING_MISMATCH("model_binding_mismatch")`

          - `PREFIX_BINDING_MISMATCH("prefix_binding_mismatch")`

          - `ORGANIZATION_BINDING_MISMATCH("organization_binding_mismatch")`

          - `END_USER_BINDING_MISMATCH("end_user_binding_mismatch")`

### Beta Raw Message Stop Event

- `class BetaRawMessageStopEvent`

  - `JsonValue type = "message_stop"`

### Beta Raw Message Stream Event

- `class BetaRawMessageStreamEvent: union`

  - `class BetaRawMessageStartEvent`

    - `JsonValue type = "message_start"`

    - `BetaMessage 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<BetaContainer> 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<List<BetaContainerSkill>> 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<BetaContentBlock> 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 BetaTextBlock`

          - `JsonValue type = "text"`

          - `Optional<List<BetaTextCitation>> 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 BetaCitationCharLocation`

              - `JsonValue type = "char_location"`

              - `String citedText`

              - `long documentIndex`

                minimum: 0

              - `Optional<String> documentTitle`

              - `long endCharIndex`

              - `Optional<String> fileId`

              - `long startCharIndex`

                minimum: 0

            - `class BetaCitationPageLocation`

              - `JsonValue type = "page_location"`

              - `String citedText`

              - `long documentIndex`

                minimum: 0

              - `Optional<String> documentTitle`

              - `long endPageNumber`

              - `Optional<String> fileId`

              - `long startPageNumber`

                minimum: 1

            - `class BetaCitationContentBlockLocation`

              - `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<String> 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<String> fileId`

              - `long startBlockIndex`

                0-based index of the first cited block in the source's `content` array.

                minimum: 0

            - `class BetaCitationsWebSearchResultLocation`

              - `JsonValue type = "web_search_result_location"`

              - `String citedText`

              - `String encryptedIndex`

              - `Optional<String> title`

                maxLength: 512

              - `String url`

            - `class BetaCitationSearchResultLocation`

              - `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<String> title`

          - `String text`

        - `class BetaThinkingBlock`

          - `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 BetaRedactedThinkingBlock`

          - `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 BetaToolUseBlock`

          - `JsonValue type = "tool_use"`

          - `String id`

            pattern: ^[a-zA-Z0-9_-]+$

          - `Input input`

          - `String name`

            minLength: 1

          - `Optional<Caller> caller`

            - `class BetaDirectCaller`

              Tool invocation directly from the model.

              - `JsonValue type = "direct"`

            - `class BetaServerToolCaller`

              Tool invocation generated by a server-side tool.

              - `JsonValue type = "code_execution_20250825"`

              - `String toolId`

                pattern: ^srvtoolu_[a-zA-Z0-9_]+$

            - `class BetaServerToolCaller20260120`

              - `JsonValue type = "code_execution_20260120"`

              - `String toolId`

                pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<String> toolsetName`

            For a toolset member tool_use, the toolset family.

            minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$

        - `class BetaServerToolUseBlock`

          - `JsonValue type = "server_tool_use"`

          - `String id`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Input input`

          - `Name name`

            - `ADVISOR("advisor")`

            - `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<Caller> caller`

            - `class BetaDirectCaller`

              Tool invocation directly from the model.

            - `class BetaServerToolCaller`

              Tool invocation generated by a server-side tool.

            - `class BetaServerToolCaller20260120`

        - `class BetaWebSearchToolResultBlock`

          - `JsonValue type = "web_search_tool_result"`

          - `BetaWebSearchToolResultBlockContent content`

            - `class BetaWebSearchToolResultError`

              - `JsonValue type = "web_search_tool_result_error"`

              - `BetaWebSearchToolResultErrorCode 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<BetaWebSearchResultBlock>`

              - `JsonValue type = "web_search_result"`

              - `String encryptedContent`

              - `Optional<String> pageAge`

              - `String title`

              - `String url`

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<Caller> caller`

            - `class BetaDirectCaller`

              Tool invocation directly from the model.

            - `class BetaServerToolCaller`

              Tool invocation generated by a server-side tool.

            - `class BetaServerToolCaller20260120`

        - `class BetaWebFetchToolResultBlock`

          - `JsonValue type = "web_fetch_tool_result"`

          - `Content content`

            - `class BetaWebFetchToolResultErrorBlock`

              - `JsonValue type = "web_fetch_tool_result_error"`

              - `BetaWebFetchToolResultErrorCode 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 BetaWebFetchBlock`

              - `JsonValue type = "web_fetch_result"`

              - `BetaDocumentBlock content`

                - `JsonValue type = "document"`

                - `Optional<BetaCitationConfig> citations`

                  Citation configuration for the document

                  - `boolean enabled`

                - `Source source`

                  - `class BetaBase64PdfSource`

                    - `JsonValue type = "base64"`

                    - `String data`

                      format: byte

                    - `JsonValue mediaType = "application/pdf"`

                  - `class BetaPlainTextSource`

                    - `JsonValue type = "text"`

                    - `String data`

                    - `JsonValue mediaType = "text/plain"`

                - `Optional<String> title`

                  The title of the document

              - `Optional<String> retrievedAt`

                ISO 8601 timestamp when the content was retrieved

              - `String url`

                Fetched content URL

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `Optional<Caller> caller`

            - `class BetaDirectCaller`

              Tool invocation directly from the model.

            - `class BetaServerToolCaller`

              Tool invocation generated by a server-side tool.

            - `class BetaServerToolCaller20260120`

        - `class BetaAdvisorToolResultBlock`

          - `JsonValue type = "advisor_tool_result"`

          - `Content content`

            - `class BetaAdvisorToolResultError`

              - `JsonValue type = "advisor_tool_result_error"`

              - `ErrorCode errorCode`

                - `MAX_USES_EXCEEDED("max_uses_exceeded")`

                - `PROMPT_TOO_LONG("prompt_too_long")`

                - `TOO_MANY_REQUESTS("too_many_requests")`

                - `OVERLOADED("overloaded")`

                - `UNAVAILABLE("unavailable")`

                - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

                - `MODEL_NOT_FOUND("model_not_found")`

            - `class BetaAdvisorResultBlock`

              - `JsonValue type = "advisor_result"`

              - `Optional<String> stopReason`

                The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap.

              - `String text`

            - `class BetaAdvisorRedactedResultBlock`

              - `JsonValue type = "advisor_redacted_result"`

              - `String encryptedContent`

                Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify.

              - `Optional<String> stopReason`

                The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`).

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `class BetaCodeExecutionToolResultBlock`

          - `JsonValue type = "code_execution_tool_result"`

          - `BetaCodeExecutionToolResultBlockContent content`

            - `class BetaCodeExecutionToolResultError`

              - `JsonValue type = "code_execution_tool_result_error"`

              - `BetaCodeExecutionToolResultErrorCode errorCode`

                - `INVALID_TOOL_INPUT("invalid_tool_input")`

                - `UNAVAILABLE("unavailable")`

                - `TOO_MANY_REQUESTS("too_many_requests")`

                - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

            - `class BetaCodeExecutionResultBlock`

              - `JsonValue type = "code_execution_result"`

              - `List<BetaCodeExecutionOutputBlock> content`

                - `JsonValue type = "code_execution_output"`

                - `String fileId`

              - `long returnCode`

              - `String stderr`

              - `String stdout`

            - `class BetaEncryptedCodeExecutionResultBlock`

              Code execution result with encrypted stdout for PFC + web_search results.

              - `JsonValue type = "encrypted_code_execution_result"`

              - `List<BetaCodeExecutionOutputBlock> content`

                - `JsonValue type = "code_execution_output"`

                - `String fileId`

              - `String encryptedStdout`

              - `long returnCode`

              - `String stderr`

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `class BetaBashCodeExecutionToolResultBlock`

          - `JsonValue type = "bash_code_execution_tool_result"`

          - `Content content`

            - `class BetaBashCodeExecutionToolResultError`

              - `JsonValue type = "bash_code_execution_tool_result_error"`

              - `ErrorCode 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 BetaBashCodeExecutionResultBlock`

              - `JsonValue type = "bash_code_execution_result"`

              - `List<BetaBashCodeExecutionOutputBlock> content`

                - `JsonValue type = "bash_code_execution_output"`

                - `String fileId`

              - `long returnCode`

              - `String stderr`

              - `String stdout`

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `class BetaTextEditorCodeExecutionToolResultBlock`

          - `JsonValue type = "text_editor_code_execution_tool_result"`

          - `Content content`

            - `class BetaTextEditorCodeExecutionToolResultError`

              - `JsonValue type = "text_editor_code_execution_tool_result_error"`

              - `ErrorCode 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<String> errorMessage`

            - `class BetaTextEditorCodeExecutionViewResultBlock`

              - `JsonValue type = "text_editor_code_execution_view_result"`

              - `String content`

              - `FileType fileType`

                - `TEXT("text")`

                - `IMAGE("image")`

                - `PDF("pdf")`

              - `Optional<Long> numLines`

              - `Optional<Long> startLine`

              - `Optional<Long> totalLines`

            - `class BetaTextEditorCodeExecutionCreateResultBlock`

              - `JsonValue type = "text_editor_code_execution_create_result"`

              - `boolean isFileUpdate`

            - `class BetaTextEditorCodeExecutionStrReplaceResultBlock`

              - `JsonValue type = "text_editor_code_execution_str_replace_result"`

              - `Optional<List<String>> lines`

              - `Optional<Long> newLines`

              - `Optional<Long> newStart`

              - `Optional<Long> oldLines`

              - `Optional<Long> oldStart`

          - `String toolUseId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `class BetaToolSearchToolResultBlock`

          - `JsonValue type = "tool_search_tool_result"`

          - `Content content`

            - `class BetaToolSearchToolResultError`

              - `JsonValue type = "tool_search_tool_result_error"`

              - `ErrorCode errorCode`

                - `INVALID_TOOL_INPUT("invalid_tool_input")`

                - `UNAVAILABLE("unavailable")`

                - `TOO_MANY_REQUESTS("too_many_requests")`

                - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

              - `Optional<String> errorMessage`

            - `class BetaToolSearchToolSearchResultBlock`

              - `JsonValue type = "tool_search_tool_search_result"`

              - `List<BetaToolReferenceBlock> 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 BetaMcpToolUseBlock`

          - `JsonValue type = "mcp_tool_use"`

          - `String id`

            pattern: ^[a-zA-Z0-9_-]+$

          - `Input input`

          - `String name`

            The name of the MCP tool

          - `String serverName`

            The name of the MCP server

        - `class BetaMcpToolResultBlock`

          - `JsonValue type = "mcp_tool_result"`

          - `Content content`

            - `String`

            - `List<BetaTextBlock>`

              - `JsonValue type = "text"`

              - `Optional<List<BetaTextCitation>> 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`.

              - `String text`

          - `boolean isError`

          - `String toolUseId`

            pattern: ^[a-zA-Z0-9_-]+$

        - `class BetaContainerUploadBlock`

          Response model for a file uploaded to the container.

          - `JsonValue type = "container_upload"`

          - `String fileId`

        - `class BetaCompactionBlock`

          A compaction block returned when autocompact is triggered.

          When content is None, it indicates the compaction failed to produce a valid
          summary (e.g., malformed output from the model). Clients may round-trip
          compaction blocks with null content; the server treats them as no-ops.

          - `JsonValue type = "compaction"`

          - `Optional<String> content`

            Summary of compacted content, or null if compaction failed

          - `Optional<String> encryptedContent`

            Opaque metadata from prior compaction, to be round-tripped verbatim

          - `Optional<String> signature`

            Signature over the summary, to be sent back with the block verbatim

          - `Optional<List<ToolChange>> toolChanges`

            The tool changes of the compacted range: the `tool_addition` and `tool_removal` blocks that take the request's `tools` to the tool set in effect at the end of the range, or `[]` when the range changed no tool. Absent when the server did not compute them. Send the block back unchanged.

            - `class BetaResponseToolAdditionBlock`

              An entry of a `compaction` block's `tool_changes`: a tool the
              compacted range made available, as a reference to a `tools` entry or
              MCP toolset, or as the tool definition in effect at the end of the
              range, by value. Send it back unchanged.

              - `JsonValue type = "tool_addition"`

              - `Tool tool`

                The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value.

                - `class BetaResponseToolChangeToolReference`

                  Reference to a single tool, by the name the model uses to call it, as
                  a `compaction` block's `tool_changes` entry reports it: a tool
                  declared in `tools` or defined by an earlier `tool_addition` block.
                  Send it back unchanged with the block.

                  - `JsonValue type = "tool_reference"`

                  - `String name`

                - `class BetaResponseToolChangeMcpToolReference`

                  Reference to a single MCP tool, by its server and its name on that
                  server, as a `compaction` block's `tool_changes` entry reports it.
                  Send it back unchanged with the block.

                  - `JsonValue type = "mcp_tool_reference"`

                  - `String name`

                  - `String serverName`

                - `class BetaResponseToolChangeMcpToolsetReference`

                  Reference to every tool in the named MCP server's toolset, as a
                  `compaction` block's `tool_changes` entry reports it. Send it back
                  unchanged with the block.

                  - `JsonValue type = "mcp_toolset_reference"`

                  - `String serverName`

                - `class BetaToolChangeToolDefinition`

                  A tool defined by value, as a `compaction` block's `tool_changes` entry
                  reports it: `definition` is the tool's definition as it was sent, in the
                  form of a `tools` entry, without `cache_control`. Send it back unchanged
                  with the block.

                  - `JsonValue type = "tool_definition"`

                  - `BetaResponseToolUnion definition`

                    - `class BetaResponseTool`

                      A custom tool definition, as sent.

                      - `Optional<Type> type`

                      - `BetaResponseToolInputSchema 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> properties`

                        - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolBash20241022`

                      - `JsonValue type = "bash_20241022"`

                      - `JsonValue name = "bash"`

                        Name of the tool.

                        This is how the tool will be called by the model and in `tool_use` blocks.

                      - `Optional<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                        - `JsonValue type = "ephemeral"`

                        - `Optional<Ttl> 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<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolBash20250124`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaCodeExecutionTool20250522`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaCodeExecutionTool20250825`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaCodeExecutionTool20260120`

                      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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaCodeExecutionTool20260521`

                      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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaBrowserToolset20260801`

                      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<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

                          `type`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserCloseTabConfig> closeTab`

                          `close_tab`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

                          `double_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserFileUploadConfig> fileUpload`

                          `file_upload`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserFindConfig> find`

                          `find`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserFormInputConfig> formInput`

                          `form_input`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserGetPageTextConfig> getPageText`

                          `get_page_text`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserHoldKeyConfig> holdKey`

                          `hold_key`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserHoverConfig> hover`

                          `hover`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

                          `javascript_exec`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserKeyConfig> key`

                          `key`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserLeftClickConfig> leftClick`

                          `left_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

                          `left_click_drag`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

                          `left_mouse_down`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

                          `left_mouse_up`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserListTabsConfig> listTabs`

                          `list_tabs`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserMiddleClickConfig> middleClick`

                          `middle_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

                          `mouse_move`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserNavigateConfig> navigate`

                          `navigate`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserNewTabConfig> newTab`

                          `new_tab`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserReadConsoleConfig> readConsole`

                          `read_console`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

                          `read_network`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserReadPageConfig> readPage`

                          `read_page`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserRightClickConfig> rightClick`

                          `right_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserScreenshotConfig> screenshot`

                          `screenshot`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserScrollConfig> scroll`

                          `scroll`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserScrollToConfig> scrollTo`

                          `scroll_to`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserSwitchTabConfig> switchTab`

                          `switch_tab`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserTripleClickConfig> tripleClick`

                          `triple_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserWaitConfig> wait`

                          `wait`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaBrowserZoomConfig> zoom`

                          `zoom`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered 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 BetaToolComputerUse20241022`

                      - `JsonValue type = "computer_20241022"`

                      - `long displayHeightPx`

                        The height of the display in pixels.

                        minimum: 1

                      - `long displayWidthPx`

                        The width of the display in pixels.

                        minimum: 1

                      - `JsonValue name = "computer"`

                        Name of the tool.

                        This is how the tool will be called by the model and in `tool_use` blocks.

                      - `Optional<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> displayNumber`

                        The X11 display number (e.g. 0, 1) for the display.

                        minimum: 0

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaMemoryTool20250818`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolComputerUse20250124`

                      - `JsonValue type = "computer_20250124"`

                      - `long displayHeightPx`

                        The height of the display in pixels.

                        minimum: 1

                      - `long displayWidthPx`

                        The width of the display in pixels.

                        minimum: 1

                      - `JsonValue name = "computer"`

                        Name of the tool.

                        This is how the tool will be called by the model and in `tool_use` blocks.

                      - `Optional<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> displayNumber`

                        The X11 display number (e.g. 0, 1) for the display.

                        minimum: 0

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolTextEditor20241022`

                      - `JsonValue type = "text_editor_20241022"`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolComputerUse20251124`

                      - `JsonValue type = "computer_20251124"`

                      - `long displayHeightPx`

                        The height of the display in pixels.

                        minimum: 1

                      - `long displayWidthPx`

                        The width of the display in pixels.

                        minimum: 1

                      - `JsonValue name = "computer"`

                        Name of the tool.

                        This is how the tool will be called by the model and in `tool_use` blocks.

                      - `Optional<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> displayNumber`

                        The X11 display number (e.g. 0, 1) for the display.

                        minimum: 0

                      - `Optional<Boolean> enableZoom`

                        Whether to enable an action to take a zoomed-in screenshot of the screen.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaComputerToolset20260801`

                      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<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

                          `type`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

                          `cursor_position`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerDoubleClickConfig> doubleClick`

                          `double_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerHoldKeyConfig> holdKey`

                          `hold_key`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerKeyConfig> key`

                          `key`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerLeftClickConfig> leftClick`

                          `left_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

                          `left_click_drag`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

                          `left_mouse_down`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

                          `left_mouse_up`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerMiddleClickConfig> middleClick`

                          `middle_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerMouseMoveConfig> mouseMove`

                          `mouse_move`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerRightClickConfig> rightClick`

                          `right_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerScreenshotConfig> screenshot`

                          `screenshot`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerScrollConfig> scroll`

                          `scroll`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerTripleClickConfig> tripleClick`

                          `triple_click`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerWaitConfig> wait`

                          `wait`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                        - `Optional<BetaComputerZoomConfig> zoom`

                          `zoom`'s config overrides.

                          - `Optional<Boolean> deferLoading`

                            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                          - `Optional<Boolean> enabled`

                            Whether this member is offered 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 BetaToolTextEditor20250124`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolTextEditor20250429`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolTextEditor20250728`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<List<InputExample>> inputExamples`

                      - `Optional<Long> maxCharacters`

                        Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaWebSearchTool20250305`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                      - `Optional<List<String>> blockedDomains`

                        If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaUserLocation> userLocation`

                        Parameters for the user's location. Used to provide more relevant search results.

                        - `JsonValue type = "approximate"`

                        - `Optional<String> city`

                          The city of the user.

                          minLength: 1, maxLength: 255

                        - `Optional<String> 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<String> region`

                          The region of the user.

                          minLength: 1, maxLength: 255

                        - `Optional<String> timezone`

                          The [IANA timezone](https://nodatime.org/TimeZones) of the user.

                          minLength: 1, maxLength: 255

                    - `class BetaWebFetchTool20250910`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        List of domains to allow fetching from

                      - `Optional<List<String>> blockedDomains`

                        List of domains to block fetching from

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaCitationsConfigParam> citations`

                        Citations configuration for fetched documents. Citations are disabled by default.

                        - `Optional<Boolean> enabled`

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> 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<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaWebFetchUrlSources> urlSources`

                        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                        - `Optional<ClientToolResults> clientToolResults`

                          Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

                          - `class BetaWebFetchUrlSourceAll`

                            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 BetaWebFetchUrlSourceNone`

                            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 BetaWebFetchUrlSourceOnly`

                            The tool filter variant under which only the named tools' results
                            contribute.

                            - `JsonValue type = "only"`

                            - `List<BetaWebFetchUrlSourceToolReference> tools`

                              - `JsonValue type = "tool_reference"`

                              - `String name`

                          - `class BetaWebFetchUrlSourceExcept`

                            The tool filter variant under which every result but the named
                            tools' contributes.

                            - `JsonValue type = "except"`

                            - `List<BetaWebFetchUrlSourceToolReference> tools`

                              - `JsonValue type = "tool_reference"`

                              - `String name`

                        - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

                            The `url_sources` variant under which a source contributes in
                            full: every result of the tool filter's source, or all user input.

                          - `class BetaWebFetchUrlSourceNone`

                            The `url_sources` variant under which a source contributes nothing:
                            no result of the tool filter's source, or no user input.

                          - `class BetaWebFetchUrlSourceOnly`

                            The tool filter variant under which only the named tools' results
                            contribute.

                          - `class BetaWebFetchUrlSourceExcept`

                            The tool filter variant under which every result but the named
                            tools' contributes.

                        - `Optional<UserInput> userInput`

                          Whether URLs in user messages are fetchable: "all" or "none".

                          - `class BetaWebFetchUrlSourceAll`

                            The `url_sources` variant under which a source contributes in
                            full: every result of the tool filter's source, or all user input.

                          - `class BetaWebFetchUrlSourceNone`

                            The `url_sources` variant under which a source contributes nothing:
                            no result of the tool filter's source, or no user input.

                    - `class BetaWebSearchTool20260209`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                      - `Optional<List<String>> blockedDomains`

                        If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaUserLocation> userLocation`

                        Parameters for the user's location. Used to provide more relevant search results.

                    - `class BetaWebFetchTool20260209`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        List of domains to allow fetching from

                      - `Optional<List<String>> blockedDomains`

                        List of domains to block fetching from

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaCitationsConfigParam> citations`

                        Citations configuration for fetched documents. Citations are disabled by default.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> 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<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaWebFetchUrlSources> urlSources`

                        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                    - `class BetaWebFetchTool20260309`

                      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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        List of domains to allow fetching from

                      - `Optional<List<String>> blockedDomains`

                        List of domains to block fetching from

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaCitationsConfigParam> citations`

                        Citations configuration for fetched documents. Citations are disabled by default.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> 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<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaWebFetchUrlSources> urlSources`

                        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                      - `Optional<Boolean> 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 BetaWebSearchTool20260318`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                      - `Optional<List<String>> blockedDomains`

                        If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<ResponseInclusion> 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<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaUserLocation> userLocation`

                        Parameters for the user's location. Used to provide more relevant search results.

                    - `class BetaWebFetchTool20260318`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<List<String>> allowedDomains`

                        List of domains to allow fetching from

                      - `Optional<List<String>> blockedDomains`

                        List of domains to block fetching from

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaCitationsConfigParam> citations`

                        Citations configuration for fetched documents. Citations are disabled by default.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> 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<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<ResponseInclusion> 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<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                      - `Optional<BetaWebFetchUrlSources> urlSources`

                        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                      - `Optional<Boolean> 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 BetaAdvisorTool20260301`

                      - `JsonValue type = "advisor_20260301"`

                      - `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 name = "advisor"`

                        Name of the tool.

                        This is how the tool will be called by the model and in `tool_use` blocks.

                      - `Optional<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<BetaCacheControlEphemeral> caching`

                        Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Long> maxTokens`

                        Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

                        minimum: 1024

                      - `Optional<Long> maxUses`

                        Maximum number of times the tool can be used in the API request.

                        minimum: 1

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaToolSearchToolRegex20251119`

                      - `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<List<AllowedCaller>> allowedCallers`

                        - `DIRECT("direct")`

                        - `CODE_EXECUTION_20250825("code_execution_20250825")`

                        - `CODE_EXECUTION_20260120("code_execution_20260120")`

                        - `CODE_EXECUTION_20260521("code_execution_20260521")`

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Boolean> deferLoading`

                        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                      - `Optional<Boolean> strict`

                        When true, guarantees schema validation on tool names and inputs

                    - `class BetaMcpToolset`

                      Configuration for a group of tools from an MCP server.

                      Allows configuring enabled status and defer_loading for all tools
                      from an MCP server, with optional per-tool overrides.

                      - `JsonValue type = "mcp_toolset"`

                      - `String mcpServerName`

                        Name of the MCP server to configure tools for

                        minLength: 1, maxLength: 255

                      - `Optional<BetaCacheControlEphemeral> cacheControl`

                        Create a cache control breakpoint at this content block.

                      - `Optional<Configs> configs`

                        Configuration overrides for specific tools, keyed by tool name

                        - `Optional<Boolean> deferLoading`

                        - `Optional<Boolean> enabled`

                      - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

                        Default configuration applied to all tools from this server

                        - `Optional<Boolean> deferLoading`

                        - `Optional<Boolean> enabled`

                      - `Optional<List<BetaMcpToolParam>> tools`

                        The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

                        - `InputSchema inputSchema`

                          The tool's input schema as the MCP server lists it, verbatim.

                        - `String name`

                          The tool's name as the MCP server lists it (not prefixed with the server name).

                          minLength: 1

                        - `Optional<String> description`

                          The tool's description as the MCP server lists it.

            - `class BetaResponseToolRemovalBlock`

              An entry of a `compaction` block's `tool_changes`: a tool of the
              request's `tools` (or an MCP tool or toolset) that the compacted range
              withdrew. Send it back unchanged.

              - `JsonValue type = "tool_removal"`

              - `Tool tool`

                A reference to the withdrawn `tools` entry, MCP tool or MCP toolset.

                - `class BetaResponseToolChangeToolReference`

                  Reference to a single tool, by the name the model uses to call it, as
                  a `compaction` block's `tool_changes` entry reports it: a tool
                  declared in `tools` or defined by an earlier `tool_addition` block.
                  Send it back unchanged with the block.

                - `class BetaResponseToolChangeMcpToolReference`

                  Reference to a single MCP tool, by its server and its name on that
                  server, as a `compaction` block's `tool_changes` entry reports it.
                  Send it back unchanged with the block.

                - `class BetaResponseToolChangeMcpToolsetReference`

                  Reference to every tool in the named MCP server's toolset, as a
                  `compaction` block's `tool_changes` entry reports it. Send it back
                  unchanged with the block.

        - `class BetaFallbackBlock`

          Marks the point in `content` where one model's output gives way to the next.

          One block appears per hop where a preceding model actually ran this turn and
          declined. A turn where no preceding model ran and declined has no such
          boundary and carries no block — the signal for whether a fallback model
          served the response is the presence of a `fallback_message` entry in
          `usage.iterations`, not this block.

          The block is treated like a server-tool content block for streaming: it
          arrives via the standard `content_block_start` / `content_block_stop`
          pair and carries no deltas.

          - `JsonValue type = "fallback"`

          - `BetaFallbackInfo from`

            The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id.

            - `Model model`

              The model that will complete your prompt.

              See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

          - `BetaFallbackInfo to`

            The fallback model producing the content that follows this block. Its `model` is always the canonical id.

          - `BetaFallbackRefusalTrigger trigger`

            What caused the `from` model to hand over at this hop.

            - `JsonValue type = "refusal"`

            - `Optional<Category> category`

              The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.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.

        - `class BetaMcpToolListingBlock`

          The tool listing the server fetched from an MCP server while producing
          this response. Send the assistant message back unchanged, this block
          included, so later requests use this listing instead of asking the MCP
          server again.

          - `JsonValue type = "mcp_tool_listing"`

          - `String mcpServerName`

          - `List<BetaMcpTool> tools`

            - `InputSchema inputSchema`

            - `String name`

            - `Optional<String> description`

      - `Optional<BetaContextManagementResponse> contextManagement`

        Context management response.

        Information about context management strategies applied during the request.

        - `List<AppliedEdit> appliedEdits`

          List of context management edits that were applied.

          - `class BetaClearToolUses20250919EditResponse`

            - `JsonValue type = "clear_tool_uses_20250919"`

              The type of context management edit applied.

            - `long clearedInputTokens`

              Number of input tokens cleared by this edit.

              minimum: 0

            - `long clearedToolUses`

              Number of tool uses that were cleared.

              minimum: 0

          - `class BetaClearThinking20251015EditResponse`

            - `JsonValue type = "clear_thinking_20251015"`

              The type of context management edit applied.

            - `long clearedInputTokens`

              Number of input tokens cleared by this edit.

              minimum: 0

            - `long clearedThinkingTurns`

              Number of thinking turns that were cleared.

              minimum: 0

      - `Optional<BetaDiagnostics> diagnostics`

        Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected.

        - `Optional<BetaCacheMissReason> 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 BetaCacheMissModelChanged`

            - `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 BetaCacheMissSystemChanged`

            - `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 BetaCacheMissToolsChanged`

            - `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 BetaCacheMissMessagesChanged`

            - `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 BetaCacheMissPreviousMessageNotFound`

            - `JsonValue type = "previous_message_not_found"`

          - `class BetaCacheMissUnavailable`

            - `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.

      - `JsonValue role = "assistant"`

        Conversational role of the generated message.

        This will always be `"assistant"`.

      - `Optional<BetaRefusalStopDetails> 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> 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<String> 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<String> fallbackCreditToken`

          Opaque code that refunds the cache-miss cost when retrying this refused
          request on the fallback model. Pass it as `fallback_credit_token` on the
          retry request. Expires 5 minutes after the refusal.

          The retry is sent either with the same request body (`system`, `messages`,
          `tools`, and other render-shaping fields), or with the same body plus one
          appended `assistant` message whose content is the partial text (with any
          trailing whitespace stripped from the final text block) and paired
          server-tool blocks from this refusal — which also authorizes that
          appended turn as an assistant-prefill continuation on models that otherwise
          disallow prefill. A token minted mid-server-tool-loop whose partial content
          was continuable may only be redeemed the second way — if a same-body retry
          is rejected with a 400 saying the token must be redeemed by continuing the
          partial response, retry the second way instead. Either way: same workspace,
          same platform; a mismatch is a 400. Resending a token for an already-warm
          prefix is permitted but yields no additional credit.

          `null` when the refused model isn't eligible for a fallback credit.

        - `Optional<Boolean> fallbackHasPrefillClaim`

          Whether the accompanying `fallback_credit_token` may be redeemed with the
          appended-assistant retry form. Only set when `fallback_credit_token` is
          present.

          `true`: retry by resending the same request body plus one appended
          `assistant` message whose content is this response's `content` with any
          trailing whitespace stripped from the final text block and unpaired
          `tool_use` blocks omitted (the same appended-turn shape described on
          `fallback_credit_token`), with the token attached. `false`: retry by
          resending the original request body unchanged, with the token attached —
          the appended-assistant form is not available for this refusal (no
          continuable partial content, or the request uses `output_format` or a
          `tool_choice` that forces tool use). One exception: when the request used
          `output_format` or a forced `tool_choice` and the refusal arrived after
          server tools (including MCP connector tools) had already executed, the
          token may not be redeemable by either retry form; if the exact-body retry
          is then rejected with a 400 saying the token must be redeemed by
          continuing the partial response, discard the token and retry without it.

          Advisory: if an appended-assistant retry is rejected with a 400 despite
          `true`, fall back to resending the original request body with the token.

        - `Optional<String> recommendedModel`

          The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise.

      - `Optional<BetaStopReason> 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")`

        - `COMPACTION("compaction")`

        - `REFUSAL("refusal")`

        - `MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")`

      - `Optional<String> 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.

      - `BetaUsage 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<BetaCacheCreation> 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<Long> cacheCreationInputTokens`

          The number of input tokens used to create the cache entry.

          minimum: 0

        - `Optional<Long> cacheReadInputTokens`

          The number of input tokens read from the cache.

          minimum: 0

        - `Optional<BetaFallbackCreditUsage> fallbackCredit`

          Outcome of the `fallback_credit_token` presented on this request.

          Present on every response to a non-batch request that carried a
          `fallback_credit_token`, in either redemption mode; absent otherwise (batch
          items accept and ignore the token and carry no outcome object).

          - `Status status`

            Whether the fallback-credit reprice was applied to this response's billing.

            A union discriminated on `type`. `redeemed`: the retry is billed as if
            the conversation had been on the retry model all along — including when the
            resulting shift is zero because there was nothing to move. `not_applied`:
            no reprice was applied; the arm's `reason` says why.

            - `class BetaFallbackCreditRedeemed`

              The reprice was applied: the retry is billed as if the conversation
              had been on the retry model all along.

              - `JsonValue type = "redeemed"`

            - `class BetaFallbackCreditNotApplied`

              No reprice was applied; `reason` says why.

              - `JsonValue type = "not_applied"`

              - `Reason reason`

                Why the reprice was not applied.

                A closed enum; additions to the redemption-check vocabulary arrive as
                deliberate schema updates.

                - `BODY_MISMATCH("body_mismatch")`

                - `CONTINUATION_EXCLUDED("continuation_excluded")`

                - `CONTINUATION_ONLY("continuation_only")`

                - `EXPIRED("expired")`

                - `INVALID_TARGET_MODEL("invalid_target_model")`

                - `NOT_ENABLED("not_enabled")`

                - `REPRICE_UNAVAILABLE("reprice_unavailable")`

                - `TEMPORARILY_UNAVAILABLE("temporarily_unavailable")`

                - `VARIANT_FIELDS_PRESENT("variant_fields_present")`

                - `WRONG_ORGANIZATION("wrong_organization")`

                - `WRONG_PLATFORM("wrong_platform")`

                - `WRONG_WORKSPACE("wrong_workspace")`

              - `Optional<List<String>> removeToRedeem`

                Request fields to remove before retrying, so the retry can redeem this
                token.

                Present exactly when `reason` is `variant_fields_present` — never null,
                never an empty array; absent otherwise. Fields are named only from your own request, and only after
                the sealed variant hash matched. A served best-effort retry has already
                been billed at normal price; nothing redeems retroactively, but a corrected
                re-send inside the token's five-minute window can still redeem.

        - `Optional<String> inferenceGeo`

          The geographic region where inference was performed for this request.

        - `long inputTokens`

          The number of input tokens which were used.

          minimum: 0

        - `Optional<List<Iteration>> iterations`

          Per-iteration token usage breakdown.

          Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to:

          - Calculate the context window size from the last `message` entry
          - Understand token accumulation across server-side tool use loops

          A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results.

          - `class BetaMessageIterationUsage`

            Token usage for a sampling iteration.

            - `JsonValue type = "message"`

              Usage for a sampling iteration

            - `Optional<BetaCacheCreation> cacheCreation`

              Breakdown of cached tokens by TTL

            - `long cacheCreationInputTokens`

              The number of input tokens used to create the cache entry.

              minimum: 0

            - `long cacheReadInputTokens`

              The number of input tokens read from the cache.

              minimum: 0

            - `long inputTokens`

              The number of input tokens which were used.

              minimum: 0

            - `Optional<Model> model`

              The model that will complete your prompt.

              See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

            - `long outputTokens`

              The number of output tokens which were used.

              minimum: 0

          - `class BetaCompactionIterationUsage`

            Token usage for a compaction iteration.

            - `JsonValue type = "compaction"`

              Usage for a compaction iteration

            - `Optional<BetaCacheCreation> cacheCreation`

              Breakdown of cached tokens by TTL

            - `long cacheCreationInputTokens`

              The number of input tokens used to create the cache entry.

              minimum: 0

            - `long cacheReadInputTokens`

              The number of input tokens read from the cache.

              minimum: 0

            - `long inputTokens`

              The number of input tokens which were used.

              minimum: 0

            - `long outputTokens`

              The number of output tokens which were used.

              minimum: 0

          - `class BetaAdvisorMessageIterationUsage`

            Token usage for an advisor sub-inference iteration.

            - `JsonValue type = "advisor_message"`

              Usage for an advisor sub-inference iteration

            - `Optional<BetaCacheCreation> cacheCreation`

              Breakdown of cached tokens by TTL

            - `long cacheCreationInputTokens`

              The number of input tokens used to create the cache entry.

              minimum: 0

            - `long cacheReadInputTokens`

              The number of input tokens read from the cache.

              minimum: 0

            - `long inputTokens`

              The number of input tokens which were used.

              minimum: 0

            - `Model model`

              The model that will complete your prompt.

              See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

            - `long outputTokens`

              The number of output tokens which were used.

              minimum: 0

          - `class BetaFallbackMessageIterationUsage`

            Token usage for the fallback-model attempt of a server-side fallback request.

            The terminal entry of a fallback-served turn: when a fallback hop's
            output is the returned message, the entry for the iteration that
            completed it carries this type in place of `message`. A declined hop
            and the serving hop's earlier tool-loop iterations produce `message`
            entries. Whether a fallback model served the response is signalled by
            the presence of this entry in `usage.iterations`.

            - `JsonValue type = "fallback_message"`

              Usage for the fallback-model attempt that served the response

            - `Optional<BetaCacheCreation> cacheCreation`

              Breakdown of cached tokens by TTL

            - `long cacheCreationInputTokens`

              The number of input tokens used to create the cache entry.

              minimum: 0

            - `long cacheReadInputTokens`

              The number of input tokens read from the cache.

              minimum: 0

            - `long inputTokens`

              The number of input tokens which were used.

              minimum: 0

            - `Model model`

              The model that will complete your prompt.

              See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

            - `long outputTokens`

              The number of output tokens which were used.

              minimum: 0

        - `long outputTokens`

          The number of output tokens which were used.

          minimum: 0

        - `Optional<BetaOutputTokensDetails> 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<BetaServerToolUsage> 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> serviceTier`

          If the request used the priority, standard, or batch tier.

          - `STANDARD("standard")`

          - `PRIORITY("priority")`

          - `BATCH("batch")`

        - `Optional<Speed> speed`

          The inference speed mode used for this request.

          - `STANDARD("standard")`

          - `FAST("fast")`

      - `Optional<List<BetaInputTransformation>> inputTransformations`

        Changes the API made to the request's input before showing it to the model,
        and blocks that failed a binding check but were left unchanged: one entry per
        block, in request order. Two entry types today. `thinking_dropped` — a
        `thinking`, `redacted_thinking` or `connector_text` block from the request's
        `messages` that was removed from the prompt instead of being shown to the
        model because it failed a binding check. `thinking_mismatch_allowed` — a
        `thinking` or `redacted_thinking` block that failed the conversation check
        (the conversation before it differs from the one it was created in, or it
        carries no record of one on a model that requires it) and was shown to the
        model all the same, because that check is not enforced for this request.
        More entry types may be added over time; ignore types you do not recognize.

        Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on
        every such response from a model that supports extended thinking, as `[]`
        when there is no entry to report; without the beta, blocks are removed or
        left in place all the same but nothing is reported. Removed blocks contribute
        nothing to `usage.input_tokens`; blocks left in place count as sent. When
        streaming, the array is final in `message_start`; the final `message_delta`
        event carries it only when a server-side model fallback happened mid-stream,
        in which case it holds the serving model's entries and replaces the one in
        `message_start`.

        - `class BetaThinkingDroppedInputTransformation`

          - `JsonValue type = "thinking_dropped"`

            Always `thinking_dropped` for this entry type.

          - `String path`

            Where the removed block was in your request, as `messages.{i}.content.{j}`:
            `i` indexes the `messages` array you sent and `j` that message's `content`
            array — the same form error messages use.

          - `Reason reason`

            Which binding check removed the block: `model_binding_mismatch` — it was
            created by a model whose reasoning the requested model may not read;
            `prefix_binding_mismatch` — the conversation before it differs from the
            conversation it was created in (the rest of that turn's consecutive thinking
            blocks are removed with it, each with this reason);
            `organization_binding_mismatch` — it was created under a different
            organization (an Anthropic organization, AWS account or Google Cloud project)
            and this organization is not one of its additional organizations;
            `end_user_binding_mismatch` — it was created for a different end user, or
            was removed by the consumer-organization binding. A block that would fail
            several checks reports one reason, in this order of precedence:
            `organization_binding_mismatch`, `end_user_binding_mismatch`,
            `model_binding_mismatch`, `prefix_binding_mismatch`.

            - `MODEL_BINDING_MISMATCH("model_binding_mismatch")`

            - `PREFIX_BINDING_MISMATCH("prefix_binding_mismatch")`

            - `ORGANIZATION_BINDING_MISMATCH("organization_binding_mismatch")`

            - `END_USER_BINDING_MISMATCH("end_user_binding_mismatch")`

        - `class BetaThinkingMismatchAllowedInputTransformation`

          - `JsonValue type = "thinking_mismatch_allowed"`

            Always `thinking_mismatch_allowed` for this entry type.

          - `String path`

            Where the block is in your request, as `messages.{i}.content.{j}`:
            `i` indexes the `messages` array you sent and `j` that message's `content`
            array — the same form error messages use.

          - `Reason reason`

            Which binding check the block failed; the block was shown to the model all
            the same. Always `prefix_binding_mismatch` today — the conversation before
            the block differs from the conversation it was created in, or the block
            carries no record of one on a model that requires it. Were the check
            enforced for this request, the block would have been removed or the request
            rejected (`thinking.block_binding.prefix_mismatch_behavior`). A removal also
            takes the rest of that turn's consecutive thinking blocks, whereas here each
            block is checked on its own, so `thinking_mismatch_allowed` entries are a
            lower bound on what enforcement would remove.

            - `MODEL_BINDING_MISMATCH("model_binding_mismatch")`

            - `PREFIX_BINDING_MISMATCH("prefix_binding_mismatch")`

            - `ORGANIZATION_BINDING_MISMATCH("organization_binding_mismatch")`

            - `END_USER_BINDING_MISMATCH("end_user_binding_mismatch")`

  - `class BetaRawMessageDeltaEvent`

    - `JsonValue type = "message_delta"`

    - `Optional<BetaContextManagementResponse> contextManagement`

      Information about context management strategies applied during the request

    - `Delta delta`

      - `Optional<BetaContainer> 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<BetaRefusalStopDetails> stopDetails`

        Structured information about why model output stopped.

        This is `null` when the `stop_reason` has no additional detail to report.

      - `Optional<BetaStopReason> stopReason`

      - `Optional<String> stopSequence`

    - `BetaMessageDeltaUsage 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<Long> cacheCreationInputTokens`

        The cumulative number of input tokens used to create the cache entry.

        minimum: 0

      - `Optional<Long> cacheReadInputTokens`

        The cumulative number of input tokens read from the cache.

        minimum: 0

      - `Optional<BetaFallbackCreditUsage> fallbackCredit`

        Outcome of the `fallback_credit_token` presented on this request.

        Present on every response to a non-batch request that carried a
        `fallback_credit_token`, in either redemption mode; absent otherwise (batch
        items accept and ignore the token and carry no outcome object).

      - `Optional<Long> inputTokens`

        The cumulative number of input tokens which were used.

        minimum: 0

      - `Optional<List<Iteration>> iterations`

        Per-iteration token usage breakdown.

        Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to:

        - Calculate the context window size from the last `message` entry
        - Understand token accumulation across server-side tool use loops

        A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results.

        - `class BetaMessageIterationUsage`

          Token usage for a sampling iteration.

        - `class BetaCompactionIterationUsage`

          Token usage for a compaction iteration.

        - `class BetaAdvisorMessageIterationUsage`

          Token usage for an advisor sub-inference iteration.

        - `class BetaFallbackMessageIterationUsage`

          Token usage for the fallback-model attempt of a server-side fallback request.

          The terminal entry of a fallback-served turn: when a fallback hop's
          output is the returned message, the entry for the iteration that
          completed it carries this type in place of `message`. A declined hop
          and the serving hop's earlier tool-loop iterations produce `message`
          entries. Whether a fallback model served the response is signalled by
          the presence of this entry in `usage.iterations`.

      - `long outputTokens`

        The cumulative number of output tokens which were used.

      - `Optional<BetaOutputTokensDetails> 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<BetaServerToolUsage> serverToolUse`

        The number of server tool requests.

    - `Optional<List<BetaInputTransformation>> inputTransformations`

      Changes the API made to the request's input before showing it to the model,
      and blocks that failed a binding check but were left unchanged: one entry per
      block, in request order. Two entry types today. `thinking_dropped` — a
      `thinking`, `redacted_thinking` or `connector_text` block from the request's
      `messages` that was removed from the prompt instead of being shown to the
      model because it failed a binding check. `thinking_mismatch_allowed` — a
      `thinking` or `redacted_thinking` block that failed the conversation check
      (the conversation before it differs from the one it was created in, or it
      carries no record of one on a model that requires it) and was shown to the
      model all the same, because that check is not enforced for this request.
      More entry types may be added over time; ignore types you do not recognize.

      Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on
      every such response from a model that supports extended thinking, as `[]`
      when there is no entry to report; without the beta, blocks are removed or
      left in place all the same but nothing is reported. Removed blocks contribute
      nothing to `usage.input_tokens`; blocks left in place count as sent. When
      streaming, the array is final in `message_start`; the final `message_delta`
      event carries it only when a server-side model fallback happened mid-stream,
      in which case it holds the serving model's entries and replaces the one in
      `message_start`.

      - `class BetaThinkingDroppedInputTransformation`

      - `class BetaThinkingMismatchAllowedInputTransformation`

  - `class BetaRawMessageStopEvent`

    - `JsonValue type = "message_stop"`

  - `class BetaRawContentBlockStartEvent`

    - `JsonValue type = "content_block_start"`

    - `ContentBlock contentBlock`

      - `class BetaTextBlock`

      - `class BetaThinkingBlock`

      - `class BetaRedactedThinkingBlock`

      - `class BetaToolUseBlock`

      - `class BetaServerToolUseBlock`

      - `class BetaWebSearchToolResultBlock`

      - `class BetaWebFetchToolResultBlock`

      - `class BetaAdvisorToolResultBlock`

      - `class BetaCodeExecutionToolResultBlock`

      - `class BetaBashCodeExecutionToolResultBlock`

      - `class BetaTextEditorCodeExecutionToolResultBlock`

      - `class BetaToolSearchToolResultBlock`

      - `class BetaMcpToolUseBlock`

      - `class BetaMcpToolResultBlock`

      - `class BetaContainerUploadBlock`

        Response model for a file uploaded to the container.

      - `class BetaCompactionBlock`

        A compaction block returned when autocompact is triggered.

        When content is None, it indicates the compaction failed to produce a valid
        summary (e.g., malformed output from the model). Clients may round-trip
        compaction blocks with null content; the server treats them as no-ops.

      - `class BetaFallbackBlock`

        Marks the point in `content` where one model's output gives way to the next.

        One block appears per hop where a preceding model actually ran this turn and
        declined. A turn where no preceding model ran and declined has no such
        boundary and carries no block — the signal for whether a fallback model
        served the response is the presence of a `fallback_message` entry in
        `usage.iterations`, not this block.

        The block is treated like a server-tool content block for streaming: it
        arrives via the standard `content_block_start` / `content_block_stop`
        pair and carries no deltas.

      - `class BetaMcpToolListingBlock`

        The tool listing the server fetched from an MCP server while producing
        this response. Send the assistant message back unchanged, this block
        included, so later requests use this listing instead of asking the MCP
        server again.

    - `long index`

  - `class BetaRawContentBlockDeltaEvent`

    - `JsonValue type = "content_block_delta"`

    - `BetaRawContentBlockDelta delta`

      - `class BetaTextDelta`

        - `JsonValue type = "text_delta"`

        - `String text`

      - `class BetaInputJsonDelta`

        - `JsonValue type = "input_json_delta"`

        - `String partialJson`

      - `class BetaCitationsDelta`

        - `JsonValue type = "citations_delta"`

        - `Citation citation`

          - `class BetaCitationCharLocation`

          - `class BetaCitationPageLocation`

          - `class BetaCitationContentBlockLocation`

          - `class BetaCitationsWebSearchResultLocation`

          - `class BetaCitationSearchResultLocation`

      - `class BetaThinkingDelta`

        - `JsonValue type = "thinking_delta"`

        - `Optional<Long> estimatedTokens`

          Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative.

        - `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 BetaSignatureDelta`

        - `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.

      - `class BetaCompactionContentBlockDelta`

        - `JsonValue type = "compaction_delta"`

        - `Optional<String> content`

        - `Optional<String> encryptedContent`

          Opaque metadata from prior compaction, to be round-tripped verbatim

    - `long index`

  - `class BetaRawContentBlockStopEvent`

    - `JsonValue type = "content_block_stop"`

    - `long index`

### Beta Redacted Thinking Block

- `class BetaRedactedThinkingBlock`

  - `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.

### Beta Redacted Thinking Block Param

- `class BetaRedactedThinkingBlockParam`

  - `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.

### Beta Refusal Stop Details

- `class BetaRefusalStopDetails`

  Structured information about a refusal.

  - `JsonValue type = "refusal"`

  - `Optional<Category> 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<String> 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<String> fallbackCreditToken`

    Opaque code that refunds the cache-miss cost when retrying this refused
    request on the fallback model. Pass it as `fallback_credit_token` on the
    retry request. Expires 5 minutes after the refusal.

    The retry is sent either with the same request body (`system`, `messages`,
    `tools`, and other render-shaping fields), or with the same body plus one
    appended `assistant` message whose content is the partial text (with any
    trailing whitespace stripped from the final text block) and paired
    server-tool blocks from this refusal — which also authorizes that
    appended turn as an assistant-prefill continuation on models that otherwise
    disallow prefill. A token minted mid-server-tool-loop whose partial content
    was continuable may only be redeemed the second way — if a same-body retry
    is rejected with a 400 saying the token must be redeemed by continuing the
    partial response, retry the second way instead. Either way: same workspace,
    same platform; a mismatch is a 400. Resending a token for an already-warm
    prefix is permitted but yields no additional credit.

    `null` when the refused model isn't eligible for a fallback credit.

  - `Optional<Boolean> fallbackHasPrefillClaim`

    Whether the accompanying `fallback_credit_token` may be redeemed with the
    appended-assistant retry form. Only set when `fallback_credit_token` is
    present.

    `true`: retry by resending the same request body plus one appended
    `assistant` message whose content is this response's `content` with any
    trailing whitespace stripped from the final text block and unpaired
    `tool_use` blocks omitted (the same appended-turn shape described on
    `fallback_credit_token`), with the token attached. `false`: retry by
    resending the original request body unchanged, with the token attached —
    the appended-assistant form is not available for this refusal (no
    continuable partial content, or the request uses `output_format` or a
    `tool_choice` that forces tool use). One exception: when the request used
    `output_format` or a forced `tool_choice` and the refusal arrived after
    server tools (including MCP connector tools) had already executed, the
    token may not be redeemable by either retry form; if the exact-body retry
    is then rejected with a 400 saying the token must be redeemed by
    continuing the partial response, discard the token and retry without it.

    Advisory: if an appended-assistant retry is rejected with a 400 despite
    `true`, fall back to resending the original request body with the token.

  - `Optional<String> recommendedModel`

    The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise.

### Beta Request Document Block

- `class BetaRequestDocumentBlock`

  - `JsonValue type = "document"`

  - `Source source`

    - `class BetaBase64PdfSource`

      - `JsonValue type = "base64"`

      - `String data`

        format: byte

      - `JsonValue mediaType = "application/pdf"`

    - `class BetaPlainTextSource`

      - `JsonValue type = "text"`

      - `String data`

      - `JsonValue mediaType = "text/plain"`

    - `class BetaContentBlockSource`

      - `JsonValue type = "content"`

      - `Content content`

        - `String`

        - `List<BetaContentBlockSourceContent>`

          - `class BetaTextBlockParam`

            - `JsonValue type = "text"`

            - `String text`

              minLength: 1

            - `Optional<BetaCacheControlEphemeral> cacheControl`

              Create a cache control breakpoint at this content block.

              - `JsonValue type = "ephemeral"`

              - `Optional<Ttl> 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<List<BetaTextCitationParam>> citations`

              - `class BetaCitationCharLocationParam`

                - `JsonValue type = "char_location"`

                - `String citedText`

                - `long documentIndex`

                  minimum: 0

                - `Optional<String> documentTitle`

                  minLength: 1, maxLength: 500

                - `long endCharIndex`

                - `long startCharIndex`

                  minimum: 0

              - `class BetaCitationPageLocationParam`

                - `JsonValue type = "page_location"`

                - `String citedText`

                - `long documentIndex`

                  minimum: 0

                - `Optional<String> documentTitle`

                  minLength: 1, maxLength: 500

                - `long endPageNumber`

                - `long startPageNumber`

                  minimum: 1

              - `class BetaCitationContentBlockLocationParam`

                - `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<String> 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 BetaCitationWebSearchResultLocationParam`

                - `JsonValue type = "web_search_result_location"`

                - `String citedText`

                - `String encryptedIndex`

                - `Optional<String> title`

                  minLength: 1, maxLength: 512

                - `String url`

                  minLength: 1

              - `class BetaCitationSearchResultLocationParam`

                - `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<String> title`

          - `class BetaImageBlockParam`

            - `JsonValue type = "image"`

            - `Source source`

              - `class BetaBase64ImageSource`

                - `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 BetaUrlImageSource`

                - `JsonValue type = "url"`

                - `String url`

              - `class BetaFileImageSource`

                - `JsonValue type = "file"`

                - `String fileId`

            - `Optional<BetaCacheControlEphemeral> cacheControl`

              Create a cache control breakpoint at this content block.

            - `Optional<BetaImageTransformationsParam> 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> 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 BetaUrlPdfSource`

      - `JsonValue type = "url"`

      - `String url`

    - `class BetaFileDocumentSource`

      - `JsonValue type = "file"`

      - `String fileId`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

  - `Optional<BetaCitationsConfigParam> citations`

    - `Optional<Boolean> enabled`

  - `Optional<String> context`

    minLength: 1

  - `Optional<String> title`

    minLength: 1, maxLength: 500

### Beta Request MCP Server Tool Configuration

- `class BetaRequestMcpServerToolConfiguration`

  - `Optional<List<String>> allowedTools`

  - `Optional<Boolean> enabled`

### Beta Request MCP Server URL Definition

- `class BetaRequestMcpServerUrlDefinition`

  - `JsonValue type = "url"`

  - `String name`

  - `String url`

  - `Optional<String> authorizationToken`

  - `Optional<BetaRequestMcpServerToolConfiguration> toolConfiguration`

    - `Optional<List<String>> allowedTools`

    - `Optional<Boolean> enabled`

### Beta Request MCP Tool Result Block Param

- `class BetaRequestMcpToolResultBlockParam`

  - `JsonValue type = "mcp_tool_result"`

  - `String toolUseId`

    pattern: ^[a-zA-Z0-9_-]+$

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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> content`

    - `String`

    - `List<BetaTextBlockParam>`

      - `JsonValue type = "text"`

      - `String text`

        minLength: 1

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<List<BetaTextCitationParam>> citations`

        - `class BetaCitationCharLocationParam`

          - `JsonValue type = "char_location"`

          - `String citedText`

          - `long documentIndex`

            minimum: 0

          - `Optional<String> documentTitle`

            minLength: 1, maxLength: 500

          - `long endCharIndex`

          - `long startCharIndex`

            minimum: 0

        - `class BetaCitationPageLocationParam`

          - `JsonValue type = "page_location"`

          - `String citedText`

          - `long documentIndex`

            minimum: 0

          - `Optional<String> documentTitle`

            minLength: 1, maxLength: 500

          - `long endPageNumber`

          - `long startPageNumber`

            minimum: 1

        - `class BetaCitationContentBlockLocationParam`

          - `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<String> 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 BetaCitationWebSearchResultLocationParam`

          - `JsonValue type = "web_search_result_location"`

          - `String citedText`

          - `String encryptedIndex`

          - `Optional<String> title`

            minLength: 1, maxLength: 512

          - `String url`

            minLength: 1

        - `class BetaCitationSearchResultLocationParam`

          - `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<String> title`

  - `Optional<Boolean> isError`

### Beta Request Tool Addition Block

- `class BetaRequestToolAdditionBlock`

  Mid-conversation directive to make a tool available.

  `tool` is a reference to a tool (or MCP toolset) declared in the
  request's `tools`. Under the `inline-tools-2026-09-15` beta it may
  instead be a reference to a tool defined earlier in `messages`, or a
  `tool_definition` object that carries an inline tool definition in
  `definition` (the same object a `tools` entry holds). An `mcp_toolset`
  definition also requires the `mcp-client-2026-09-15` beta. The tool is
  offered to the model from this point in the conversation onward.

  - `JsonValue type = "tool_addition"`

  - `Tool tool`

    - `class BetaToolChangeToolReference`

      Reference to a single tool, by the name the model uses to call it: a
      tool declared in `tools` or defined by an earlier `tool_addition`
      block. Does not accept the composed `{server}_{name}` form the server
      assigns to MCP-resolved tools; use `mcp_tool_reference` or
      `mcp_toolset_reference` for those.

      - `JsonValue type = "tool_reference"`

      - `String name`

        pattern: ^[a-zA-Z0-9_-]{1,128}$

    - `class BetaToolChangeMcpToolReference`

      Reference to a single MCP tool by its server and remote name; the
      same `server_name`/`name` pair `mcp_tool_use` carries.

      - `JsonValue type = "mcp_tool_reference"`

      - `String name`

      - `String serverName`

    - `class BetaToolChangeMcpToolsetReference`

      Reference to every tool in the named MCP server's toolset.

      - `JsonValue type = "mcp_toolset_reference"`

      - `String serverName`

    - `class BetaToolChangeToolDefinitionParam`

      A tool defined by value: `definition` is a `tools` entry (any kind
      `tools` accepts, an MCP toolset included). An `mcp_toolset` given here
      also requires the `mcp-client-2026-09-15` beta.

      - `JsonValue type = "tool_definition"`

      - `BetaToolUnion definition`

        - `class BetaTool`

          - `Optional<Type> 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> properties`

            - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

            - `JsonValue type = "ephemeral"`

            - `Optional<Ttl> 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<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolBash20241022`

          - `JsonValue type = "bash_20241022"`

          - `JsonValue name = "bash"`

            Name of the tool.

            This is how the tool will be called by the model and in `tool_use` blocks.

          - `Optional<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolBash20250124`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaCodeExecutionTool20250522`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaCodeExecutionTool20250825`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaCodeExecutionTool20260120`

          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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaCodeExecutionTool20260521`

          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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaBrowserToolset20260801`

          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<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

              `type`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserCloseTabConfig> closeTab`

              `close_tab`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

              `double_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserFileUploadConfig> fileUpload`

              `file_upload`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserFindConfig> find`

              `find`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserFormInputConfig> formInput`

              `form_input`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserGetPageTextConfig> getPageText`

              `get_page_text`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserHoldKeyConfig> holdKey`

              `hold_key`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserHoverConfig> hover`

              `hover`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

              `javascript_exec`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserKeyConfig> key`

              `key`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserLeftClickConfig> leftClick`

              `left_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

              `left_click_drag`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

              `left_mouse_down`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

              `left_mouse_up`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserListTabsConfig> listTabs`

              `list_tabs`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserMiddleClickConfig> middleClick`

              `middle_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

              `mouse_move`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserNavigateConfig> navigate`

              `navigate`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserNewTabConfig> newTab`

              `new_tab`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserReadConsoleConfig> readConsole`

              `read_console`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

              `read_network`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserReadPageConfig> readPage`

              `read_page`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserRightClickConfig> rightClick`

              `right_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserScreenshotConfig> screenshot`

              `screenshot`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserScrollConfig> scroll`

              `scroll`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserScrollToConfig> scrollTo`

              `scroll_to`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserSwitchTabConfig> switchTab`

              `switch_tab`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserTripleClickConfig> tripleClick`

              `triple_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserWaitConfig> wait`

              `wait`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserZoomConfig> zoom`

              `zoom`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered 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 BetaToolComputerUse20241022`

          - `JsonValue type = "computer_20241022"`

          - `long displayHeightPx`

            The height of the display in pixels.

            minimum: 1

          - `long displayWidthPx`

            The width of the display in pixels.

            minimum: 1

          - `JsonValue name = "computer"`

            Name of the tool.

            This is how the tool will be called by the model and in `tool_use` blocks.

          - `Optional<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> displayNumber`

            The X11 display number (e.g. 0, 1) for the display.

            minimum: 0

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaMemoryTool20250818`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolComputerUse20250124`

          - `JsonValue type = "computer_20250124"`

          - `long displayHeightPx`

            The height of the display in pixels.

            minimum: 1

          - `long displayWidthPx`

            The width of the display in pixels.

            minimum: 1

          - `JsonValue name = "computer"`

            Name of the tool.

            This is how the tool will be called by the model and in `tool_use` blocks.

          - `Optional<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> displayNumber`

            The X11 display number (e.g. 0, 1) for the display.

            minimum: 0

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolTextEditor20241022`

          - `JsonValue type = "text_editor_20241022"`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolComputerUse20251124`

          - `JsonValue type = "computer_20251124"`

          - `long displayHeightPx`

            The height of the display in pixels.

            minimum: 1

          - `long displayWidthPx`

            The width of the display in pixels.

            minimum: 1

          - `JsonValue name = "computer"`

            Name of the tool.

            This is how the tool will be called by the model and in `tool_use` blocks.

          - `Optional<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> displayNumber`

            The X11 display number (e.g. 0, 1) for the display.

            minimum: 0

          - `Optional<Boolean> enableZoom`

            Whether to enable an action to take a zoomed-in screenshot of the screen.

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaComputerToolset20260801`

          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<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

              `type`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

              `cursor_position`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerDoubleClickConfig> doubleClick`

              `double_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerHoldKeyConfig> holdKey`

              `hold_key`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerKeyConfig> key`

              `key`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerLeftClickConfig> leftClick`

              `left_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

              `left_click_drag`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

              `left_mouse_down`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

              `left_mouse_up`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerMiddleClickConfig> middleClick`

              `middle_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerMouseMoveConfig> mouseMove`

              `mouse_move`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerRightClickConfig> rightClick`

              `right_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerScreenshotConfig> screenshot`

              `screenshot`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerScrollConfig> scroll`

              `scroll`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerTripleClickConfig> tripleClick`

              `triple_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerWaitConfig> wait`

              `wait`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerZoomConfig> zoom`

              `zoom`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered 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 BetaToolTextEditor20250124`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolTextEditor20250429`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolTextEditor20250728`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Long> maxCharacters`

            Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

            minimum: 1

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaWebSearchTool20250305`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<List<String>> allowedDomains`

            If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

          - `Optional<List<String>> blockedDomains`

            If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> maxUses`

            Maximum number of times the tool can be used in the API request.

            minimum: 1

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

          - `Optional<BetaUserLocation> userLocation`

            Parameters for the user's location. Used to provide more relevant search results.

            - `JsonValue type = "approximate"`

            - `Optional<String> city`

              The city of the user.

              minLength: 1, maxLength: 255

            - `Optional<String> 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<String> region`

              The region of the user.

              minLength: 1, maxLength: 255

            - `Optional<String> timezone`

              The [IANA timezone](https://nodatime.org/TimeZones) of the user.

              minLength: 1, maxLength: 255

        - `class BetaWebFetchTool20250910`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<List<String>> allowedDomains`

            List of domains to allow fetching from

          - `Optional<List<String>> blockedDomains`

            List of domains to block fetching from

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaCitationsConfigParam> citations`

            Citations configuration for fetched documents. Citations are disabled by default.

            - `Optional<Boolean> enabled`

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> 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<Long> maxUses`

            Maximum number of times the tool can be used in the API request.

            minimum: 1

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

          - `Optional<BetaWebFetchUrlSources> urlSources`

            Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

            - `Optional<ClientToolResults> clientToolResults`

              Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

              - `class BetaWebFetchUrlSourceAll`

                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 BetaWebFetchUrlSourceNone`

                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 BetaWebFetchUrlSourceOnly`

                The tool filter variant under which only the named tools' results
                contribute.

                - `JsonValue type = "only"`

                - `List<BetaWebFetchUrlSourceToolReference> tools`

                  - `JsonValue type = "tool_reference"`

                  - `String name`

              - `class BetaWebFetchUrlSourceExcept`

                The tool filter variant under which every result but the named
                tools' contributes.

                - `JsonValue type = "except"`

                - `List<BetaWebFetchUrlSourceToolReference> tools`

                  - `JsonValue type = "tool_reference"`

                  - `String name`

            - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

                The `url_sources` variant under which a source contributes in
                full: every result of the tool filter's source, or all user input.

              - `class BetaWebFetchUrlSourceNone`

                The `url_sources` variant under which a source contributes nothing:
                no result of the tool filter's source, or no user input.

              - `class BetaWebFetchUrlSourceOnly`

                The tool filter variant under which only the named tools' results
                contribute.

              - `class BetaWebFetchUrlSourceExcept`

                The tool filter variant under which every result but the named
                tools' contributes.

            - `Optional<UserInput> userInput`

              Whether URLs in user messages are fetchable: "all" or "none".

              - `class BetaWebFetchUrlSourceAll`

                The `url_sources` variant under which a source contributes in
                full: every result of the tool filter's source, or all user input.

              - `class BetaWebFetchUrlSourceNone`

                The `url_sources` variant under which a source contributes nothing:
                no result of the tool filter's source, or no user input.

        - `class BetaWebSearchTool20260209`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<List<String>> allowedDomains`

            If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

          - `Optional<List<String>> blockedDomains`

            If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> maxUses`

            Maximum number of times the tool can be used in the API request.

            minimum: 1

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

          - `Optional<BetaUserLocation> userLocation`

            Parameters for the user's location. Used to provide more relevant search results.

        - `class BetaWebFetchTool20260209`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<List<String>> allowedDomains`

            List of domains to allow fetching from

          - `Optional<List<String>> blockedDomains`

            List of domains to block fetching from

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaCitationsConfigParam> citations`

            Citations configuration for fetched documents. Citations are disabled by default.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> 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<Long> maxUses`

            Maximum number of times the tool can be used in the API request.

            minimum: 1

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

          - `Optional<BetaWebFetchUrlSources> urlSources`

            Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

        - `class BetaWebFetchTool20260309`

          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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<List<String>> allowedDomains`

            List of domains to allow fetching from

          - `Optional<List<String>> blockedDomains`

            List of domains to block fetching from

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaCitationsConfigParam> citations`

            Citations configuration for fetched documents. Citations are disabled by default.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> 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<Long> maxUses`

            Maximum number of times the tool can be used in the API request.

            minimum: 1

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

          - `Optional<BetaWebFetchUrlSources> urlSources`

            Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

          - `Optional<Boolean> 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 BetaWebSearchTool20260318`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<List<String>> allowedDomains`

            If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

          - `Optional<List<String>> blockedDomains`

            If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> maxUses`

            Maximum number of times the tool can be used in the API request.

            minimum: 1

          - `Optional<ResponseInclusion> 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<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

          - `Optional<BetaUserLocation> userLocation`

            Parameters for the user's location. Used to provide more relevant search results.

        - `class BetaWebFetchTool20260318`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<List<String>> allowedDomains`

            List of domains to allow fetching from

          - `Optional<List<String>> blockedDomains`

            List of domains to block fetching from

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaCitationsConfigParam> citations`

            Citations configuration for fetched documents. Citations are disabled by default.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> 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<Long> maxUses`

            Maximum number of times the tool can be used in the API request.

            minimum: 1

          - `Optional<ResponseInclusion> 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<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

          - `Optional<BetaWebFetchUrlSources> urlSources`

            Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

          - `Optional<Boolean> 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 BetaAdvisorTool20260301`

          - `JsonValue type = "advisor_20260301"`

          - `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 name = "advisor"`

            Name of the tool.

            This is how the tool will be called by the model and in `tool_use` blocks.

          - `Optional<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaCacheControlEphemeral> caching`

            Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> maxTokens`

            Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

            minimum: 1024

          - `Optional<Long> maxUses`

            Maximum number of times the tool can be used in the API request.

            minimum: 1

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolSearchToolRegex20251119`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaMcpToolset`

          Configuration for a group of tools from an MCP server.

          Allows configuring enabled status and defer_loading for all tools
          from an MCP server, with optional per-tool overrides.

          - `JsonValue type = "mcp_toolset"`

          - `String mcpServerName`

            Name of the MCP server to configure tools for

            minLength: 1, maxLength: 255

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Configs> configs`

            Configuration overrides for specific tools, keyed by tool name

            - `Optional<Boolean> deferLoading`

            - `Optional<Boolean> enabled`

          - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

            Default configuration applied to all tools from this server

            - `Optional<Boolean> deferLoading`

            - `Optional<Boolean> enabled`

          - `Optional<List<BetaMcpToolParam>> tools`

            The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

            - `InputSchema inputSchema`

              The tool's input schema as the MCP server lists it, verbatim.

            - `String name`

              The tool's name as the MCP server lists it (not prefixed with the server name).

              minLength: 1

            - `Optional<String> description`

              The tool's description as the MCP server lists it.

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

### Beta Request Tool Removal Block

- `class BetaRequestToolRemovalBlock`

  Mid-conversation directive to withdraw a tool.

  `tool` references a tool (or MCP toolset) by name: one declared in the
  request's `tools` or defined earlier in `messages`. It is no longer
  offered to the model from this point in the conversation onward.

  - `JsonValue type = "tool_removal"`

  - `Tool tool`

    - `class BetaToolChangeToolReference`

      Reference to a single tool, by the name the model uses to call it: a
      tool declared in `tools` or defined by an earlier `tool_addition`
      block. Does not accept the composed `{server}_{name}` form the server
      assigns to MCP-resolved tools; use `mcp_tool_reference` or
      `mcp_toolset_reference` for those.

      - `JsonValue type = "tool_reference"`

      - `String name`

        pattern: ^[a-zA-Z0-9_-]{1,128}$

    - `class BetaToolChangeMcpToolReference`

      Reference to a single MCP tool by its server and remote name; the
      same `server_name`/`name` pair `mcp_tool_use` carries.

      - `JsonValue type = "mcp_tool_reference"`

      - `String name`

      - `String serverName`

    - `class BetaToolChangeMcpToolsetReference`

      Reference to every tool in the named MCP server's toolset.

      - `JsonValue type = "mcp_toolset_reference"`

      - `String serverName`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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")`

### Beta Response Tool

- `class BetaResponseTool`

  A custom tool definition, as sent.

  - `Optional<Type> type`

  - `BetaResponseToolInputSchema 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> properties`

    - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Response Tool Addition Block

- `class BetaResponseToolAdditionBlock`

  An entry of a `compaction` block's `tool_changes`: a tool the
  compacted range made available, as a reference to a `tools` entry or
  MCP toolset, or as the tool definition in effect at the end of the
  range, by value. Send it back unchanged.

  - `JsonValue type = "tool_addition"`

  - `Tool tool`

    The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value.

    - `class BetaResponseToolChangeToolReference`

      Reference to a single tool, by the name the model uses to call it, as
      a `compaction` block's `tool_changes` entry reports it: a tool
      declared in `tools` or defined by an earlier `tool_addition` block.
      Send it back unchanged with the block.

      - `JsonValue type = "tool_reference"`

      - `String name`

    - `class BetaResponseToolChangeMcpToolReference`

      Reference to a single MCP tool, by its server and its name on that
      server, as a `compaction` block's `tool_changes` entry reports it.
      Send it back unchanged with the block.

      - `JsonValue type = "mcp_tool_reference"`

      - `String name`

      - `String serverName`

    - `class BetaResponseToolChangeMcpToolsetReference`

      Reference to every tool in the named MCP server's toolset, as a
      `compaction` block's `tool_changes` entry reports it. Send it back
      unchanged with the block.

      - `JsonValue type = "mcp_toolset_reference"`

      - `String serverName`

    - `class BetaToolChangeToolDefinition`

      A tool defined by value, as a `compaction` block's `tool_changes` entry
      reports it: `definition` is the tool's definition as it was sent, in the
      form of a `tools` entry, without `cache_control`. Send it back unchanged
      with the block.

      - `JsonValue type = "tool_definition"`

      - `BetaResponseToolUnion definition`

        - `class BetaResponseTool`

          A custom tool definition, as sent.

          - `Optional<Type> type`

          - `BetaResponseToolInputSchema 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> properties`

            - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolBash20241022`

          - `JsonValue type = "bash_20241022"`

          - `JsonValue name = "bash"`

            Name of the tool.

            This is how the tool will be called by the model and in `tool_use` blocks.

          - `Optional<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

            - `JsonValue type = "ephemeral"`

            - `Optional<Ttl> 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<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolBash20250124`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaCodeExecutionTool20250522`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaCodeExecutionTool20250825`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaCodeExecutionTool20260120`

          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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaCodeExecutionTool20260521`

          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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaBrowserToolset20260801`

          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<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

              `type`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserCloseTabConfig> closeTab`

              `close_tab`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

              `double_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserFileUploadConfig> fileUpload`

              `file_upload`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserFindConfig> find`

              `find`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserFormInputConfig> formInput`

              `form_input`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserGetPageTextConfig> getPageText`

              `get_page_text`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserHoldKeyConfig> holdKey`

              `hold_key`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserHoverConfig> hover`

              `hover`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

              `javascript_exec`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserKeyConfig> key`

              `key`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserLeftClickConfig> leftClick`

              `left_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

              `left_click_drag`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

              `left_mouse_down`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

              `left_mouse_up`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserListTabsConfig> listTabs`

              `list_tabs`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserMiddleClickConfig> middleClick`

              `middle_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

              `mouse_move`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserNavigateConfig> navigate`

              `navigate`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserNewTabConfig> newTab`

              `new_tab`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserReadConsoleConfig> readConsole`

              `read_console`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

              `read_network`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserReadPageConfig> readPage`

              `read_page`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserRightClickConfig> rightClick`

              `right_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserScreenshotConfig> screenshot`

              `screenshot`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserScrollConfig> scroll`

              `scroll`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserScrollToConfig> scrollTo`

              `scroll_to`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserSwitchTabConfig> switchTab`

              `switch_tab`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserTripleClickConfig> tripleClick`

              `triple_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserWaitConfig> wait`

              `wait`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaBrowserZoomConfig> zoom`

              `zoom`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered 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 BetaToolComputerUse20241022`

          - `JsonValue type = "computer_20241022"`

          - `long displayHeightPx`

            The height of the display in pixels.

            minimum: 1

          - `long displayWidthPx`

            The width of the display in pixels.

            minimum: 1

          - `JsonValue name = "computer"`

            Name of the tool.

            This is how the tool will be called by the model and in `tool_use` blocks.

          - `Optional<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> displayNumber`

            The X11 display number (e.g. 0, 1) for the display.

            minimum: 0

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaMemoryTool20250818`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolComputerUse20250124`

          - `JsonValue type = "computer_20250124"`

          - `long displayHeightPx`

            The height of the display in pixels.

            minimum: 1

          - `long displayWidthPx`

            The width of the display in pixels.

            minimum: 1

          - `JsonValue name = "computer"`

            Name of the tool.

            This is how the tool will be called by the model and in `tool_use` blocks.

          - `Optional<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> displayNumber`

            The X11 display number (e.g. 0, 1) for the display.

            minimum: 0

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolTextEditor20241022`

          - `JsonValue type = "text_editor_20241022"`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolComputerUse20251124`

          - `JsonValue type = "computer_20251124"`

          - `long displayHeightPx`

            The height of the display in pixels.

            minimum: 1

          - `long displayWidthPx`

            The width of the display in pixels.

            minimum: 1

          - `JsonValue name = "computer"`

            Name of the tool.

            This is how the tool will be called by the model and in `tool_use` blocks.

          - `Optional<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> displayNumber`

            The X11 display number (e.g. 0, 1) for the display.

            minimum: 0

          - `Optional<Boolean> enableZoom`

            Whether to enable an action to take a zoomed-in screenshot of the screen.

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaComputerToolset20260801`

          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<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

              `type`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

              `cursor_position`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerDoubleClickConfig> doubleClick`

              `double_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerHoldKeyConfig> holdKey`

              `hold_key`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerKeyConfig> key`

              `key`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerLeftClickConfig> leftClick`

              `left_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

              `left_click_drag`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

              `left_mouse_down`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

              `left_mouse_up`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerMiddleClickConfig> middleClick`

              `middle_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerMouseMoveConfig> mouseMove`

              `mouse_move`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerRightClickConfig> rightClick`

              `right_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerScreenshotConfig> screenshot`

              `screenshot`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerScrollConfig> scroll`

              `scroll`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerTripleClickConfig> tripleClick`

              `triple_click`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerWaitConfig> wait`

              `wait`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

            - `Optional<BetaComputerZoomConfig> zoom`

              `zoom`'s config overrides.

              - `Optional<Boolean> deferLoading`

                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

              - `Optional<Boolean> enabled`

                Whether this member is offered 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 BetaToolTextEditor20250124`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolTextEditor20250429`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolTextEditor20250728`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<List<InputExample>> inputExamples`

          - `Optional<Long> maxCharacters`

            Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

            minimum: 1

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaWebSearchTool20250305`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<List<String>> allowedDomains`

            If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

          - `Optional<List<String>> blockedDomains`

            If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> maxUses`

            Maximum number of times the tool can be used in the API request.

            minimum: 1

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

          - `Optional<BetaUserLocation> userLocation`

            Parameters for the user's location. Used to provide more relevant search results.

            - `JsonValue type = "approximate"`

            - `Optional<String> city`

              The city of the user.

              minLength: 1, maxLength: 255

            - `Optional<String> 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<String> region`

              The region of the user.

              minLength: 1, maxLength: 255

            - `Optional<String> timezone`

              The [IANA timezone](https://nodatime.org/TimeZones) of the user.

              minLength: 1, maxLength: 255

        - `class BetaWebFetchTool20250910`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<List<String>> allowedDomains`

            List of domains to allow fetching from

          - `Optional<List<String>> blockedDomains`

            List of domains to block fetching from

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaCitationsConfigParam> citations`

            Citations configuration for fetched documents. Citations are disabled by default.

            - `Optional<Boolean> enabled`

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> 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<Long> maxUses`

            Maximum number of times the tool can be used in the API request.

            minimum: 1

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

          - `Optional<BetaWebFetchUrlSources> urlSources`

            Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

            - `Optional<ClientToolResults> clientToolResults`

              Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

              - `class BetaWebFetchUrlSourceAll`

                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 BetaWebFetchUrlSourceNone`

                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 BetaWebFetchUrlSourceOnly`

                The tool filter variant under which only the named tools' results
                contribute.

                - `JsonValue type = "only"`

                - `List<BetaWebFetchUrlSourceToolReference> tools`

                  - `JsonValue type = "tool_reference"`

                  - `String name`

              - `class BetaWebFetchUrlSourceExcept`

                The tool filter variant under which every result but the named
                tools' contributes.

                - `JsonValue type = "except"`

                - `List<BetaWebFetchUrlSourceToolReference> tools`

                  - `JsonValue type = "tool_reference"`

                  - `String name`

            - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

                The `url_sources` variant under which a source contributes in
                full: every result of the tool filter's source, or all user input.

              - `class BetaWebFetchUrlSourceNone`

                The `url_sources` variant under which a source contributes nothing:
                no result of the tool filter's source, or no user input.

              - `class BetaWebFetchUrlSourceOnly`

                The tool filter variant under which only the named tools' results
                contribute.

              - `class BetaWebFetchUrlSourceExcept`

                The tool filter variant under which every result but the named
                tools' contributes.

            - `Optional<UserInput> userInput`

              Whether URLs in user messages are fetchable: "all" or "none".

              - `class BetaWebFetchUrlSourceAll`

                The `url_sources` variant under which a source contributes in
                full: every result of the tool filter's source, or all user input.

              - `class BetaWebFetchUrlSourceNone`

                The `url_sources` variant under which a source contributes nothing:
                no result of the tool filter's source, or no user input.

        - `class BetaWebSearchTool20260209`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<List<String>> allowedDomains`

            If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

          - `Optional<List<String>> blockedDomains`

            If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> maxUses`

            Maximum number of times the tool can be used in the API request.

            minimum: 1

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

          - `Optional<BetaUserLocation> userLocation`

            Parameters for the user's location. Used to provide more relevant search results.

        - `class BetaWebFetchTool20260209`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<List<String>> allowedDomains`

            List of domains to allow fetching from

          - `Optional<List<String>> blockedDomains`

            List of domains to block fetching from

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaCitationsConfigParam> citations`

            Citations configuration for fetched documents. Citations are disabled by default.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> 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<Long> maxUses`

            Maximum number of times the tool can be used in the API request.

            minimum: 1

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

          - `Optional<BetaWebFetchUrlSources> urlSources`

            Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

        - `class BetaWebFetchTool20260309`

          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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<List<String>> allowedDomains`

            List of domains to allow fetching from

          - `Optional<List<String>> blockedDomains`

            List of domains to block fetching from

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaCitationsConfigParam> citations`

            Citations configuration for fetched documents. Citations are disabled by default.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> 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<Long> maxUses`

            Maximum number of times the tool can be used in the API request.

            minimum: 1

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

          - `Optional<BetaWebFetchUrlSources> urlSources`

            Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

          - `Optional<Boolean> 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 BetaWebSearchTool20260318`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<List<String>> allowedDomains`

            If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

          - `Optional<List<String>> blockedDomains`

            If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> maxUses`

            Maximum number of times the tool can be used in the API request.

            minimum: 1

          - `Optional<ResponseInclusion> 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<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

          - `Optional<BetaUserLocation> userLocation`

            Parameters for the user's location. Used to provide more relevant search results.

        - `class BetaWebFetchTool20260318`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<List<String>> allowedDomains`

            List of domains to allow fetching from

          - `Optional<List<String>> blockedDomains`

            List of domains to block fetching from

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaCitationsConfigParam> citations`

            Citations configuration for fetched documents. Citations are disabled by default.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> 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<Long> maxUses`

            Maximum number of times the tool can be used in the API request.

            minimum: 1

          - `Optional<ResponseInclusion> 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<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

          - `Optional<BetaWebFetchUrlSources> urlSources`

            Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

          - `Optional<Boolean> 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 BetaAdvisorTool20260301`

          - `JsonValue type = "advisor_20260301"`

          - `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 name = "advisor"`

            Name of the tool.

            This is how the tool will be called by the model and in `tool_use` blocks.

          - `Optional<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<BetaCacheControlEphemeral> caching`

            Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Long> maxTokens`

            Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

            minimum: 1024

          - `Optional<Long> maxUses`

            Maximum number of times the tool can be used in the API request.

            minimum: 1

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaToolSearchToolRegex20251119`

          - `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<List<AllowedCaller>> allowedCallers`

            - `DIRECT("direct")`

            - `CODE_EXECUTION_20250825("code_execution_20250825")`

            - `CODE_EXECUTION_20260120("code_execution_20260120")`

            - `CODE_EXECUTION_20260521("code_execution_20260521")`

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Boolean> deferLoading`

            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

          - `Optional<Boolean> strict`

            When true, guarantees schema validation on tool names and inputs

        - `class BetaMcpToolset`

          Configuration for a group of tools from an MCP server.

          Allows configuring enabled status and defer_loading for all tools
          from an MCP server, with optional per-tool overrides.

          - `JsonValue type = "mcp_toolset"`

          - `String mcpServerName`

            Name of the MCP server to configure tools for

            minLength: 1, maxLength: 255

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<Configs> configs`

            Configuration overrides for specific tools, keyed by tool name

            - `Optional<Boolean> deferLoading`

            - `Optional<Boolean> enabled`

          - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

            Default configuration applied to all tools from this server

            - `Optional<Boolean> deferLoading`

            - `Optional<Boolean> enabled`

          - `Optional<List<BetaMcpToolParam>> tools`

            The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

            - `InputSchema inputSchema`

              The tool's input schema as the MCP server lists it, verbatim.

            - `String name`

              The tool's name as the MCP server lists it (not prefixed with the server name).

              minLength: 1

            - `Optional<String> description`

              The tool's description as the MCP server lists it.

### Beta Response Tool Change MCP Tool Reference

- `class BetaResponseToolChangeMcpToolReference`

  Reference to a single MCP tool, by its server and its name on that
  server, as a `compaction` block's `tool_changes` entry reports it.
  Send it back unchanged with the block.

  - `JsonValue type = "mcp_tool_reference"`

  - `String name`

  - `String serverName`

### Beta Response Tool Change MCP Toolset Reference

- `class BetaResponseToolChangeMcpToolsetReference`

  Reference to every tool in the named MCP server's toolset, as a
  `compaction` block's `tool_changes` entry reports it. Send it back
  unchanged with the block.

  - `JsonValue type = "mcp_toolset_reference"`

  - `String serverName`

### Beta Response Tool Change Tool Reference

- `class BetaResponseToolChangeToolReference`

  Reference to a single tool, by the name the model uses to call it, as
  a `compaction` block's `tool_changes` entry reports it: a tool
  declared in `tools` or defined by an earlier `tool_addition` block.
  Send it back unchanged with the block.

  - `JsonValue type = "tool_reference"`

  - `String name`

### Beta Response Tool Input Schema

- `class BetaResponseToolInputSchema`

  [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> properties`

  - `Optional<List<String>> required`

### Beta Response Tool Removal Block

- `class BetaResponseToolRemovalBlock`

  An entry of a `compaction` block's `tool_changes`: a tool of the
  request's `tools` (or an MCP tool or toolset) that the compacted range
  withdrew. Send it back unchanged.

  - `JsonValue type = "tool_removal"`

  - `Tool tool`

    A reference to the withdrawn `tools` entry, MCP tool or MCP toolset.

    - `class BetaResponseToolChangeToolReference`

      Reference to a single tool, by the name the model uses to call it, as
      a `compaction` block's `tool_changes` entry reports it: a tool
      declared in `tools` or defined by an earlier `tool_addition` block.
      Send it back unchanged with the block.

      - `JsonValue type = "tool_reference"`

      - `String name`

    - `class BetaResponseToolChangeMcpToolReference`

      Reference to a single MCP tool, by its server and its name on that
      server, as a `compaction` block's `tool_changes` entry reports it.
      Send it back unchanged with the block.

      - `JsonValue type = "mcp_tool_reference"`

      - `String name`

      - `String serverName`

    - `class BetaResponseToolChangeMcpToolsetReference`

      Reference to every tool in the named MCP server's toolset, as a
      `compaction` block's `tool_changes` entry reports it. Send it back
      unchanged with the block.

      - `JsonValue type = "mcp_toolset_reference"`

      - `String serverName`

### Beta Response Tool Union

- `class BetaResponseToolUnion: union`

  - `class BetaResponseTool`

    A custom tool definition, as sent.

    - `Optional<Type> type`

    - `BetaResponseToolInputSchema 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> properties`

      - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolBash20241022`

    - `JsonValue type = "bash_20241022"`

    - `JsonValue name = "bash"`

      Name of the tool.

      This is how the tool will be called by the model and in `tool_use` blocks.

    - `Optional<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

      - `JsonValue type = "ephemeral"`

      - `Optional<Ttl> 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<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolBash20250124`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaCodeExecutionTool20250522`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaCodeExecutionTool20250825`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaCodeExecutionTool20260120`

    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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaCodeExecutionTool20260521`

    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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaBrowserToolset20260801`

    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<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

        `type`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserCloseTabConfig> closeTab`

        `close_tab`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

        `double_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserFileUploadConfig> fileUpload`

        `file_upload`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserFindConfig> find`

        `find`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserFormInputConfig> formInput`

        `form_input`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserGetPageTextConfig> getPageText`

        `get_page_text`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserHoldKeyConfig> holdKey`

        `hold_key`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserHoverConfig> hover`

        `hover`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

        `javascript_exec`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserKeyConfig> key`

        `key`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserLeftClickConfig> leftClick`

        `left_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

        `left_click_drag`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

        `left_mouse_down`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

        `left_mouse_up`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserListTabsConfig> listTabs`

        `list_tabs`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserMiddleClickConfig> middleClick`

        `middle_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

        `mouse_move`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserNavigateConfig> navigate`

        `navigate`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserNewTabConfig> newTab`

        `new_tab`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserReadConsoleConfig> readConsole`

        `read_console`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

        `read_network`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserReadPageConfig> readPage`

        `read_page`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserRightClickConfig> rightClick`

        `right_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserScreenshotConfig> screenshot`

        `screenshot`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserScrollConfig> scroll`

        `scroll`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserScrollToConfig> scrollTo`

        `scroll_to`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserSwitchTabConfig> switchTab`

        `switch_tab`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserTripleClickConfig> tripleClick`

        `triple_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserWaitConfig> wait`

        `wait`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserZoomConfig> zoom`

        `zoom`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered 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 BetaToolComputerUse20241022`

    - `JsonValue type = "computer_20241022"`

    - `long displayHeightPx`

      The height of the display in pixels.

      minimum: 1

    - `long displayWidthPx`

      The width of the display in pixels.

      minimum: 1

    - `JsonValue name = "computer"`

      Name of the tool.

      This is how the tool will be called by the model and in `tool_use` blocks.

    - `Optional<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> displayNumber`

      The X11 display number (e.g. 0, 1) for the display.

      minimum: 0

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaMemoryTool20250818`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolComputerUse20250124`

    - `JsonValue type = "computer_20250124"`

    - `long displayHeightPx`

      The height of the display in pixels.

      minimum: 1

    - `long displayWidthPx`

      The width of the display in pixels.

      minimum: 1

    - `JsonValue name = "computer"`

      Name of the tool.

      This is how the tool will be called by the model and in `tool_use` blocks.

    - `Optional<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> displayNumber`

      The X11 display number (e.g. 0, 1) for the display.

      minimum: 0

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolTextEditor20241022`

    - `JsonValue type = "text_editor_20241022"`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolComputerUse20251124`

    - `JsonValue type = "computer_20251124"`

    - `long displayHeightPx`

      The height of the display in pixels.

      minimum: 1

    - `long displayWidthPx`

      The width of the display in pixels.

      minimum: 1

    - `JsonValue name = "computer"`

      Name of the tool.

      This is how the tool will be called by the model and in `tool_use` blocks.

    - `Optional<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> displayNumber`

      The X11 display number (e.g. 0, 1) for the display.

      minimum: 0

    - `Optional<Boolean> enableZoom`

      Whether to enable an action to take a zoomed-in screenshot of the screen.

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaComputerToolset20260801`

    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<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

        `type`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

        `cursor_position`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerDoubleClickConfig> doubleClick`

        `double_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerHoldKeyConfig> holdKey`

        `hold_key`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerKeyConfig> key`

        `key`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerLeftClickConfig> leftClick`

        `left_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

        `left_click_drag`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

        `left_mouse_down`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

        `left_mouse_up`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerMiddleClickConfig> middleClick`

        `middle_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerMouseMoveConfig> mouseMove`

        `mouse_move`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerRightClickConfig> rightClick`

        `right_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerScreenshotConfig> screenshot`

        `screenshot`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerScrollConfig> scroll`

        `scroll`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerTripleClickConfig> tripleClick`

        `triple_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerWaitConfig> wait`

        `wait`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerZoomConfig> zoom`

        `zoom`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered 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 BetaToolTextEditor20250124`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolTextEditor20250429`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolTextEditor20250728`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Long> maxCharacters`

      Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

      minimum: 1

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaWebSearchTool20250305`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<List<String>> allowedDomains`

      If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

    - `Optional<List<String>> blockedDomains`

      If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> maxUses`

      Maximum number of times the tool can be used in the API request.

      minimum: 1

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

    - `Optional<BetaUserLocation> userLocation`

      Parameters for the user's location. Used to provide more relevant search results.

      - `JsonValue type = "approximate"`

      - `Optional<String> city`

        The city of the user.

        minLength: 1, maxLength: 255

      - `Optional<String> 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<String> region`

        The region of the user.

        minLength: 1, maxLength: 255

      - `Optional<String> timezone`

        The [IANA timezone](https://nodatime.org/TimeZones) of the user.

        minLength: 1, maxLength: 255

  - `class BetaWebFetchTool20250910`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<List<String>> allowedDomains`

      List of domains to allow fetching from

    - `Optional<List<String>> blockedDomains`

      List of domains to block fetching from

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaCitationsConfigParam> citations`

      Citations configuration for fetched documents. Citations are disabled by default.

      - `Optional<Boolean> enabled`

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> 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<Long> maxUses`

      Maximum number of times the tool can be used in the API request.

      minimum: 1

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

    - `Optional<BetaWebFetchUrlSources> urlSources`

      Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

      - `Optional<ClientToolResults> clientToolResults`

        Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

        - `class BetaWebFetchUrlSourceAll`

          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 BetaWebFetchUrlSourceNone`

          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 BetaWebFetchUrlSourceOnly`

          The tool filter variant under which only the named tools' results
          contribute.

          - `JsonValue type = "only"`

          - `List<BetaWebFetchUrlSourceToolReference> tools`

            - `JsonValue type = "tool_reference"`

            - `String name`

        - `class BetaWebFetchUrlSourceExcept`

          The tool filter variant under which every result but the named
          tools' contributes.

          - `JsonValue type = "except"`

          - `List<BetaWebFetchUrlSourceToolReference> tools`

            - `JsonValue type = "tool_reference"`

            - `String name`

      - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

          The `url_sources` variant under which a source contributes in
          full: every result of the tool filter's source, or all user input.

        - `class BetaWebFetchUrlSourceNone`

          The `url_sources` variant under which a source contributes nothing:
          no result of the tool filter's source, or no user input.

        - `class BetaWebFetchUrlSourceOnly`

          The tool filter variant under which only the named tools' results
          contribute.

        - `class BetaWebFetchUrlSourceExcept`

          The tool filter variant under which every result but the named
          tools' contributes.

      - `Optional<UserInput> userInput`

        Whether URLs in user messages are fetchable: "all" or "none".

        - `class BetaWebFetchUrlSourceAll`

          The `url_sources` variant under which a source contributes in
          full: every result of the tool filter's source, or all user input.

        - `class BetaWebFetchUrlSourceNone`

          The `url_sources` variant under which a source contributes nothing:
          no result of the tool filter's source, or no user input.

  - `class BetaWebSearchTool20260209`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<List<String>> allowedDomains`

      If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

    - `Optional<List<String>> blockedDomains`

      If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> maxUses`

      Maximum number of times the tool can be used in the API request.

      minimum: 1

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

    - `Optional<BetaUserLocation> userLocation`

      Parameters for the user's location. Used to provide more relevant search results.

  - `class BetaWebFetchTool20260209`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<List<String>> allowedDomains`

      List of domains to allow fetching from

    - `Optional<List<String>> blockedDomains`

      List of domains to block fetching from

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaCitationsConfigParam> citations`

      Citations configuration for fetched documents. Citations are disabled by default.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> 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<Long> maxUses`

      Maximum number of times the tool can be used in the API request.

      minimum: 1

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

    - `Optional<BetaWebFetchUrlSources> urlSources`

      Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

  - `class BetaWebFetchTool20260309`

    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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<List<String>> allowedDomains`

      List of domains to allow fetching from

    - `Optional<List<String>> blockedDomains`

      List of domains to block fetching from

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaCitationsConfigParam> citations`

      Citations configuration for fetched documents. Citations are disabled by default.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> 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<Long> maxUses`

      Maximum number of times the tool can be used in the API request.

      minimum: 1

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

    - `Optional<BetaWebFetchUrlSources> urlSources`

      Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

    - `Optional<Boolean> 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 BetaWebSearchTool20260318`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<List<String>> allowedDomains`

      If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

    - `Optional<List<String>> blockedDomains`

      If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> maxUses`

      Maximum number of times the tool can be used in the API request.

      minimum: 1

    - `Optional<ResponseInclusion> 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<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

    - `Optional<BetaUserLocation> userLocation`

      Parameters for the user's location. Used to provide more relevant search results.

  - `class BetaWebFetchTool20260318`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<List<String>> allowedDomains`

      List of domains to allow fetching from

    - `Optional<List<String>> blockedDomains`

      List of domains to block fetching from

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaCitationsConfigParam> citations`

      Citations configuration for fetched documents. Citations are disabled by default.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> 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<Long> maxUses`

      Maximum number of times the tool can be used in the API request.

      minimum: 1

    - `Optional<ResponseInclusion> 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<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

    - `Optional<BetaWebFetchUrlSources> urlSources`

      Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

    - `Optional<Boolean> 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 BetaAdvisorTool20260301`

    - `JsonValue type = "advisor_20260301"`

    - `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 name = "advisor"`

      Name of the tool.

      This is how the tool will be called by the model and in `tool_use` blocks.

    - `Optional<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaCacheControlEphemeral> caching`

      Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> maxTokens`

      Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

      minimum: 1024

    - `Optional<Long> maxUses`

      Maximum number of times the tool can be used in the API request.

      minimum: 1

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolSearchToolRegex20251119`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaMcpToolset`

    Configuration for a group of tools from an MCP server.

    Allows configuring enabled status and defer_loading for all tools
    from an MCP server, with optional per-tool overrides.

    - `JsonValue type = "mcp_toolset"`

    - `String mcpServerName`

      Name of the MCP server to configure tools for

      minLength: 1, maxLength: 255

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Configs> configs`

      Configuration overrides for specific tools, keyed by tool name

      - `Optional<Boolean> deferLoading`

      - `Optional<Boolean> enabled`

    - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

      Default configuration applied to all tools from this server

      - `Optional<Boolean> deferLoading`

      - `Optional<Boolean> enabled`

    - `Optional<List<BetaMcpToolParam>> tools`

      The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

      - `InputSchema inputSchema`

        The tool's input schema as the MCP server lists it, verbatim.

      - `String name`

        The tool's name as the MCP server lists it (not prefixed with the server name).

        minLength: 1

      - `Optional<String> description`

        The tool's description as the MCP server lists it.

### Beta Search Result Block Param

- `class BetaSearchResultBlockParam`

  - `JsonValue type = "search_result"`

  - `List<BetaTextBlockParam> content`

    - `JsonValue type = "text"`

    - `String text`

      minLength: 1

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

      - `JsonValue type = "ephemeral"`

      - `Optional<Ttl> 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<List<BetaTextCitationParam>> citations`

      - `class BetaCitationCharLocationParam`

        - `JsonValue type = "char_location"`

        - `String citedText`

        - `long documentIndex`

          minimum: 0

        - `Optional<String> documentTitle`

          minLength: 1, maxLength: 500

        - `long endCharIndex`

        - `long startCharIndex`

          minimum: 0

      - `class BetaCitationPageLocationParam`

        - `JsonValue type = "page_location"`

        - `String citedText`

        - `long documentIndex`

          minimum: 0

        - `Optional<String> documentTitle`

          minLength: 1, maxLength: 500

        - `long endPageNumber`

        - `long startPageNumber`

          minimum: 1

      - `class BetaCitationContentBlockLocationParam`

        - `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<String> 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 BetaCitationWebSearchResultLocationParam`

        - `JsonValue type = "web_search_result_location"`

        - `String citedText`

        - `String encryptedIndex`

        - `Optional<String> title`

          minLength: 1, maxLength: 512

        - `String url`

          minLength: 1

      - `class BetaCitationSearchResultLocationParam`

        - `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<String> title`

  - `String source`

  - `String title`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

  - `Optional<BetaCitationsConfigParam> citations`

    - `Optional<Boolean> enabled`

### Beta Server Tool Caller

- `class BetaServerToolCaller`

  Tool invocation generated by a server-side tool.

  - `JsonValue type = "code_execution_20250825"`

  - `String toolId`

    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Server Tool Caller 20260120

- `class BetaServerToolCaller20260120`

  - `JsonValue type = "code_execution_20260120"`

  - `String toolId`

    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Server Tool Usage

- `class BetaServerToolUsage`

  - `long webFetchRequests`

    The number of web fetch tool requests.

    minimum: 0

  - `long webSearchRequests`

    The number of web search tool requests.

    minimum: 0

### Beta Server Tool Use Block

- `class BetaServerToolUseBlock`

  - `JsonValue type = "server_tool_use"`

  - `String id`

    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `Input input`

  - `Name name`

    - `ADVISOR("advisor")`

    - `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<Caller> caller`

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Server Tool Use Block Param

- `class BetaServerToolUseBlockParam`

  - `JsonValue type = "server_tool_use"`

  - `String id`

    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `Input input`

  - `Name name`

    - `ADVISOR("advisor")`

    - `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<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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> caller`

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Signature Delta

- `class BetaSignatureDelta`

  - `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.

### Beta Skill Params

- `class BetaSkillParams`

  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<String> version`

    Skill version or 'latest' for most recent version

    minLength: 1, maxLength: 64

### Beta Stop Reason

- `enum BetaStopReason`

  - `END_TURN("end_turn")`

  - `MAX_TOKENS("max_tokens")`

  - `STOP_SEQUENCE("stop_sequence")`

  - `TOOL_USE("tool_use")`

  - `PAUSE_TURN("pause_turn")`

  - `COMPACTION("compaction")`

  - `REFUSAL("refusal")`

  - `MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")`

### Beta Summarize Compaction

- `class BetaSummarizeCompaction`

  Compact the whole conversation and return a signed `compaction` block,
  alone, that a later request sends back first in `messages`, in place of
  the messages it summarizes. There is no trigger and no pause flag: sending
  the parameter compacts, and nothing is sampled after the block.

  The summarization prompt is the server's own unless `instructions` are
  given, which then replace it for this request; a value that is empty or
  only whitespace counts as absent.

  - `JsonValue type = "summarize"`

  - `Optional<String> instructions`

    Replaces the server's default summarization prompt for this request. An empty or whitespace-only value counts as absent.

    maxLength: 16384

### Beta System Message Output Config

- `class BetaSystemMessageOutputConfig`

  Per-message output configuration on a role:"system" input message.

  Fields here apply per-turn; `format` remains top-level only. An
  empty `{}` is accepted on a message that carries content; a message
  with neither content nor output_config fields is rejected.

  - `Optional<Effort> 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")`

### Beta Text Block

- `class BetaTextBlock`

  - `JsonValue type = "text"`

  - `Optional<List<BetaTextCitation>> 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 BetaCitationCharLocation`

      - `JsonValue type = "char_location"`

      - `String citedText`

      - `long documentIndex`

        minimum: 0

      - `Optional<String> documentTitle`

      - `long endCharIndex`

      - `Optional<String> fileId`

      - `long startCharIndex`

        minimum: 0

    - `class BetaCitationPageLocation`

      - `JsonValue type = "page_location"`

      - `String citedText`

      - `long documentIndex`

        minimum: 0

      - `Optional<String> documentTitle`

      - `long endPageNumber`

      - `Optional<String> fileId`

      - `long startPageNumber`

        minimum: 1

    - `class BetaCitationContentBlockLocation`

      - `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<String> 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<String> fileId`

      - `long startBlockIndex`

        0-based index of the first cited block in the source's `content` array.

        minimum: 0

    - `class BetaCitationsWebSearchResultLocation`

      - `JsonValue type = "web_search_result_location"`

      - `String citedText`

      - `String encryptedIndex`

      - `Optional<String> title`

        maxLength: 512

      - `String url`

    - `class BetaCitationSearchResultLocation`

      - `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<String> title`

  - `String text`

### Beta Text Block Param

- `class BetaTextBlockParam`

  - `JsonValue type = "text"`

  - `String text`

    minLength: 1

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<List<BetaTextCitationParam>> citations`

    - `class BetaCitationCharLocationParam`

      - `JsonValue type = "char_location"`

      - `String citedText`

      - `long documentIndex`

        minimum: 0

      - `Optional<String> documentTitle`

        minLength: 1, maxLength: 500

      - `long endCharIndex`

      - `long startCharIndex`

        minimum: 0

    - `class BetaCitationPageLocationParam`

      - `JsonValue type = "page_location"`

      - `String citedText`

      - `long documentIndex`

        minimum: 0

      - `Optional<String> documentTitle`

        minLength: 1, maxLength: 500

      - `long endPageNumber`

      - `long startPageNumber`

        minimum: 1

    - `class BetaCitationContentBlockLocationParam`

      - `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<String> 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 BetaCitationWebSearchResultLocationParam`

      - `JsonValue type = "web_search_result_location"`

      - `String citedText`

      - `String encryptedIndex`

      - `Optional<String> title`

        minLength: 1, maxLength: 512

      - `String url`

        minLength: 1

    - `class BetaCitationSearchResultLocationParam`

      - `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<String> title`

### Beta Text Citation

- `class BetaTextCitation: union`

  - `class BetaCitationCharLocation`

    - `JsonValue type = "char_location"`

    - `String citedText`

    - `long documentIndex`

      minimum: 0

    - `Optional<String> documentTitle`

    - `long endCharIndex`

    - `Optional<String> fileId`

    - `long startCharIndex`

      minimum: 0

  - `class BetaCitationPageLocation`

    - `JsonValue type = "page_location"`

    - `String citedText`

    - `long documentIndex`

      minimum: 0

    - `Optional<String> documentTitle`

    - `long endPageNumber`

    - `Optional<String> fileId`

    - `long startPageNumber`

      minimum: 1

  - `class BetaCitationContentBlockLocation`

    - `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<String> 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<String> fileId`

    - `long startBlockIndex`

      0-based index of the first cited block in the source's `content` array.

      minimum: 0

  - `class BetaCitationsWebSearchResultLocation`

    - `JsonValue type = "web_search_result_location"`

    - `String citedText`

    - `String encryptedIndex`

    - `Optional<String> title`

      maxLength: 512

    - `String url`

  - `class BetaCitationSearchResultLocation`

    - `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<String> title`

### Beta Text Citation Param

- `class BetaTextCitationParam: union`

  - `class BetaCitationCharLocationParam`

    - `JsonValue type = "char_location"`

    - `String citedText`

    - `long documentIndex`

      minimum: 0

    - `Optional<String> documentTitle`

      minLength: 1, maxLength: 500

    - `long endCharIndex`

    - `long startCharIndex`

      minimum: 0

  - `class BetaCitationPageLocationParam`

    - `JsonValue type = "page_location"`

    - `String citedText`

    - `long documentIndex`

      minimum: 0

    - `Optional<String> documentTitle`

      minLength: 1, maxLength: 500

    - `long endPageNumber`

    - `long startPageNumber`

      minimum: 1

  - `class BetaCitationContentBlockLocationParam`

    - `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<String> 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 BetaCitationWebSearchResultLocationParam`

    - `JsonValue type = "web_search_result_location"`

    - `String citedText`

    - `String encryptedIndex`

    - `Optional<String> title`

      minLength: 1, maxLength: 512

    - `String url`

      minLength: 1

  - `class BetaCitationSearchResultLocationParam`

    - `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<String> title`

### Beta Text Delta

- `class BetaTextDelta`

  - `JsonValue type = "text_delta"`

  - `String text`

### Beta Text Editor Code Execution Create Result Block

- `class BetaTextEditorCodeExecutionCreateResultBlock`

  - `JsonValue type = "text_editor_code_execution_create_result"`

  - `boolean isFileUpdate`

### Beta Text Editor Code Execution Create Result Block Param

- `class BetaTextEditorCodeExecutionCreateResultBlockParam`

  - `JsonValue type = "text_editor_code_execution_create_result"`

  - `boolean isFileUpdate`

### Beta Text Editor Code Execution Str Replace Result Block

- `class BetaTextEditorCodeExecutionStrReplaceResultBlock`

  - `JsonValue type = "text_editor_code_execution_str_replace_result"`

  - `Optional<List<String>> lines`

  - `Optional<Long> newLines`

  - `Optional<Long> newStart`

  - `Optional<Long> oldLines`

  - `Optional<Long> oldStart`

### Beta Text Editor Code Execution Str Replace Result Block Param

- `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam`

  - `JsonValue type = "text_editor_code_execution_str_replace_result"`

  - `Optional<List<String>> lines`

  - `Optional<Long> newLines`

  - `Optional<Long> newStart`

  - `Optional<Long> oldLines`

  - `Optional<Long> oldStart`

### Beta Text Editor Code Execution Tool Result Block

- `class BetaTextEditorCodeExecutionToolResultBlock`

  - `JsonValue type = "text_editor_code_execution_tool_result"`

  - `Content content`

    - `class BetaTextEditorCodeExecutionToolResultError`

      - `JsonValue type = "text_editor_code_execution_tool_result_error"`

      - `ErrorCode 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<String> errorMessage`

    - `class BetaTextEditorCodeExecutionViewResultBlock`

      - `JsonValue type = "text_editor_code_execution_view_result"`

      - `String content`

      - `FileType fileType`

        - `TEXT("text")`

        - `IMAGE("image")`

        - `PDF("pdf")`

      - `Optional<Long> numLines`

      - `Optional<Long> startLine`

      - `Optional<Long> totalLines`

    - `class BetaTextEditorCodeExecutionCreateResultBlock`

      - `JsonValue type = "text_editor_code_execution_create_result"`

      - `boolean isFileUpdate`

    - `class BetaTextEditorCodeExecutionStrReplaceResultBlock`

      - `JsonValue type = "text_editor_code_execution_str_replace_result"`

      - `Optional<List<String>> lines`

      - `Optional<Long> newLines`

      - `Optional<Long> newStart`

      - `Optional<Long> oldLines`

      - `Optional<Long> oldStart`

  - `String toolUseId`

    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Text Editor Code Execution Tool Result Block Param

- `class BetaTextEditorCodeExecutionToolResultBlockParam`

  - `JsonValue type = "text_editor_code_execution_tool_result"`

  - `Content content`

    - `class BetaTextEditorCodeExecutionToolResultErrorParam`

      - `JsonValue type = "text_editor_code_execution_tool_result_error"`

      - `ErrorCode 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<String> errorMessage`

    - `class BetaTextEditorCodeExecutionViewResultBlockParam`

      - `JsonValue type = "text_editor_code_execution_view_result"`

      - `String content`

      - `FileType fileType`

        - `TEXT("text")`

        - `IMAGE("image")`

        - `PDF("pdf")`

      - `Optional<Long> numLines`

      - `Optional<Long> startLine`

      - `Optional<Long> totalLines`

    - `class BetaTextEditorCodeExecutionCreateResultBlockParam`

      - `JsonValue type = "text_editor_code_execution_create_result"`

      - `boolean isFileUpdate`

    - `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam`

      - `JsonValue type = "text_editor_code_execution_str_replace_result"`

      - `Optional<List<String>> lines`

      - `Optional<Long> newLines`

      - `Optional<Long> newStart`

      - `Optional<Long> oldLines`

      - `Optional<Long> oldStart`

  - `String toolUseId`

    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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")`

### Beta Text Editor Code Execution Tool Result Error

- `class BetaTextEditorCodeExecutionToolResultError`

  - `JsonValue type = "text_editor_code_execution_tool_result_error"`

  - `ErrorCode 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<String> errorMessage`

### Beta Text Editor Code Execution Tool Result Error Param

- `class BetaTextEditorCodeExecutionToolResultErrorParam`

  - `JsonValue type = "text_editor_code_execution_tool_result_error"`

  - `ErrorCode 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<String> errorMessage`

### Beta Text Editor Code Execution View Result Block

- `class BetaTextEditorCodeExecutionViewResultBlock`

  - `JsonValue type = "text_editor_code_execution_view_result"`

  - `String content`

  - `FileType fileType`

    - `TEXT("text")`

    - `IMAGE("image")`

    - `PDF("pdf")`

  - `Optional<Long> numLines`

  - `Optional<Long> startLine`

  - `Optional<Long> totalLines`

### Beta Text Editor Code Execution View Result Block Param

- `class BetaTextEditorCodeExecutionViewResultBlockParam`

  - `JsonValue type = "text_editor_code_execution_view_result"`

  - `String content`

  - `FileType fileType`

    - `TEXT("text")`

    - `IMAGE("image")`

    - `PDF("pdf")`

  - `Optional<Long> numLines`

  - `Optional<Long> startLine`

  - `Optional<Long> totalLines`

### Beta Thinking Block

- `class BetaThinkingBlock`

  - `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.

### Beta Thinking Block Binding

- `class BetaThinkingBlockBinding`

  Controls for block binding: what happens when a thinking block this
  request sends back fails the conversation check. Every field is optional;
  an empty object means every default.

  - `Optional<BetaThinkingPrefixMismatchBehavior> prefixMismatchBehavior`

    "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`.

    - `ERROR("error")`

    - `DROP_BLOCK("drop_block")`

### Beta Thinking Block Param

- `class BetaThinkingBlockParam`

  - `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.

### Beta Thinking Config Adaptive

- `class BetaThinkingConfigAdaptive`

  - `JsonValue type = "adaptive"`

  - `Optional<BetaThinkingBlockBinding> blockBinding`

    Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.

    - `Optional<BetaThinkingPrefixMismatchBehavior> prefixMismatchBehavior`

      "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`.

      - `ERROR("error")`

      - `DROP_BLOCK("drop_block")`

  - `Optional<Display> 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")`

    - `UPDATES("updates")`

### Beta Thinking Config Between Tools

- `class BetaThinkingConfigBetweenTools`

  - `JsonValue type = "between_tools"`

### Beta Thinking Config Disabled

- `class BetaThinkingConfigDisabled`

  - `JsonValue type = "disabled"`

### Beta Thinking Config Enabled

- `class BetaThinkingConfigEnabled`

  - `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<BetaThinkingBlockBinding> blockBinding`

    Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.

    - `Optional<BetaThinkingPrefixMismatchBehavior> prefixMismatchBehavior`

      "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`.

      - `ERROR("error")`

      - `DROP_BLOCK("drop_block")`

  - `Optional<Display> 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")`

    - `UPDATES("updates")`

### Beta Thinking Config Param

- `class BetaThinkingConfigParam: 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 BetaThinkingConfigEnabled`

    - `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<BetaThinkingBlockBinding> blockBinding`

      Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.

      - `Optional<BetaThinkingPrefixMismatchBehavior> prefixMismatchBehavior`

        "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`.

        - `ERROR("error")`

        - `DROP_BLOCK("drop_block")`

    - `Optional<Display> 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")`

      - `UPDATES("updates")`

  - `class BetaThinkingConfigDisabled`

    - `JsonValue type = "disabled"`

  - `class BetaThinkingConfigBetweenTools`

    - `JsonValue type = "between_tools"`

  - `class BetaThinkingConfigAdaptive`

    - `JsonValue type = "adaptive"`

    - `Optional<BetaThinkingBlockBinding> blockBinding`

      Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.

    - `Optional<Display> 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")`

      - `UPDATES("updates")`

### Beta Thinking Delta

- `class BetaThinkingDelta`

  - `JsonValue type = "thinking_delta"`

  - `Optional<Long> estimatedTokens`

    Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative.

  - `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.

### Beta Thinking Dropped Input Transformation

- `class BetaThinkingDroppedInputTransformation`

  - `JsonValue type = "thinking_dropped"`

    Always `thinking_dropped` for this entry type.

  - `String path`

    Where the removed block was in your request, as `messages.{i}.content.{j}`:
    `i` indexes the `messages` array you sent and `j` that message's `content`
    array — the same form error messages use.

  - `Reason reason`

    Which binding check removed the block: `model_binding_mismatch` — it was
    created by a model whose reasoning the requested model may not read;
    `prefix_binding_mismatch` — the conversation before it differs from the
    conversation it was created in (the rest of that turn's consecutive thinking
    blocks are removed with it, each with this reason);
    `organization_binding_mismatch` — it was created under a different
    organization (an Anthropic organization, AWS account or Google Cloud project)
    and this organization is not one of its additional organizations;
    `end_user_binding_mismatch` — it was created for a different end user, or
    was removed by the consumer-organization binding. A block that would fail
    several checks reports one reason, in this order of precedence:
    `organization_binding_mismatch`, `end_user_binding_mismatch`,
    `model_binding_mismatch`, `prefix_binding_mismatch`.

    - `MODEL_BINDING_MISMATCH("model_binding_mismatch")`

    - `PREFIX_BINDING_MISMATCH("prefix_binding_mismatch")`

    - `ORGANIZATION_BINDING_MISMATCH("organization_binding_mismatch")`

    - `END_USER_BINDING_MISMATCH("end_user_binding_mismatch")`

### Beta Thinking Mismatch Allowed Input Transformation

- `class BetaThinkingMismatchAllowedInputTransformation`

  - `JsonValue type = "thinking_mismatch_allowed"`

    Always `thinking_mismatch_allowed` for this entry type.

  - `String path`

    Where the block is in your request, as `messages.{i}.content.{j}`:
    `i` indexes the `messages` array you sent and `j` that message's `content`
    array — the same form error messages use.

  - `Reason reason`

    Which binding check the block failed; the block was shown to the model all
    the same. Always `prefix_binding_mismatch` today — the conversation before
    the block differs from the conversation it was created in, or the block
    carries no record of one on a model that requires it. Were the check
    enforced for this request, the block would have been removed or the request
    rejected (`thinking.block_binding.prefix_mismatch_behavior`). A removal also
    takes the rest of that turn's consecutive thinking blocks, whereas here each
    block is checked on its own, so `thinking_mismatch_allowed` entries are a
    lower bound on what enforcement would remove.

    - `MODEL_BINDING_MISMATCH("model_binding_mismatch")`

    - `PREFIX_BINDING_MISMATCH("prefix_binding_mismatch")`

    - `ORGANIZATION_BINDING_MISMATCH("organization_binding_mismatch")`

    - `END_USER_BINDING_MISMATCH("end_user_binding_mismatch")`

### Beta Thinking Prefix Mismatch Behavior

- `enum BetaThinkingPrefixMismatchBehavior`

  What happens when a thinking block in `messages` fails the conversation
  check: it was created in a different conversation, or the messages before
  it have changed since. `"error"` (the default) fails the request with a
  400 error. `"drop_block"` removes the failing blocks and the request
  proceeds; the model no longer sees the dropped reasoning.

  - `ERROR("error")`

  - `DROP_BLOCK("drop_block")`

### Beta Thinking Turns

- `class BetaThinkingTurns`

  - `JsonValue type = "thinking_turns"`

  - `long value`

    minimum: 1

### Beta Token Task Budget

- `class BetaTokenTaskBudget`

  User-configurable total token budget across contexts.

  - `JsonValue type = "tokens"`

    The budget type. Currently only 'tokens' is supported.

  - `long total`

    Total token budget across all contexts in the session.

    minimum: 1024

  - `Optional<Long> remaining`

    Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided.

    minimum: 0

### Beta Tool

- `class BetaTool`

  - `Optional<Type> 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> properties`

    - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Tool Bash 20241022

- `class BetaToolBash20241022`

  - `JsonValue type = "bash_20241022"`

  - `JsonValue name = "bash"`

    Name of the tool.

    This is how the tool will be called by the model and in `tool_use` blocks.

  - `Optional<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<List<InputExample>> inputExamples`

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Tool Bash 20250124

- `class BetaToolBash20250124`

  - `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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<List<InputExample>> inputExamples`

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Tool Change MCP Tool Reference

- `class BetaToolChangeMcpToolReference`

  Reference to a single MCP tool by its server and remote name; the
  same `server_name`/`name` pair `mcp_tool_use` carries.

  - `JsonValue type = "mcp_tool_reference"`

  - `String name`

  - `String serverName`

### Beta Tool Change MCP Toolset Reference

- `class BetaToolChangeMcpToolsetReference`

  Reference to every tool in the named MCP server's toolset.

  - `JsonValue type = "mcp_toolset_reference"`

  - `String serverName`

### Beta Tool Change Tool Definition

- `class BetaToolChangeToolDefinition`

  A tool defined by value, as a `compaction` block's `tool_changes` entry
  reports it: `definition` is the tool's definition as it was sent, in the
  form of a `tools` entry, without `cache_control`. Send it back unchanged
  with the block.

  - `JsonValue type = "tool_definition"`

  - `BetaResponseToolUnion definition`

    - `class BetaResponseTool`

      A custom tool definition, as sent.

      - `Optional<Type> type`

      - `BetaResponseToolInputSchema 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> properties`

        - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolBash20241022`

      - `JsonValue type = "bash_20241022"`

      - `JsonValue name = "bash"`

        Name of the tool.

        This is how the tool will be called by the model and in `tool_use` blocks.

      - `Optional<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

        - `JsonValue type = "ephemeral"`

        - `Optional<Ttl> 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<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolBash20250124`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaCodeExecutionTool20250522`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaCodeExecutionTool20250825`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaCodeExecutionTool20260120`

      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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaCodeExecutionTool20260521`

      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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaBrowserToolset20260801`

      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<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

          `type`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserCloseTabConfig> closeTab`

          `close_tab`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

          `double_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserFileUploadConfig> fileUpload`

          `file_upload`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserFindConfig> find`

          `find`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserFormInputConfig> formInput`

          `form_input`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserGetPageTextConfig> getPageText`

          `get_page_text`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserHoldKeyConfig> holdKey`

          `hold_key`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserHoverConfig> hover`

          `hover`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

          `javascript_exec`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserKeyConfig> key`

          `key`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserLeftClickConfig> leftClick`

          `left_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

          `left_click_drag`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

          `left_mouse_down`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

          `left_mouse_up`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserListTabsConfig> listTabs`

          `list_tabs`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserMiddleClickConfig> middleClick`

          `middle_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

          `mouse_move`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserNavigateConfig> navigate`

          `navigate`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserNewTabConfig> newTab`

          `new_tab`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserReadConsoleConfig> readConsole`

          `read_console`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

          `read_network`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserReadPageConfig> readPage`

          `read_page`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserRightClickConfig> rightClick`

          `right_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserScreenshotConfig> screenshot`

          `screenshot`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserScrollConfig> scroll`

          `scroll`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserScrollToConfig> scrollTo`

          `scroll_to`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserSwitchTabConfig> switchTab`

          `switch_tab`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserTripleClickConfig> tripleClick`

          `triple_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserWaitConfig> wait`

          `wait`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserZoomConfig> zoom`

          `zoom`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered 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 BetaToolComputerUse20241022`

      - `JsonValue type = "computer_20241022"`

      - `long displayHeightPx`

        The height of the display in pixels.

        minimum: 1

      - `long displayWidthPx`

        The width of the display in pixels.

        minimum: 1

      - `JsonValue name = "computer"`

        Name of the tool.

        This is how the tool will be called by the model and in `tool_use` blocks.

      - `Optional<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> displayNumber`

        The X11 display number (e.g. 0, 1) for the display.

        minimum: 0

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaMemoryTool20250818`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolComputerUse20250124`

      - `JsonValue type = "computer_20250124"`

      - `long displayHeightPx`

        The height of the display in pixels.

        minimum: 1

      - `long displayWidthPx`

        The width of the display in pixels.

        minimum: 1

      - `JsonValue name = "computer"`

        Name of the tool.

        This is how the tool will be called by the model and in `tool_use` blocks.

      - `Optional<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> displayNumber`

        The X11 display number (e.g. 0, 1) for the display.

        minimum: 0

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolTextEditor20241022`

      - `JsonValue type = "text_editor_20241022"`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolComputerUse20251124`

      - `JsonValue type = "computer_20251124"`

      - `long displayHeightPx`

        The height of the display in pixels.

        minimum: 1

      - `long displayWidthPx`

        The width of the display in pixels.

        minimum: 1

      - `JsonValue name = "computer"`

        Name of the tool.

        This is how the tool will be called by the model and in `tool_use` blocks.

      - `Optional<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> displayNumber`

        The X11 display number (e.g. 0, 1) for the display.

        minimum: 0

      - `Optional<Boolean> enableZoom`

        Whether to enable an action to take a zoomed-in screenshot of the screen.

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaComputerToolset20260801`

      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<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

          `type`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

          `cursor_position`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerDoubleClickConfig> doubleClick`

          `double_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerHoldKeyConfig> holdKey`

          `hold_key`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerKeyConfig> key`

          `key`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerLeftClickConfig> leftClick`

          `left_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

          `left_click_drag`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

          `left_mouse_down`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

          `left_mouse_up`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerMiddleClickConfig> middleClick`

          `middle_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerMouseMoveConfig> mouseMove`

          `mouse_move`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerRightClickConfig> rightClick`

          `right_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerScreenshotConfig> screenshot`

          `screenshot`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerScrollConfig> scroll`

          `scroll`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerTripleClickConfig> tripleClick`

          `triple_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerWaitConfig> wait`

          `wait`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerZoomConfig> zoom`

          `zoom`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered 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 BetaToolTextEditor20250124`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolTextEditor20250429`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolTextEditor20250728`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Long> maxCharacters`

        Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

        minimum: 1

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaWebSearchTool20250305`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<List<String>> allowedDomains`

        If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

      - `Optional<List<String>> blockedDomains`

        If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> maxUses`

        Maximum number of times the tool can be used in the API request.

        minimum: 1

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

      - `Optional<BetaUserLocation> userLocation`

        Parameters for the user's location. Used to provide more relevant search results.

        - `JsonValue type = "approximate"`

        - `Optional<String> city`

          The city of the user.

          minLength: 1, maxLength: 255

        - `Optional<String> 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<String> region`

          The region of the user.

          minLength: 1, maxLength: 255

        - `Optional<String> timezone`

          The [IANA timezone](https://nodatime.org/TimeZones) of the user.

          minLength: 1, maxLength: 255

    - `class BetaWebFetchTool20250910`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<List<String>> allowedDomains`

        List of domains to allow fetching from

      - `Optional<List<String>> blockedDomains`

        List of domains to block fetching from

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<BetaCitationsConfigParam> citations`

        Citations configuration for fetched documents. Citations are disabled by default.

        - `Optional<Boolean> enabled`

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> 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<Long> maxUses`

        Maximum number of times the tool can be used in the API request.

        minimum: 1

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

      - `Optional<BetaWebFetchUrlSources> urlSources`

        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

        - `Optional<ClientToolResults> clientToolResults`

          Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

          - `class BetaWebFetchUrlSourceAll`

            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 BetaWebFetchUrlSourceNone`

            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 BetaWebFetchUrlSourceOnly`

            The tool filter variant under which only the named tools' results
            contribute.

            - `JsonValue type = "only"`

            - `List<BetaWebFetchUrlSourceToolReference> tools`

              - `JsonValue type = "tool_reference"`

              - `String name`

          - `class BetaWebFetchUrlSourceExcept`

            The tool filter variant under which every result but the named
            tools' contributes.

            - `JsonValue type = "except"`

            - `List<BetaWebFetchUrlSourceToolReference> tools`

              - `JsonValue type = "tool_reference"`

              - `String name`

        - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

            The `url_sources` variant under which a source contributes in
            full: every result of the tool filter's source, or all user input.

          - `class BetaWebFetchUrlSourceNone`

            The `url_sources` variant under which a source contributes nothing:
            no result of the tool filter's source, or no user input.

          - `class BetaWebFetchUrlSourceOnly`

            The tool filter variant under which only the named tools' results
            contribute.

          - `class BetaWebFetchUrlSourceExcept`

            The tool filter variant under which every result but the named
            tools' contributes.

        - `Optional<UserInput> userInput`

          Whether URLs in user messages are fetchable: "all" or "none".

          - `class BetaWebFetchUrlSourceAll`

            The `url_sources` variant under which a source contributes in
            full: every result of the tool filter's source, or all user input.

          - `class BetaWebFetchUrlSourceNone`

            The `url_sources` variant under which a source contributes nothing:
            no result of the tool filter's source, or no user input.

    - `class BetaWebSearchTool20260209`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<List<String>> allowedDomains`

        If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

      - `Optional<List<String>> blockedDomains`

        If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> maxUses`

        Maximum number of times the tool can be used in the API request.

        minimum: 1

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

      - `Optional<BetaUserLocation> userLocation`

        Parameters for the user's location. Used to provide more relevant search results.

    - `class BetaWebFetchTool20260209`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<List<String>> allowedDomains`

        List of domains to allow fetching from

      - `Optional<List<String>> blockedDomains`

        List of domains to block fetching from

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<BetaCitationsConfigParam> citations`

        Citations configuration for fetched documents. Citations are disabled by default.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> 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<Long> maxUses`

        Maximum number of times the tool can be used in the API request.

        minimum: 1

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

      - `Optional<BetaWebFetchUrlSources> urlSources`

        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

    - `class BetaWebFetchTool20260309`

      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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<List<String>> allowedDomains`

        List of domains to allow fetching from

      - `Optional<List<String>> blockedDomains`

        List of domains to block fetching from

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<BetaCitationsConfigParam> citations`

        Citations configuration for fetched documents. Citations are disabled by default.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> 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<Long> maxUses`

        Maximum number of times the tool can be used in the API request.

        minimum: 1

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

      - `Optional<BetaWebFetchUrlSources> urlSources`

        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

      - `Optional<Boolean> 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 BetaWebSearchTool20260318`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<List<String>> allowedDomains`

        If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

      - `Optional<List<String>> blockedDomains`

        If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> maxUses`

        Maximum number of times the tool can be used in the API request.

        minimum: 1

      - `Optional<ResponseInclusion> 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<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

      - `Optional<BetaUserLocation> userLocation`

        Parameters for the user's location. Used to provide more relevant search results.

    - `class BetaWebFetchTool20260318`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<List<String>> allowedDomains`

        List of domains to allow fetching from

      - `Optional<List<String>> blockedDomains`

        List of domains to block fetching from

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<BetaCitationsConfigParam> citations`

        Citations configuration for fetched documents. Citations are disabled by default.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> 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<Long> maxUses`

        Maximum number of times the tool can be used in the API request.

        minimum: 1

      - `Optional<ResponseInclusion> 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<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

      - `Optional<BetaWebFetchUrlSources> urlSources`

        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

      - `Optional<Boolean> 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 BetaAdvisorTool20260301`

      - `JsonValue type = "advisor_20260301"`

      - `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 name = "advisor"`

        Name of the tool.

        This is how the tool will be called by the model and in `tool_use` blocks.

      - `Optional<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<BetaCacheControlEphemeral> caching`

        Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> maxTokens`

        Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

        minimum: 1024

      - `Optional<Long> maxUses`

        Maximum number of times the tool can be used in the API request.

        minimum: 1

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolSearchToolRegex20251119`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaMcpToolset`

      Configuration for a group of tools from an MCP server.

      Allows configuring enabled status and defer_loading for all tools
      from an MCP server, with optional per-tool overrides.

      - `JsonValue type = "mcp_toolset"`

      - `String mcpServerName`

        Name of the MCP server to configure tools for

        minLength: 1, maxLength: 255

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Configs> configs`

        Configuration overrides for specific tools, keyed by tool name

        - `Optional<Boolean> deferLoading`

        - `Optional<Boolean> enabled`

      - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

        Default configuration applied to all tools from this server

        - `Optional<Boolean> deferLoading`

        - `Optional<Boolean> enabled`

      - `Optional<List<BetaMcpToolParam>> tools`

        The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

        - `InputSchema inputSchema`

          The tool's input schema as the MCP server lists it, verbatim.

        - `String name`

          The tool's name as the MCP server lists it (not prefixed with the server name).

          minLength: 1

        - `Optional<String> description`

          The tool's description as the MCP server lists it.

### Beta Tool Change Tool Definition Param

- `class BetaToolChangeToolDefinitionParam`

  A tool defined by value: `definition` is a `tools` entry (any kind
  `tools` accepts, an MCP toolset included). An `mcp_toolset` given here
  also requires the `mcp-client-2026-09-15` beta.

  - `JsonValue type = "tool_definition"`

  - `BetaToolUnion definition`

    - `class BetaTool`

      - `Optional<Type> 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> properties`

        - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

        - `JsonValue type = "ephemeral"`

        - `Optional<Ttl> 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<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolBash20241022`

      - `JsonValue type = "bash_20241022"`

      - `JsonValue name = "bash"`

        Name of the tool.

        This is how the tool will be called by the model and in `tool_use` blocks.

      - `Optional<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolBash20250124`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaCodeExecutionTool20250522`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaCodeExecutionTool20250825`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaCodeExecutionTool20260120`

      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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaCodeExecutionTool20260521`

      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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaBrowserToolset20260801`

      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<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

          `type`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserCloseTabConfig> closeTab`

          `close_tab`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

          `double_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserFileUploadConfig> fileUpload`

          `file_upload`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserFindConfig> find`

          `find`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserFormInputConfig> formInput`

          `form_input`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserGetPageTextConfig> getPageText`

          `get_page_text`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserHoldKeyConfig> holdKey`

          `hold_key`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserHoverConfig> hover`

          `hover`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

          `javascript_exec`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserKeyConfig> key`

          `key`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserLeftClickConfig> leftClick`

          `left_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

          `left_click_drag`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

          `left_mouse_down`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

          `left_mouse_up`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserListTabsConfig> listTabs`

          `list_tabs`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserMiddleClickConfig> middleClick`

          `middle_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

          `mouse_move`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserNavigateConfig> navigate`

          `navigate`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserNewTabConfig> newTab`

          `new_tab`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserReadConsoleConfig> readConsole`

          `read_console`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

          `read_network`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserReadPageConfig> readPage`

          `read_page`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserRightClickConfig> rightClick`

          `right_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserScreenshotConfig> screenshot`

          `screenshot`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserScrollConfig> scroll`

          `scroll`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserScrollToConfig> scrollTo`

          `scroll_to`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserSwitchTabConfig> switchTab`

          `switch_tab`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserTripleClickConfig> tripleClick`

          `triple_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserWaitConfig> wait`

          `wait`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaBrowserZoomConfig> zoom`

          `zoom`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered 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 BetaToolComputerUse20241022`

      - `JsonValue type = "computer_20241022"`

      - `long displayHeightPx`

        The height of the display in pixels.

        minimum: 1

      - `long displayWidthPx`

        The width of the display in pixels.

        minimum: 1

      - `JsonValue name = "computer"`

        Name of the tool.

        This is how the tool will be called by the model and in `tool_use` blocks.

      - `Optional<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> displayNumber`

        The X11 display number (e.g. 0, 1) for the display.

        minimum: 0

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaMemoryTool20250818`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolComputerUse20250124`

      - `JsonValue type = "computer_20250124"`

      - `long displayHeightPx`

        The height of the display in pixels.

        minimum: 1

      - `long displayWidthPx`

        The width of the display in pixels.

        minimum: 1

      - `JsonValue name = "computer"`

        Name of the tool.

        This is how the tool will be called by the model and in `tool_use` blocks.

      - `Optional<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> displayNumber`

        The X11 display number (e.g. 0, 1) for the display.

        minimum: 0

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolTextEditor20241022`

      - `JsonValue type = "text_editor_20241022"`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolComputerUse20251124`

      - `JsonValue type = "computer_20251124"`

      - `long displayHeightPx`

        The height of the display in pixels.

        minimum: 1

      - `long displayWidthPx`

        The width of the display in pixels.

        minimum: 1

      - `JsonValue name = "computer"`

        Name of the tool.

        This is how the tool will be called by the model and in `tool_use` blocks.

      - `Optional<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> displayNumber`

        The X11 display number (e.g. 0, 1) for the display.

        minimum: 0

      - `Optional<Boolean> enableZoom`

        Whether to enable an action to take a zoomed-in screenshot of the screen.

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaComputerToolset20260801`

      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<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

          `type`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

          `cursor_position`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerDoubleClickConfig> doubleClick`

          `double_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerHoldKeyConfig> holdKey`

          `hold_key`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerKeyConfig> key`

          `key`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerLeftClickConfig> leftClick`

          `left_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

          `left_click_drag`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

          `left_mouse_down`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

          `left_mouse_up`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerMiddleClickConfig> middleClick`

          `middle_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerMouseMoveConfig> mouseMove`

          `mouse_move`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerRightClickConfig> rightClick`

          `right_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerScreenshotConfig> screenshot`

          `screenshot`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerScrollConfig> scroll`

          `scroll`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerTripleClickConfig> tripleClick`

          `triple_click`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerWaitConfig> wait`

          `wait`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

        - `Optional<BetaComputerZoomConfig> zoom`

          `zoom`'s config overrides.

          - `Optional<Boolean> deferLoading`

            Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

          - `Optional<Boolean> enabled`

            Whether this member is offered 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 BetaToolTextEditor20250124`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolTextEditor20250429`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolTextEditor20250728`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<List<InputExample>> inputExamples`

      - `Optional<Long> maxCharacters`

        Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

        minimum: 1

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaWebSearchTool20250305`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<List<String>> allowedDomains`

        If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

      - `Optional<List<String>> blockedDomains`

        If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> maxUses`

        Maximum number of times the tool can be used in the API request.

        minimum: 1

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

      - `Optional<BetaUserLocation> userLocation`

        Parameters for the user's location. Used to provide more relevant search results.

        - `JsonValue type = "approximate"`

        - `Optional<String> city`

          The city of the user.

          minLength: 1, maxLength: 255

        - `Optional<String> 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<String> region`

          The region of the user.

          minLength: 1, maxLength: 255

        - `Optional<String> timezone`

          The [IANA timezone](https://nodatime.org/TimeZones) of the user.

          minLength: 1, maxLength: 255

    - `class BetaWebFetchTool20250910`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<List<String>> allowedDomains`

        List of domains to allow fetching from

      - `Optional<List<String>> blockedDomains`

        List of domains to block fetching from

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<BetaCitationsConfigParam> citations`

        Citations configuration for fetched documents. Citations are disabled by default.

        - `Optional<Boolean> enabled`

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> 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<Long> maxUses`

        Maximum number of times the tool can be used in the API request.

        minimum: 1

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

      - `Optional<BetaWebFetchUrlSources> urlSources`

        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

        - `Optional<ClientToolResults> clientToolResults`

          Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

          - `class BetaWebFetchUrlSourceAll`

            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 BetaWebFetchUrlSourceNone`

            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 BetaWebFetchUrlSourceOnly`

            The tool filter variant under which only the named tools' results
            contribute.

            - `JsonValue type = "only"`

            - `List<BetaWebFetchUrlSourceToolReference> tools`

              - `JsonValue type = "tool_reference"`

              - `String name`

          - `class BetaWebFetchUrlSourceExcept`

            The tool filter variant under which every result but the named
            tools' contributes.

            - `JsonValue type = "except"`

            - `List<BetaWebFetchUrlSourceToolReference> tools`

              - `JsonValue type = "tool_reference"`

              - `String name`

        - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

            The `url_sources` variant under which a source contributes in
            full: every result of the tool filter's source, or all user input.

          - `class BetaWebFetchUrlSourceNone`

            The `url_sources` variant under which a source contributes nothing:
            no result of the tool filter's source, or no user input.

          - `class BetaWebFetchUrlSourceOnly`

            The tool filter variant under which only the named tools' results
            contribute.

          - `class BetaWebFetchUrlSourceExcept`

            The tool filter variant under which every result but the named
            tools' contributes.

        - `Optional<UserInput> userInput`

          Whether URLs in user messages are fetchable: "all" or "none".

          - `class BetaWebFetchUrlSourceAll`

            The `url_sources` variant under which a source contributes in
            full: every result of the tool filter's source, or all user input.

          - `class BetaWebFetchUrlSourceNone`

            The `url_sources` variant under which a source contributes nothing:
            no result of the tool filter's source, or no user input.

    - `class BetaWebSearchTool20260209`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<List<String>> allowedDomains`

        If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

      - `Optional<List<String>> blockedDomains`

        If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> maxUses`

        Maximum number of times the tool can be used in the API request.

        minimum: 1

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

      - `Optional<BetaUserLocation> userLocation`

        Parameters for the user's location. Used to provide more relevant search results.

    - `class BetaWebFetchTool20260209`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<List<String>> allowedDomains`

        List of domains to allow fetching from

      - `Optional<List<String>> blockedDomains`

        List of domains to block fetching from

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<BetaCitationsConfigParam> citations`

        Citations configuration for fetched documents. Citations are disabled by default.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> 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<Long> maxUses`

        Maximum number of times the tool can be used in the API request.

        minimum: 1

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

      - `Optional<BetaWebFetchUrlSources> urlSources`

        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

    - `class BetaWebFetchTool20260309`

      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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<List<String>> allowedDomains`

        List of domains to allow fetching from

      - `Optional<List<String>> blockedDomains`

        List of domains to block fetching from

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<BetaCitationsConfigParam> citations`

        Citations configuration for fetched documents. Citations are disabled by default.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> 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<Long> maxUses`

        Maximum number of times the tool can be used in the API request.

        minimum: 1

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

      - `Optional<BetaWebFetchUrlSources> urlSources`

        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

      - `Optional<Boolean> 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 BetaWebSearchTool20260318`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<List<String>> allowedDomains`

        If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

      - `Optional<List<String>> blockedDomains`

        If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> maxUses`

        Maximum number of times the tool can be used in the API request.

        minimum: 1

      - `Optional<ResponseInclusion> 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<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

      - `Optional<BetaUserLocation> userLocation`

        Parameters for the user's location. Used to provide more relevant search results.

    - `class BetaWebFetchTool20260318`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<List<String>> allowedDomains`

        List of domains to allow fetching from

      - `Optional<List<String>> blockedDomains`

        List of domains to block fetching from

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<BetaCitationsConfigParam> citations`

        Citations configuration for fetched documents. Citations are disabled by default.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> 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<Long> maxUses`

        Maximum number of times the tool can be used in the API request.

        minimum: 1

      - `Optional<ResponseInclusion> 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<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

      - `Optional<BetaWebFetchUrlSources> urlSources`

        Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

      - `Optional<Boolean> 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 BetaAdvisorTool20260301`

      - `JsonValue type = "advisor_20260301"`

      - `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 name = "advisor"`

        Name of the tool.

        This is how the tool will be called by the model and in `tool_use` blocks.

      - `Optional<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<BetaCacheControlEphemeral> caching`

        Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Long> maxTokens`

        Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

        minimum: 1024

      - `Optional<Long> maxUses`

        Maximum number of times the tool can be used in the API request.

        minimum: 1

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaToolSearchToolRegex20251119`

      - `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<List<AllowedCaller>> allowedCallers`

        - `DIRECT("direct")`

        - `CODE_EXECUTION_20250825("code_execution_20250825")`

        - `CODE_EXECUTION_20260120("code_execution_20260120")`

        - `CODE_EXECUTION_20260521("code_execution_20260521")`

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Boolean> deferLoading`

        If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

      - `Optional<Boolean> strict`

        When true, guarantees schema validation on tool names and inputs

    - `class BetaMcpToolset`

      Configuration for a group of tools from an MCP server.

      Allows configuring enabled status and defer_loading for all tools
      from an MCP server, with optional per-tool overrides.

      - `JsonValue type = "mcp_toolset"`

      - `String mcpServerName`

        Name of the MCP server to configure tools for

        minLength: 1, maxLength: 255

      - `Optional<BetaCacheControlEphemeral> cacheControl`

        Create a cache control breakpoint at this content block.

      - `Optional<Configs> configs`

        Configuration overrides for specific tools, keyed by tool name

        - `Optional<Boolean> deferLoading`

        - `Optional<Boolean> enabled`

      - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

        Default configuration applied to all tools from this server

        - `Optional<Boolean> deferLoading`

        - `Optional<Boolean> enabled`

      - `Optional<List<BetaMcpToolParam>> tools`

        The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

        - `InputSchema inputSchema`

          The tool's input schema as the MCP server lists it, verbatim.

        - `String name`

          The tool's name as the MCP server lists it (not prefixed with the server name).

          minLength: 1

        - `Optional<String> description`

          The tool's description as the MCP server lists it.

### Beta Tool Change Tool Reference

- `class BetaToolChangeToolReference`

  Reference to a single tool, by the name the model uses to call it: a
  tool declared in `tools` or defined by an earlier `tool_addition`
  block. Does not accept the composed `{server}_{name}` form the server
  assigns to MCP-resolved tools; use `mcp_tool_reference` or
  `mcp_toolset_reference` for those.

  - `JsonValue type = "tool_reference"`

  - `String name`

    pattern: ^[a-zA-Z0-9_-]{1,128}$

### Beta Tool Choice

- `class BetaToolChoice: 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 BetaToolChoiceAuto`

    The model will automatically decide whether to use tools.

    - `JsonValue type = "auto"`

    - `Optional<Boolean> disableParallelToolUse`

      Whether to disable parallel tool use.

      Defaults to `false`. If set to `true`, the model will output at most one tool use.

  - `class BetaToolChoiceAny`

    The model will use any available tools.

    - `JsonValue type = "any"`

    - `Optional<Boolean> disableParallelToolUse`

      Whether to disable parallel tool use.

      Defaults to `false`. If set to `true`, the model will output exactly one tool use.

  - `class BetaToolChoiceTool`

    The model will use the specified tool with `tool_choice.name`.

    - `JsonValue type = "tool"`

    - `String name`

      The name of the tool to use.

    - `Optional<Boolean> disableParallelToolUse`

      Whether to disable parallel tool use.

      Defaults to `false`. If set to `true`, the model will output exactly one tool use.

  - `class BetaToolChoiceNone`

    The model will not be allowed to use tools.

    - `JsonValue type = "none"`

### Beta Tool Choice Any

- `class BetaToolChoiceAny`

  The model will use any available tools.

  - `JsonValue type = "any"`

  - `Optional<Boolean> disableParallelToolUse`

    Whether to disable parallel tool use.

    Defaults to `false`. If set to `true`, the model will output exactly one tool use.

### Beta Tool Choice Auto

- `class BetaToolChoiceAuto`

  The model will automatically decide whether to use tools.

  - `JsonValue type = "auto"`

  - `Optional<Boolean> disableParallelToolUse`

    Whether to disable parallel tool use.

    Defaults to `false`. If set to `true`, the model will output at most one tool use.

### Beta Tool Choice None

- `class BetaToolChoiceNone`

  The model will not be allowed to use tools.

  - `JsonValue type = "none"`

### Beta Tool Choice Tool

- `class BetaToolChoiceTool`

  The model will use the specified tool with `tool_choice.name`.

  - `JsonValue type = "tool"`

  - `String name`

    The name of the tool to use.

  - `Optional<Boolean> disableParallelToolUse`

    Whether to disable parallel tool use.

    Defaults to `false`. If set to `true`, the model will output exactly one tool use.

### Beta Tool Computer Use 20241022

- `class BetaToolComputerUse20241022`

  - `JsonValue type = "computer_20241022"`

  - `long displayHeightPx`

    The height of the display in pixels.

    minimum: 1

  - `long displayWidthPx`

    The width of the display in pixels.

    minimum: 1

  - `JsonValue name = "computer"`

    Name of the tool.

    This is how the tool will be called by the model and in `tool_use` blocks.

  - `Optional<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Long> displayNumber`

    The X11 display number (e.g. 0, 1) for the display.

    minimum: 0

  - `Optional<List<InputExample>> inputExamples`

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Tool Computer Use 20250124

- `class BetaToolComputerUse20250124`

  - `JsonValue type = "computer_20250124"`

  - `long displayHeightPx`

    The height of the display in pixels.

    minimum: 1

  - `long displayWidthPx`

    The width of the display in pixels.

    minimum: 1

  - `JsonValue name = "computer"`

    Name of the tool.

    This is how the tool will be called by the model and in `tool_use` blocks.

  - `Optional<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Long> displayNumber`

    The X11 display number (e.g. 0, 1) for the display.

    minimum: 0

  - `Optional<List<InputExample>> inputExamples`

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Tool Computer Use 20251124

- `class BetaToolComputerUse20251124`

  - `JsonValue type = "computer_20251124"`

  - `long displayHeightPx`

    The height of the display in pixels.

    minimum: 1

  - `long displayWidthPx`

    The width of the display in pixels.

    minimum: 1

  - `JsonValue name = "computer"`

    Name of the tool.

    This is how the tool will be called by the model and in `tool_use` blocks.

  - `Optional<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Long> displayNumber`

    The X11 display number (e.g. 0, 1) for the display.

    minimum: 0

  - `Optional<Boolean> enableZoom`

    Whether to enable an action to take a zoomed-in screenshot of the screen.

  - `Optional<List<InputExample>> inputExamples`

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Tool Reference Block

- `class BetaToolReferenceBlock`

  - `JsonValue type = "tool_reference"`

  - `String toolName`

    minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$

### Beta Tool Reference Block Param

- `class BetaToolReferenceBlockParam`

  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<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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")`

### Beta Tool Result Block Param

- `class BetaToolResultBlockParam`

  - `JsonValue type = "tool_result"`

  - `String toolUseId`

    pattern: ^[a-zA-Z0-9_-]+$

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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> content`

    - `String`

    - `List<Block>`

      - `class BetaTextBlockParam`

        - `JsonValue type = "text"`

        - `String text`

          minLength: 1

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<List<BetaTextCitationParam>> citations`

          - `class BetaCitationCharLocationParam`

            - `JsonValue type = "char_location"`

            - `String citedText`

            - `long documentIndex`

              minimum: 0

            - `Optional<String> documentTitle`

              minLength: 1, maxLength: 500

            - `long endCharIndex`

            - `long startCharIndex`

              minimum: 0

          - `class BetaCitationPageLocationParam`

            - `JsonValue type = "page_location"`

            - `String citedText`

            - `long documentIndex`

              minimum: 0

            - `Optional<String> documentTitle`

              minLength: 1, maxLength: 500

            - `long endPageNumber`

            - `long startPageNumber`

              minimum: 1

          - `class BetaCitationContentBlockLocationParam`

            - `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<String> 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 BetaCitationWebSearchResultLocationParam`

            - `JsonValue type = "web_search_result_location"`

            - `String citedText`

            - `String encryptedIndex`

            - `Optional<String> title`

              minLength: 1, maxLength: 512

            - `String url`

              minLength: 1

          - `class BetaCitationSearchResultLocationParam`

            - `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<String> title`

      - `class BetaImageBlockParam`

        - `JsonValue type = "image"`

        - `Source source`

          - `class BetaBase64ImageSource`

            - `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 BetaUrlImageSource`

            - `JsonValue type = "url"`

            - `String url`

          - `class BetaFileImageSource`

            - `JsonValue type = "file"`

            - `String fileId`

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<BetaImageTransformationsParam> 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> 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 BetaSearchResultBlockParam`

        - `JsonValue type = "search_result"`

        - `List<BetaTextBlockParam> content`

          - `JsonValue type = "text"`

          - `String text`

            minLength: 1

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<List<BetaTextCitationParam>> citations`

        - `String source`

        - `String title`

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<BetaCitationsConfigParam> citations`

          - `Optional<Boolean> enabled`

      - `class BetaRequestDocumentBlock`

        - `JsonValue type = "document"`

        - `Source source`

          - `class BetaBase64PdfSource`

            - `JsonValue type = "base64"`

            - `String data`

              format: byte

            - `JsonValue mediaType = "application/pdf"`

          - `class BetaPlainTextSource`

            - `JsonValue type = "text"`

            - `String data`

            - `JsonValue mediaType = "text/plain"`

          - `class BetaContentBlockSource`

            - `JsonValue type = "content"`

            - `Content content`

              - `String`

              - `List<BetaContentBlockSourceContent>`

                - `class BetaTextBlockParam`

                - `class BetaImageBlockParam`

          - `class BetaUrlPdfSource`

            - `JsonValue type = "url"`

            - `String url`

          - `class BetaFileDocumentSource`

            - `JsonValue type = "file"`

            - `String fileId`

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<BetaCitationsConfigParam> citations`

        - `Optional<String> context`

          minLength: 1

        - `Optional<String> title`

          minLength: 1, maxLength: 500

      - `class BetaToolReferenceBlockParam`

        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<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

      - `class BetaBrowserStateBlockParam`

        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<BetaBrowserStateTabEntry> 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<Boolean> active`

            Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<List<BetaBrowserStateChange>> 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 BetaBrowserStateChangeTabOpened`

            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 BetaBrowserStateChangeDownloadStarted`

            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 BetaBrowserStateChangeDownloadCompleted`

            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<String> 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<Long> sizeBytes`

              The completed download's size.

              minimum: 0

          - `class BetaBrowserStateChangeDownloadFailed`

            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<String> error`

              The failure or cancellation detail, when known.

              maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$

  - `Optional<Boolean> isError`

  - `Optional<String> toolsetName`

    For a toolset member tool_result, the toolset family of the paired tool_use.

    minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$

### Beta Tool Search Tool Bm25 20251119

- `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Tool Search Tool Regex 20251119

- `class BetaToolSearchToolRegex20251119`

  - `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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Tool Search Tool Result Block

- `class BetaToolSearchToolResultBlock`

  - `JsonValue type = "tool_search_tool_result"`

  - `Content content`

    - `class BetaToolSearchToolResultError`

      - `JsonValue type = "tool_search_tool_result_error"`

      - `ErrorCode errorCode`

        - `INVALID_TOOL_INPUT("invalid_tool_input")`

        - `UNAVAILABLE("unavailable")`

        - `TOO_MANY_REQUESTS("too_many_requests")`

        - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

      - `Optional<String> errorMessage`

    - `class BetaToolSearchToolSearchResultBlock`

      - `JsonValue type = "tool_search_tool_search_result"`

      - `List<BetaToolReferenceBlock> 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_]+$

### Beta Tool Search Tool Result Block Param

- `class BetaToolSearchToolResultBlockParam`

  - `JsonValue type = "tool_search_tool_result"`

  - `Content content`

    - `class BetaToolSearchToolResultErrorParam`

      - `JsonValue type = "tool_search_tool_result_error"`

      - `ErrorCode errorCode`

        - `INVALID_TOOL_INPUT("invalid_tool_input")`

        - `UNAVAILABLE("unavailable")`

        - `TOO_MANY_REQUESTS("too_many_requests")`

        - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

      - `Optional<String> errorMessage`

    - `class BetaToolSearchToolSearchResultBlockParam`

      - `JsonValue type = "tool_search_tool_search_result"`

      - `List<BetaToolReferenceBlockParam> toolReferences`

        - `JsonValue type = "tool_reference"`

        - `String toolName`

          minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

          - `JsonValue type = "ephemeral"`

          - `Optional<Ttl> 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<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

### Beta Tool Search Tool Result Error

- `class BetaToolSearchToolResultError`

  - `JsonValue type = "tool_search_tool_result_error"`

  - `ErrorCode errorCode`

    - `INVALID_TOOL_INPUT("invalid_tool_input")`

    - `UNAVAILABLE("unavailable")`

    - `TOO_MANY_REQUESTS("too_many_requests")`

    - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

  - `Optional<String> errorMessage`

### Beta Tool Search Tool Result Error Param

- `class BetaToolSearchToolResultErrorParam`

  - `JsonValue type = "tool_search_tool_result_error"`

  - `ErrorCode errorCode`

    - `INVALID_TOOL_INPUT("invalid_tool_input")`

    - `UNAVAILABLE("unavailable")`

    - `TOO_MANY_REQUESTS("too_many_requests")`

    - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

  - `Optional<String> errorMessage`

### Beta Tool Search Tool Search Result Block

- `class BetaToolSearchToolSearchResultBlock`

  - `JsonValue type = "tool_search_tool_search_result"`

  - `List<BetaToolReferenceBlock> toolReferences`

    - `JsonValue type = "tool_reference"`

    - `String toolName`

      minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$

### Beta Tool Search Tool Search Result Block Param

- `class BetaToolSearchToolSearchResultBlockParam`

  - `JsonValue type = "tool_search_tool_search_result"`

  - `List<BetaToolReferenceBlockParam> toolReferences`

    - `JsonValue type = "tool_reference"`

    - `String toolName`

      minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

      - `JsonValue type = "ephemeral"`

      - `Optional<Ttl> 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")`

### Beta Tool Text Editor 20241022

- `class BetaToolTextEditor20241022`

  - `JsonValue type = "text_editor_20241022"`

  - `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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<List<InputExample>> inputExamples`

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Tool Text Editor 20250124

- `class BetaToolTextEditor20250124`

  - `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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<List<InputExample>> inputExamples`

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Tool Text Editor 20250429

- `class BetaToolTextEditor20250429`

  - `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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<List<InputExample>> inputExamples`

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Tool Text Editor 20250728

- `class BetaToolTextEditor20250728`

  - `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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<List<InputExample>> inputExamples`

  - `Optional<Long> maxCharacters`

    Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

    minimum: 1

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

### Beta Tool Union

- `class BetaToolUnion: union`

  - `class BetaTool`

    - `Optional<Type> 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> properties`

      - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

      - `JsonValue type = "ephemeral"`

      - `Optional<Ttl> 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<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolBash20241022`

    - `JsonValue type = "bash_20241022"`

    - `JsonValue name = "bash"`

      Name of the tool.

      This is how the tool will be called by the model and in `tool_use` blocks.

    - `Optional<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolBash20250124`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaCodeExecutionTool20250522`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaCodeExecutionTool20250825`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaCodeExecutionTool20260120`

    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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaCodeExecutionTool20260521`

    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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaBrowserToolset20260801`

    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<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

        `type`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserCloseTabConfig> closeTab`

        `close_tab`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

        `double_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserFileUploadConfig> fileUpload`

        `file_upload`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserFindConfig> find`

        `find`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserFormInputConfig> formInput`

        `form_input`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserGetPageTextConfig> getPageText`

        `get_page_text`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserHoldKeyConfig> holdKey`

        `hold_key`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserHoverConfig> hover`

        `hover`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

        `javascript_exec`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserKeyConfig> key`

        `key`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserLeftClickConfig> leftClick`

        `left_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

        `left_click_drag`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

        `left_mouse_down`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

        `left_mouse_up`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserListTabsConfig> listTabs`

        `list_tabs`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserMiddleClickConfig> middleClick`

        `middle_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

        `mouse_move`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserNavigateConfig> navigate`

        `navigate`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserNewTabConfig> newTab`

        `new_tab`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserReadConsoleConfig> readConsole`

        `read_console`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

        `read_network`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserReadPageConfig> readPage`

        `read_page`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserRightClickConfig> rightClick`

        `right_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserScreenshotConfig> screenshot`

        `screenshot`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserScrollConfig> scroll`

        `scroll`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserScrollToConfig> scrollTo`

        `scroll_to`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserSwitchTabConfig> switchTab`

        `switch_tab`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserTripleClickConfig> tripleClick`

        `triple_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserWaitConfig> wait`

        `wait`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaBrowserZoomConfig> zoom`

        `zoom`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered 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 BetaToolComputerUse20241022`

    - `JsonValue type = "computer_20241022"`

    - `long displayHeightPx`

      The height of the display in pixels.

      minimum: 1

    - `long displayWidthPx`

      The width of the display in pixels.

      minimum: 1

    - `JsonValue name = "computer"`

      Name of the tool.

      This is how the tool will be called by the model and in `tool_use` blocks.

    - `Optional<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> displayNumber`

      The X11 display number (e.g. 0, 1) for the display.

      minimum: 0

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaMemoryTool20250818`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolComputerUse20250124`

    - `JsonValue type = "computer_20250124"`

    - `long displayHeightPx`

      The height of the display in pixels.

      minimum: 1

    - `long displayWidthPx`

      The width of the display in pixels.

      minimum: 1

    - `JsonValue name = "computer"`

      Name of the tool.

      This is how the tool will be called by the model and in `tool_use` blocks.

    - `Optional<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> displayNumber`

      The X11 display number (e.g. 0, 1) for the display.

      minimum: 0

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolTextEditor20241022`

    - `JsonValue type = "text_editor_20241022"`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolComputerUse20251124`

    - `JsonValue type = "computer_20251124"`

    - `long displayHeightPx`

      The height of the display in pixels.

      minimum: 1

    - `long displayWidthPx`

      The width of the display in pixels.

      minimum: 1

    - `JsonValue name = "computer"`

      Name of the tool.

      This is how the tool will be called by the model and in `tool_use` blocks.

    - `Optional<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> displayNumber`

      The X11 display number (e.g. 0, 1) for the display.

      minimum: 0

    - `Optional<Boolean> enableZoom`

      Whether to enable an action to take a zoomed-in screenshot of the screen.

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaComputerToolset20260801`

    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<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

        `type`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

        `cursor_position`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerDoubleClickConfig> doubleClick`

        `double_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerHoldKeyConfig> holdKey`

        `hold_key`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerKeyConfig> key`

        `key`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerLeftClickConfig> leftClick`

        `left_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

        `left_click_drag`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

        `left_mouse_down`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

        `left_mouse_up`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerMiddleClickConfig> middleClick`

        `middle_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerMouseMoveConfig> mouseMove`

        `mouse_move`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerRightClickConfig> rightClick`

        `right_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerScreenshotConfig> screenshot`

        `screenshot`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerScrollConfig> scroll`

        `scroll`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerTripleClickConfig> tripleClick`

        `triple_click`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerWaitConfig> wait`

        `wait`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

      - `Optional<BetaComputerZoomConfig> zoom`

        `zoom`'s config overrides.

        - `Optional<Boolean> deferLoading`

          Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

        - `Optional<Boolean> enabled`

          Whether this member is offered 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 BetaToolTextEditor20250124`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolTextEditor20250429`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolTextEditor20250728`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<List<InputExample>> inputExamples`

    - `Optional<Long> maxCharacters`

      Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

      minimum: 1

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaWebSearchTool20250305`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<List<String>> allowedDomains`

      If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

    - `Optional<List<String>> blockedDomains`

      If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> maxUses`

      Maximum number of times the tool can be used in the API request.

      minimum: 1

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

    - `Optional<BetaUserLocation> userLocation`

      Parameters for the user's location. Used to provide more relevant search results.

      - `JsonValue type = "approximate"`

      - `Optional<String> city`

        The city of the user.

        minLength: 1, maxLength: 255

      - `Optional<String> 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<String> region`

        The region of the user.

        minLength: 1, maxLength: 255

      - `Optional<String> timezone`

        The [IANA timezone](https://nodatime.org/TimeZones) of the user.

        minLength: 1, maxLength: 255

  - `class BetaWebFetchTool20250910`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<List<String>> allowedDomains`

      List of domains to allow fetching from

    - `Optional<List<String>> blockedDomains`

      List of domains to block fetching from

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaCitationsConfigParam> citations`

      Citations configuration for fetched documents. Citations are disabled by default.

      - `Optional<Boolean> enabled`

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> 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<Long> maxUses`

      Maximum number of times the tool can be used in the API request.

      minimum: 1

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

    - `Optional<BetaWebFetchUrlSources> urlSources`

      Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

      - `Optional<ClientToolResults> clientToolResults`

        Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

        - `class BetaWebFetchUrlSourceAll`

          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 BetaWebFetchUrlSourceNone`

          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 BetaWebFetchUrlSourceOnly`

          The tool filter variant under which only the named tools' results
          contribute.

          - `JsonValue type = "only"`

          - `List<BetaWebFetchUrlSourceToolReference> tools`

            - `JsonValue type = "tool_reference"`

            - `String name`

        - `class BetaWebFetchUrlSourceExcept`

          The tool filter variant under which every result but the named
          tools' contributes.

          - `JsonValue type = "except"`

          - `List<BetaWebFetchUrlSourceToolReference> tools`

            - `JsonValue type = "tool_reference"`

            - `String name`

      - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

          The `url_sources` variant under which a source contributes in
          full: every result of the tool filter's source, or all user input.

        - `class BetaWebFetchUrlSourceNone`

          The `url_sources` variant under which a source contributes nothing:
          no result of the tool filter's source, or no user input.

        - `class BetaWebFetchUrlSourceOnly`

          The tool filter variant under which only the named tools' results
          contribute.

        - `class BetaWebFetchUrlSourceExcept`

          The tool filter variant under which every result but the named
          tools' contributes.

      - `Optional<UserInput> userInput`

        Whether URLs in user messages are fetchable: "all" or "none".

        - `class BetaWebFetchUrlSourceAll`

          The `url_sources` variant under which a source contributes in
          full: every result of the tool filter's source, or all user input.

        - `class BetaWebFetchUrlSourceNone`

          The `url_sources` variant under which a source contributes nothing:
          no result of the tool filter's source, or no user input.

  - `class BetaWebSearchTool20260209`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<List<String>> allowedDomains`

      If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

    - `Optional<List<String>> blockedDomains`

      If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> maxUses`

      Maximum number of times the tool can be used in the API request.

      minimum: 1

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

    - `Optional<BetaUserLocation> userLocation`

      Parameters for the user's location. Used to provide more relevant search results.

  - `class BetaWebFetchTool20260209`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<List<String>> allowedDomains`

      List of domains to allow fetching from

    - `Optional<List<String>> blockedDomains`

      List of domains to block fetching from

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaCitationsConfigParam> citations`

      Citations configuration for fetched documents. Citations are disabled by default.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> 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<Long> maxUses`

      Maximum number of times the tool can be used in the API request.

      minimum: 1

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

    - `Optional<BetaWebFetchUrlSources> urlSources`

      Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

  - `class BetaWebFetchTool20260309`

    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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<List<String>> allowedDomains`

      List of domains to allow fetching from

    - `Optional<List<String>> blockedDomains`

      List of domains to block fetching from

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaCitationsConfigParam> citations`

      Citations configuration for fetched documents. Citations are disabled by default.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> 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<Long> maxUses`

      Maximum number of times the tool can be used in the API request.

      minimum: 1

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

    - `Optional<BetaWebFetchUrlSources> urlSources`

      Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

    - `Optional<Boolean> 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 BetaWebSearchTool20260318`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<List<String>> allowedDomains`

      If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

    - `Optional<List<String>> blockedDomains`

      If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> maxUses`

      Maximum number of times the tool can be used in the API request.

      minimum: 1

    - `Optional<ResponseInclusion> 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<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

    - `Optional<BetaUserLocation> userLocation`

      Parameters for the user's location. Used to provide more relevant search results.

  - `class BetaWebFetchTool20260318`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<List<String>> allowedDomains`

      List of domains to allow fetching from

    - `Optional<List<String>> blockedDomains`

      List of domains to block fetching from

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaCitationsConfigParam> citations`

      Citations configuration for fetched documents. Citations are disabled by default.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> 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<Long> maxUses`

      Maximum number of times the tool can be used in the API request.

      minimum: 1

    - `Optional<ResponseInclusion> 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<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

    - `Optional<BetaWebFetchUrlSources> urlSources`

      Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

    - `Optional<Boolean> 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 BetaAdvisorTool20260301`

    - `JsonValue type = "advisor_20260301"`

    - `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 name = "advisor"`

      Name of the tool.

      This is how the tool will be called by the model and in `tool_use` blocks.

    - `Optional<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaCacheControlEphemeral> caching`

      Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Long> maxTokens`

      Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

      minimum: 1024

    - `Optional<Long> maxUses`

      Maximum number of times the tool can be used in the API request.

      minimum: 1

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaToolSearchToolRegex20251119`

    - `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<List<AllowedCaller>> allowedCallers`

      - `DIRECT("direct")`

      - `CODE_EXECUTION_20250825("code_execution_20250825")`

      - `CODE_EXECUTION_20260120("code_execution_20260120")`

      - `CODE_EXECUTION_20260521("code_execution_20260521")`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Boolean> deferLoading`

      If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

    - `Optional<Boolean> strict`

      When true, guarantees schema validation on tool names and inputs

  - `class BetaMcpToolset`

    Configuration for a group of tools from an MCP server.

    Allows configuring enabled status and defer_loading for all tools
    from an MCP server, with optional per-tool overrides.

    - `JsonValue type = "mcp_toolset"`

    - `String mcpServerName`

      Name of the MCP server to configure tools for

      minLength: 1, maxLength: 255

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<Configs> configs`

      Configuration overrides for specific tools, keyed by tool name

      - `Optional<Boolean> deferLoading`

      - `Optional<Boolean> enabled`

    - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

      Default configuration applied to all tools from this server

      - `Optional<Boolean> deferLoading`

      - `Optional<Boolean> enabled`

    - `Optional<List<BetaMcpToolParam>> tools`

      The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

      - `InputSchema inputSchema`

        The tool's input schema as the MCP server lists it, verbatim.

      - `String name`

        The tool's name as the MCP server lists it (not prefixed with the server name).

        minLength: 1

      - `Optional<String> description`

        The tool's description as the MCP server lists it.

### Beta Tool Use Block

- `class BetaToolUseBlock`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `Input input`

  - `String name`

    minLength: 1

  - `Optional<Caller> caller`

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `Optional<String> toolsetName`

    For a toolset member tool_use, the toolset family.

    minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$

### Beta Tool Use Block Param

- `class BetaToolUseBlockParam`

  - `JsonValue type = "tool_use"`

  - `String id`

    pattern: ^[a-zA-Z0-9_-]+$

  - `Input input`

  - `String name`

    minLength: 1, maxLength: 200

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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> caller`

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `Optional<String> toolsetName`

    For a toolset member tool_use, the toolset family this member belongs to.

    minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$

### Beta Tool Use Caller

- `class BetaToolUseCaller: union`

  Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaDirectCaller`

    Tool invocation directly from the model.

    - `JsonValue type = "direct"`

  - `class BetaServerToolCaller`

    Tool invocation generated by a server-side tool.

    - `JsonValue type = "code_execution_20250825"`

    - `String toolId`

      pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `class BetaServerToolCaller20260120`

    - `JsonValue type = "code_execution_20260120"`

    - `String toolId`

      pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Tool Uses Keep

- `class BetaToolUsesKeep`

  - `JsonValue type = "tool_uses"`

  - `long value`

    minimum: 0

### Beta Tool Uses Trigger

- `class BetaToolUsesTrigger`

  - `JsonValue type = "tool_uses"`

  - `long value`

    minimum: 1

### Beta Toolset Tool Use Block

- `class BetaToolsetToolUseBlock: union`

  - `class BetaBrowserToolUseBlock: union`

    - `class BetaBrowserNavigateToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserNavigateInput 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<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "navigate"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

        - `class BetaDirectCaller`

          Tool invocation directly from the model.

          - `JsonValue type = "direct"`

        - `class BetaServerToolCaller`

          Tool invocation generated by a server-side tool.

          - `JsonValue type = "code_execution_20250825"`

          - `String toolId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

        - `class BetaServerToolCaller20260120`

          - `JsonValue type = "code_execution_20260120"`

          - `String toolId`

            pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaBrowserListTabsToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserListTabsInput input`

        List all open tabs with each tab's tab_id, title, and URL.

      - `JsonValue name = "list_tabs"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserNewTabToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserNewTabInput input`

        Open a new empty tab and return its tab_id.

      - `JsonValue name = "new_tab"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserSwitchTabToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserSwitchTabInput 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"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserCloseTabToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserCloseTabInput input`

        Close the tab with the given tab_id.

        - `String tabId`

          The tab to close.

      - `JsonValue name = "close_tab"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserReadPageToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserReadPageInput 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<Long> depth`

          Maximum tree depth. Default 15.

          minimum: 1

        - `Optional<BetaBrowserReadPageFilter> filter`

          Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements.

          - `ALL("all")`

          - `INTERACTIVE("interactive")`

        - `Optional<String> ref`

          Element reference to read a subtree from. Omit to read from the page root.

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "read_page"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserGetPageTextToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserGetPageTextInput input`

        Return the page's visible text content as plain text, prioritizing article
        content. Suited to articles, documentation, and other text-heavy pages.

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "get_page_text"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserReadConsoleToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserReadConsoleInput 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<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "read_console"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserReadNetworkToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserReadNetworkInput 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<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "read_network"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserFindToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserFindInput 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<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "find"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserFormInputToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserFormInputInput input`

        Set the value of a form element (input, textarea, select, checkbox). Use a
        boolean for checkboxes, an option value or text for selects.

        - `BetaBrowserRefTarget 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.

        - `BetaBrowserFormInputValue value`

          The value to set.

          - `String`

          - `double`

          - `boolean`

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "form_input"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserFileUploadToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserFileUploadInput 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.

        - `BetaBrowserRefTarget 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<List<String>> documentIds`

          References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem.

          minItems: 1

        - `Optional<List<String>> paths`

          File paths on the browser executor's filesystem.

          minItems: 1

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "file_upload"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserScrollToToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserScrollToInput input`

        Scroll an element into view.

        - `BetaBrowserRefTarget 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<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "scroll_to"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserScreenshotToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserScreenshotInput input`

        Capture the current browser viewport.

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "screenshot"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserZoomToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserZoomInput 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<long> region`

          [x0, y0, x1, y1] in viewport pixels.

          minItems: 4, maxItems: 4

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "zoom"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserLeftClickToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserLeftClickInput input`

        Left-click at a viewport coordinate or on an element by reference.

        - `BetaBrowserClickTarget target`

          Where to act: either a viewport coordinate or an element reference.

          - `class BetaBrowserCoordinateTarget`

            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 BetaBrowserRefTarget`

            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<String> modifiers`

          Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "left_click"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserRightClickToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserRightClickInput input`

        Right-click at a viewport coordinate or on an element by reference.

        - `BetaBrowserClickTarget target`

          Where to act: either a viewport coordinate or an element reference.

        - `Optional<String> modifiers`

          Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "right_click"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserMiddleClickToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserMiddleClickInput input`

        Middle-click at a viewport coordinate or on an element by reference.

        - `BetaBrowserClickTarget target`

          Where to act: either a viewport coordinate or an element reference.

        - `Optional<String> modifiers`

          Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "middle_click"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserDoubleClickToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserDoubleClickInput input`

        Double left-click at a viewport coordinate or on an element by reference.

        - `BetaBrowserClickTarget target`

          Where to act: either a viewport coordinate or an element reference.

        - `Optional<String> modifiers`

          Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "double_click"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserTripleClickToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserTripleClickInput input`

        Triple left-click at a viewport coordinate or on an element by reference
        (typically selects a line or paragraph).

        - `BetaBrowserClickTarget target`

          Where to act: either a viewport coordinate or an element reference.

        - `Optional<String> modifiers`

          Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "triple_click"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserHoverToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserHoverInput input`

        Move the cursor to a coordinate or element without clicking.

        - `BetaBrowserClickTarget target`

          Where to act: either a viewport coordinate or an element reference.

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "hover"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserLeftClickDragToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserLeftClickDragInput input`

        Press at `from`, drag to `target`, release. Both must be coordinate targets.

        - `BetaBrowserCoordinateTarget from`

          A point in the browser viewport, in viewport pixels (the same frame as a
          full-viewport screenshot).

        - `BetaBrowserCoordinateTarget target`

          A point in the browser viewport, in viewport pixels (the same frame as a
          full-viewport screenshot).

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "left_click_drag"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserLeftMouseDownToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserLeftMouseDownInput input`

        Press and hold the left mouse button at a viewport coordinate. Pair with
        left_mouse_up to perform a custom drag.

        - `BetaBrowserCoordinateTarget target`

          A point in the browser viewport, in viewport pixels (the same frame as a
          full-viewport screenshot).

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "left_mouse_down"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserLeftMouseUpToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserLeftMouseUpInput input`

        Release the left mouse button at a viewport coordinate.

        - `BetaBrowserCoordinateTarget target`

          A point in the browser viewport, in viewport pixels (the same frame as a
          full-viewport screenshot).

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "left_mouse_up"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserMouseMoveToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserMouseMoveInput input`

        Move the pointer to a viewport coordinate without clicking.

        - `BetaBrowserCoordinateTarget target`

          A point in the browser viewport, in viewport pixels (the same frame as a
          full-viewport screenshot).

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "mouse_move"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserScrollToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserScrollInput input`

        Scroll at a viewport position. `target` must be a coordinate target.

        - `BetaBrowserScrollDirection scrollDirection`

          - `UP("up")`

          - `DOWN("down")`

          - `LEFT("left")`

          - `RIGHT("right")`

        - `BetaBrowserCoordinateTarget target`

          A point in the browser viewport, in viewport pixels (the same frame as a
          full-viewport screenshot).

        - `Optional<Long> scrollAmount`

          Scroll-wheel notches (1–10). Default 3.

          minimum: 1, maximum: 10

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "scroll"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserTypeToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserTypeInput input`

        Type a literal string at the current focus.

        - `String text`

          The text to type.

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "type"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserKeyToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserKeyInput 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<Long> repeat`

          Number of times to repeat. Default 1.

          minimum: 1, maximum: 100

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "key"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserHoldKeyToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserHoldKeyInput 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<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "hold_key"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserWaitToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserWaitInput input`

        Pause for the given duration.

        - `double duration`

          Seconds to wait (maximum 30).

          minimum: 0, maximum: 30

        - `Optional<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "wait"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaBrowserJavascriptExecToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaBrowserJavascriptExecInput 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<String> tabId`

          Tab to act on. Defaults to the active tab when omitted.

      - `JsonValue name = "javascript_exec"`

      - `JsonValue toolsetName = "browser"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaComputerToolUseBlock: union`

    - `class BetaComputerKeyToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerKeyInput 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<Long> repeat`

          Number of times to repeat the key press. Default is 1.

          minimum: 1, maximum: 100

      - `JsonValue name = "key"`

      - `JsonValue toolsetName = "computer"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaComputerHoldKeyToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerHoldKeyInput 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"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaComputerTypeToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerTypeInput input`

        Type a string of text on the keyboard.

        - `String text`

          The text to type.

      - `JsonValue name = "type"`

      - `JsonValue toolsetName = "computer"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaComputerCursorPositionToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerCursorPositionInput input`

        Get the current (x, y) pixel coordinate of the cursor.

      - `JsonValue name = "cursor_position"`

      - `JsonValue toolsetName = "computer"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaComputerMouseMoveToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerMouseMoveInput 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<long> 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"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaComputerLeftMouseDownToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerLeftMouseDownInput input`

        Press and hold the left mouse button at the current cursor position.

      - `JsonValue name = "left_mouse_down"`

      - `JsonValue toolsetName = "computer"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaComputerLeftMouseUpToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerLeftMouseUpInput input`

        Release the left mouse button.

      - `JsonValue name = "left_mouse_up"`

      - `JsonValue toolsetName = "computer"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaComputerLeftClickToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerLeftClickInput input`

        Click the left mouse button at the specified (x, y) pixel coordinate, or the
        current cursor position if `coordinate` is omitted.

        - `Optional<List<Long>> coordinate`

          (x, y): x pixels from the left edge, y pixels from the top edge.

          minItems: 2, maxItems: 2

        - `Optional<String> text`

          Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

      - `JsonValue name = "left_click"`

      - `JsonValue toolsetName = "computer"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaComputerLeftClickDragToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerLeftClickDragInput input`

        Click and drag the cursor from `start_coordinate` to `coordinate`.

        - `List<long> coordinate`

          (x, y): x pixels from the left edge, y pixels from the top edge.

          minItems: 2, maxItems: 2

        - `List<long> startCoordinate`

          (x, y): x pixels from the left edge, y pixels from the top edge.

          minItems: 2, maxItems: 2

        - `Optional<String> text`

          Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

      - `JsonValue name = "left_click_drag"`

      - `JsonValue toolsetName = "computer"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaComputerRightClickToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerRightClickInput input`

        Click the right mouse button at the specified (x, y) pixel coordinate, or the
        current cursor position if `coordinate` is omitted.

        - `Optional<List<Long>> coordinate`

          (x, y): x pixels from the left edge, y pixels from the top edge.

          minItems: 2, maxItems: 2

        - `Optional<String> text`

          Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

      - `JsonValue name = "right_click"`

      - `JsonValue toolsetName = "computer"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaComputerMiddleClickToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerMiddleClickInput input`

        Click the middle mouse button at the specified (x, y) pixel coordinate, or the
        current cursor position if `coordinate` is omitted.

        - `Optional<List<Long>> coordinate`

          (x, y): x pixels from the left edge, y pixels from the top edge.

          minItems: 2, maxItems: 2

        - `Optional<String> text`

          Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

      - `JsonValue name = "middle_click"`

      - `JsonValue toolsetName = "computer"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaComputerDoubleClickToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerDoubleClickInput input`

        Double-click the left mouse button at the specified (x, y) pixel coordinate, or
        the current cursor position if `coordinate` is omitted.

        - `Optional<List<Long>> coordinate`

          (x, y): x pixels from the left edge, y pixels from the top edge.

          minItems: 2, maxItems: 2

        - `Optional<String> text`

          Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

      - `JsonValue name = "double_click"`

      - `JsonValue toolsetName = "computer"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaComputerTripleClickToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerTripleClickInput input`

        Triple-click the left mouse button at the specified (x, y) pixel coordinate, or
        the current cursor position if `coordinate` is omitted.

        - `Optional<List<Long>> coordinate`

          (x, y): x pixels from the left edge, y pixels from the top edge.

          minItems: 2, maxItems: 2

        - `Optional<String> text`

          Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

      - `JsonValue name = "triple_click"`

      - `JsonValue toolsetName = "computer"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaComputerScrollToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerScrollInput 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.

        - `BetaComputerScrollDirection scrollDirection`

          - `UP("up")`

          - `DOWN("down")`

          - `LEFT("left")`

          - `RIGHT("right")`

        - `Optional<List<Long>> coordinate`

          (x, y): x pixels from the left edge, y pixels from the top edge.

          minItems: 2, maxItems: 2

        - `Optional<String> text`

          Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").

      - `JsonValue name = "scroll"`

      - `JsonValue toolsetName = "computer"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaComputerWaitToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerWaitInput input`

        Wait for a specified duration.

        - `long duration`

          Duration to wait, in seconds.

          maximum: 300

      - `JsonValue name = "wait"`

      - `JsonValue toolsetName = "computer"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaComputerScreenshotToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerScreenshotInput input`

        Take a screenshot of the screen.

      - `JsonValue name = "screenshot"`

      - `JsonValue toolsetName = "computer"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

    - `class BetaComputerZoomToolUseBlock`

      - `JsonValue type = "tool_use"`

      - `String id`

        pattern: ^[a-zA-Z0-9_-]+$

      - `BetaComputerZoomInput 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<long> region`

          (x0, y0, x1, y1): The region to capture.

          minItems: 4, maxItems: 4

      - `JsonValue name = "zoom"`

      - `JsonValue toolsetName = "computer"`

      - `Optional<BetaToolUseCaller> caller`

        Which party invoked the tool call: the model directly, or a server tool on its behalf.

  - `class BetaToolUseBlock`

    - `JsonValue type = "tool_use"`

    - `String id`

      pattern: ^[a-zA-Z0-9_-]+$

    - `Input input`

    - `String name`

      minLength: 1

    - `Optional<Caller> caller`

      - `class BetaDirectCaller`

        Tool invocation directly from the model.

      - `class BetaServerToolCaller`

        Tool invocation generated by a server-side tool.

      - `class BetaServerToolCaller20260120`

    - `Optional<String> toolsetName`

      For a toolset member tool_use, the toolset family.

      minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$

### Beta URL Image Source

- `class BetaUrlImageSource`

  - `JsonValue type = "url"`

  - `String url`

### Beta URL PDF Source

- `class BetaUrlPdfSource`

  - `JsonValue type = "url"`

  - `String url`

### Beta Usage

- `class BetaUsage`

  - `Optional<BetaCacheCreation> 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<Long> cacheCreationInputTokens`

    The number of input tokens used to create the cache entry.

    minimum: 0

  - `Optional<Long> cacheReadInputTokens`

    The number of input tokens read from the cache.

    minimum: 0

  - `Optional<BetaFallbackCreditUsage> fallbackCredit`

    Outcome of the `fallback_credit_token` presented on this request.

    Present on every response to a non-batch request that carried a
    `fallback_credit_token`, in either redemption mode; absent otherwise (batch
    items accept and ignore the token and carry no outcome object).

    - `Status status`

      Whether the fallback-credit reprice was applied to this response's billing.

      A union discriminated on `type`. `redeemed`: the retry is billed as if
      the conversation had been on the retry model all along — including when the
      resulting shift is zero because there was nothing to move. `not_applied`:
      no reprice was applied; the arm's `reason` says why.

      - `class BetaFallbackCreditRedeemed`

        The reprice was applied: the retry is billed as if the conversation
        had been on the retry model all along.

        - `JsonValue type = "redeemed"`

      - `class BetaFallbackCreditNotApplied`

        No reprice was applied; `reason` says why.

        - `JsonValue type = "not_applied"`

        - `Reason reason`

          Why the reprice was not applied.

          A closed enum; additions to the redemption-check vocabulary arrive as
          deliberate schema updates.

          - `BODY_MISMATCH("body_mismatch")`

          - `CONTINUATION_EXCLUDED("continuation_excluded")`

          - `CONTINUATION_ONLY("continuation_only")`

          - `EXPIRED("expired")`

          - `INVALID_TARGET_MODEL("invalid_target_model")`

          - `NOT_ENABLED("not_enabled")`

          - `REPRICE_UNAVAILABLE("reprice_unavailable")`

          - `TEMPORARILY_UNAVAILABLE("temporarily_unavailable")`

          - `VARIANT_FIELDS_PRESENT("variant_fields_present")`

          - `WRONG_ORGANIZATION("wrong_organization")`

          - `WRONG_PLATFORM("wrong_platform")`

          - `WRONG_WORKSPACE("wrong_workspace")`

        - `Optional<List<String>> removeToRedeem`

          Request fields to remove before retrying, so the retry can redeem this
          token.

          Present exactly when `reason` is `variant_fields_present` — never null,
          never an empty array; absent otherwise. Fields are named only from your own request, and only after
          the sealed variant hash matched. A served best-effort retry has already
          been billed at normal price; nothing redeems retroactively, but a corrected
          re-send inside the token's five-minute window can still redeem.

  - `Optional<String> inferenceGeo`

    The geographic region where inference was performed for this request.

  - `long inputTokens`

    The number of input tokens which were used.

    minimum: 0

  - `Optional<List<Iteration>> iterations`

    Per-iteration token usage breakdown.

    Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to:

    - Calculate the context window size from the last `message` entry
    - Understand token accumulation across server-side tool use loops

    A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results.

    - `class BetaMessageIterationUsage`

      Token usage for a sampling iteration.

      - `JsonValue type = "message"`

        Usage for a sampling iteration

      - `Optional<BetaCacheCreation> cacheCreation`

        Breakdown of cached tokens by TTL

      - `long cacheCreationInputTokens`

        The number of input tokens used to create the cache entry.

        minimum: 0

      - `long cacheReadInputTokens`

        The number of input tokens read from the cache.

        minimum: 0

      - `long inputTokens`

        The number of input tokens which were used.

        minimum: 0

      - `Optional<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

      - `long outputTokens`

        The number of output tokens which were used.

        minimum: 0

    - `class BetaCompactionIterationUsage`

      Token usage for a compaction iteration.

      - `JsonValue type = "compaction"`

        Usage for a compaction iteration

      - `Optional<BetaCacheCreation> cacheCreation`

        Breakdown of cached tokens by TTL

      - `long cacheCreationInputTokens`

        The number of input tokens used to create the cache entry.

        minimum: 0

      - `long cacheReadInputTokens`

        The number of input tokens read from the cache.

        minimum: 0

      - `long inputTokens`

        The number of input tokens which were used.

        minimum: 0

      - `long outputTokens`

        The number of output tokens which were used.

        minimum: 0

    - `class BetaAdvisorMessageIterationUsage`

      Token usage for an advisor sub-inference iteration.

      - `JsonValue type = "advisor_message"`

        Usage for an advisor sub-inference iteration

      - `Optional<BetaCacheCreation> cacheCreation`

        Breakdown of cached tokens by TTL

      - `long cacheCreationInputTokens`

        The number of input tokens used to create the cache entry.

        minimum: 0

      - `long cacheReadInputTokens`

        The number of input tokens read from the cache.

        minimum: 0

      - `long inputTokens`

        The number of input tokens which were used.

        minimum: 0

      - `Model model`

        The model that will complete your prompt.

        See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

      - `long outputTokens`

        The number of output tokens which were used.

        minimum: 0

    - `class BetaFallbackMessageIterationUsage`

      Token usage for the fallback-model attempt of a server-side fallback request.

      The terminal entry of a fallback-served turn: when a fallback hop's
      output is the returned message, the entry for the iteration that
      completed it carries this type in place of `message`. A declined hop
      and the serving hop's earlier tool-loop iterations produce `message`
      entries. Whether a fallback model served the response is signalled by
      the presence of this entry in `usage.iterations`.

      - `JsonValue type = "fallback_message"`

        Usage for the fallback-model attempt that served the response

      - `Optional<BetaCacheCreation> cacheCreation`

        Breakdown of cached tokens by TTL

      - `long cacheCreationInputTokens`

        The number of input tokens used to create the cache entry.

        minimum: 0

      - `long cacheReadInputTokens`

        The number of input tokens read from the cache.

        minimum: 0

      - `long inputTokens`

        The number of input tokens which were used.

        minimum: 0

      - `Model model`

        The model that will complete your prompt.

        See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

      - `long outputTokens`

        The number of output tokens which were used.

        minimum: 0

  - `long outputTokens`

    The number of output tokens which were used.

    minimum: 0

  - `Optional<BetaOutputTokensDetails> 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<BetaServerToolUsage> 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> serviceTier`

    If the request used the priority, standard, or batch tier.

    - `STANDARD("standard")`

    - `PRIORITY("priority")`

    - `BATCH("batch")`

  - `Optional<Speed> speed`

    The inference speed mode used for this request.

    - `STANDARD("standard")`

    - `FAST("fast")`

### Beta User Location

- `class BetaUserLocation`

  - `JsonValue type = "approximate"`

  - `Optional<String> city`

    The city of the user.

    minLength: 1, maxLength: 255

  - `Optional<String> 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<String> region`

    The region of the user.

    minLength: 1, maxLength: 255

  - `Optional<String> timezone`

    The [IANA timezone](https://nodatime.org/TimeZones) of the user.

    minLength: 1, maxLength: 255

### Beta Web Fetch Block

- `class BetaWebFetchBlock`

  - `JsonValue type = "web_fetch_result"`

  - `BetaDocumentBlock content`

    - `JsonValue type = "document"`

    - `Optional<BetaCitationConfig> citations`

      Citation configuration for the document

      - `boolean enabled`

    - `Source source`

      - `class BetaBase64PdfSource`

        - `JsonValue type = "base64"`

        - `String data`

          format: byte

        - `JsonValue mediaType = "application/pdf"`

      - `class BetaPlainTextSource`

        - `JsonValue type = "text"`

        - `String data`

        - `JsonValue mediaType = "text/plain"`

    - `Optional<String> title`

      The title of the document

  - `Optional<String> retrievedAt`

    ISO 8601 timestamp when the content was retrieved

  - `String url`

    Fetched content URL

### Beta Web Fetch Block Param

- `class BetaWebFetchBlockParam`

  - `JsonValue type = "web_fetch_result"`

  - `BetaRequestDocumentBlock content`

    - `JsonValue type = "document"`

    - `Source source`

      - `class BetaBase64PdfSource`

        - `JsonValue type = "base64"`

        - `String data`

          format: byte

        - `JsonValue mediaType = "application/pdf"`

      - `class BetaPlainTextSource`

        - `JsonValue type = "text"`

        - `String data`

        - `JsonValue mediaType = "text/plain"`

      - `class BetaContentBlockSource`

        - `JsonValue type = "content"`

        - `Content content`

          - `String`

          - `List<BetaContentBlockSourceContent>`

            - `class BetaTextBlockParam`

              - `JsonValue type = "text"`

              - `String text`

                minLength: 1

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

                - `JsonValue type = "ephemeral"`

                - `Optional<Ttl> 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<List<BetaTextCitationParam>> citations`

                - `class BetaCitationCharLocationParam`

                  - `JsonValue type = "char_location"`

                  - `String citedText`

                  - `long documentIndex`

                    minimum: 0

                  - `Optional<String> documentTitle`

                    minLength: 1, maxLength: 500

                  - `long endCharIndex`

                  - `long startCharIndex`

                    minimum: 0

                - `class BetaCitationPageLocationParam`

                  - `JsonValue type = "page_location"`

                  - `String citedText`

                  - `long documentIndex`

                    minimum: 0

                  - `Optional<String> documentTitle`

                    minLength: 1, maxLength: 500

                  - `long endPageNumber`

                  - `long startPageNumber`

                    minimum: 1

                - `class BetaCitationContentBlockLocationParam`

                  - `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<String> 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 BetaCitationWebSearchResultLocationParam`

                  - `JsonValue type = "web_search_result_location"`

                  - `String citedText`

                  - `String encryptedIndex`

                  - `Optional<String> title`

                    minLength: 1, maxLength: 512

                  - `String url`

                    minLength: 1

                - `class BetaCitationSearchResultLocationParam`

                  - `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<String> title`

            - `class BetaImageBlockParam`

              - `JsonValue type = "image"`

              - `Source source`

                - `class BetaBase64ImageSource`

                  - `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 BetaUrlImageSource`

                  - `JsonValue type = "url"`

                  - `String url`

                - `class BetaFileImageSource`

                  - `JsonValue type = "file"`

                  - `String fileId`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaImageTransformationsParam> 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> 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 BetaUrlPdfSource`

        - `JsonValue type = "url"`

        - `String url`

      - `class BetaFileDocumentSource`

        - `JsonValue type = "file"`

        - `String fileId`

    - `Optional<BetaCacheControlEphemeral> cacheControl`

      Create a cache control breakpoint at this content block.

    - `Optional<BetaCitationsConfigParam> citations`

      - `Optional<Boolean> enabled`

    - `Optional<String> context`

      minLength: 1

    - `Optional<String> title`

      minLength: 1, maxLength: 500

  - `String url`

    Fetched content URL

  - `Optional<String> retrievedAt`

    ISO 8601 timestamp when the content was retrieved

### Beta Web Fetch Tool 20250910

- `class BetaWebFetchTool20250910`

  - `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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<List<String>> allowedDomains`

    List of domains to allow fetching from

  - `Optional<List<String>> blockedDomains`

    List of domains to block fetching from

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<BetaCitationsConfigParam> citations`

    Citations configuration for fetched documents. Citations are disabled by default.

    - `Optional<Boolean> enabled`

  - `Optional<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Long> 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<Long> maxUses`

    Maximum number of times the tool can be used in the API request.

    minimum: 1

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

  - `Optional<BetaWebFetchUrlSources> urlSources`

    Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

    - `Optional<ClientToolResults> clientToolResults`

      Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

      - `class BetaWebFetchUrlSourceAll`

        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 BetaWebFetchUrlSourceNone`

        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 BetaWebFetchUrlSourceOnly`

        The tool filter variant under which only the named tools' results
        contribute.

        - `JsonValue type = "only"`

        - `List<BetaWebFetchUrlSourceToolReference> tools`

          - `JsonValue type = "tool_reference"`

          - `String name`

      - `class BetaWebFetchUrlSourceExcept`

        The tool filter variant under which every result but the named
        tools' contributes.

        - `JsonValue type = "except"`

        - `List<BetaWebFetchUrlSourceToolReference> tools`

          - `JsonValue type = "tool_reference"`

          - `String name`

    - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

        The `url_sources` variant under which a source contributes in
        full: every result of the tool filter's source, or all user input.

      - `class BetaWebFetchUrlSourceNone`

        The `url_sources` variant under which a source contributes nothing:
        no result of the tool filter's source, or no user input.

      - `class BetaWebFetchUrlSourceOnly`

        The tool filter variant under which only the named tools' results
        contribute.

      - `class BetaWebFetchUrlSourceExcept`

        The tool filter variant under which every result but the named
        tools' contributes.

    - `Optional<UserInput> userInput`

      Whether URLs in user messages are fetchable: "all" or "none".

      - `class BetaWebFetchUrlSourceAll`

        The `url_sources` variant under which a source contributes in
        full: every result of the tool filter's source, or all user input.

      - `class BetaWebFetchUrlSourceNone`

        The `url_sources` variant under which a source contributes nothing:
        no result of the tool filter's source, or no user input.

### Beta Web Fetch Tool 20260209

- `class BetaWebFetchTool20260209`

  - `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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<List<String>> allowedDomains`

    List of domains to allow fetching from

  - `Optional<List<String>> blockedDomains`

    List of domains to block fetching from

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<BetaCitationsConfigParam> citations`

    Citations configuration for fetched documents. Citations are disabled by default.

    - `Optional<Boolean> enabled`

  - `Optional<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Long> 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<Long> maxUses`

    Maximum number of times the tool can be used in the API request.

    minimum: 1

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

  - `Optional<BetaWebFetchUrlSources> urlSources`

    Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

    - `Optional<ClientToolResults> clientToolResults`

      Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

      - `class BetaWebFetchUrlSourceAll`

        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 BetaWebFetchUrlSourceNone`

        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 BetaWebFetchUrlSourceOnly`

        The tool filter variant under which only the named tools' results
        contribute.

        - `JsonValue type = "only"`

        - `List<BetaWebFetchUrlSourceToolReference> tools`

          - `JsonValue type = "tool_reference"`

          - `String name`

      - `class BetaWebFetchUrlSourceExcept`

        The tool filter variant under which every result but the named
        tools' contributes.

        - `JsonValue type = "except"`

        - `List<BetaWebFetchUrlSourceToolReference> tools`

          - `JsonValue type = "tool_reference"`

          - `String name`

    - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

        The `url_sources` variant under which a source contributes in
        full: every result of the tool filter's source, or all user input.

      - `class BetaWebFetchUrlSourceNone`

        The `url_sources` variant under which a source contributes nothing:
        no result of the tool filter's source, or no user input.

      - `class BetaWebFetchUrlSourceOnly`

        The tool filter variant under which only the named tools' results
        contribute.

      - `class BetaWebFetchUrlSourceExcept`

        The tool filter variant under which every result but the named
        tools' contributes.

    - `Optional<UserInput> userInput`

      Whether URLs in user messages are fetchable: "all" or "none".

      - `class BetaWebFetchUrlSourceAll`

        The `url_sources` variant under which a source contributes in
        full: every result of the tool filter's source, or all user input.

      - `class BetaWebFetchUrlSourceNone`

        The `url_sources` variant under which a source contributes nothing:
        no result of the tool filter's source, or no user input.

### Beta Web Fetch Tool 20260309

- `class BetaWebFetchTool20260309`

  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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<List<String>> allowedDomains`

    List of domains to allow fetching from

  - `Optional<List<String>> blockedDomains`

    List of domains to block fetching from

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<BetaCitationsConfigParam> citations`

    Citations configuration for fetched documents. Citations are disabled by default.

    - `Optional<Boolean> enabled`

  - `Optional<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Long> 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<Long> maxUses`

    Maximum number of times the tool can be used in the API request.

    minimum: 1

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

  - `Optional<BetaWebFetchUrlSources> urlSources`

    Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

    - `Optional<ClientToolResults> clientToolResults`

      Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

      - `class BetaWebFetchUrlSourceAll`

        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 BetaWebFetchUrlSourceNone`

        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 BetaWebFetchUrlSourceOnly`

        The tool filter variant under which only the named tools' results
        contribute.

        - `JsonValue type = "only"`

        - `List<BetaWebFetchUrlSourceToolReference> tools`

          - `JsonValue type = "tool_reference"`

          - `String name`

      - `class BetaWebFetchUrlSourceExcept`

        The tool filter variant under which every result but the named
        tools' contributes.

        - `JsonValue type = "except"`

        - `List<BetaWebFetchUrlSourceToolReference> tools`

          - `JsonValue type = "tool_reference"`

          - `String name`

    - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

        The `url_sources` variant under which a source contributes in
        full: every result of the tool filter's source, or all user input.

      - `class BetaWebFetchUrlSourceNone`

        The `url_sources` variant under which a source contributes nothing:
        no result of the tool filter's source, or no user input.

      - `class BetaWebFetchUrlSourceOnly`

        The tool filter variant under which only the named tools' results
        contribute.

      - `class BetaWebFetchUrlSourceExcept`

        The tool filter variant under which every result but the named
        tools' contributes.

    - `Optional<UserInput> userInput`

      Whether URLs in user messages are fetchable: "all" or "none".

      - `class BetaWebFetchUrlSourceAll`

        The `url_sources` variant under which a source contributes in
        full: every result of the tool filter's source, or all user input.

      - `class BetaWebFetchUrlSourceNone`

        The `url_sources` variant under which a source contributes nothing:
        no result of the tool filter's source, or no user input.

  - `Optional<Boolean> 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.

### Beta Web Fetch Tool 20260318

- `class BetaWebFetchTool20260318`

  - `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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<List<String>> allowedDomains`

    List of domains to allow fetching from

  - `Optional<List<String>> blockedDomains`

    List of domains to block fetching from

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<BetaCitationsConfigParam> citations`

    Citations configuration for fetched documents. Citations are disabled by default.

    - `Optional<Boolean> enabled`

  - `Optional<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Long> 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<Long> maxUses`

    Maximum number of times the tool can be used in the API request.

    minimum: 1

  - `Optional<ResponseInclusion> 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<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

  - `Optional<BetaWebFetchUrlSources> urlSources`

    Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

    - `Optional<ClientToolResults> clientToolResults`

      Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

      - `class BetaWebFetchUrlSourceAll`

        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 BetaWebFetchUrlSourceNone`

        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 BetaWebFetchUrlSourceOnly`

        The tool filter variant under which only the named tools' results
        contribute.

        - `JsonValue type = "only"`

        - `List<BetaWebFetchUrlSourceToolReference> tools`

          - `JsonValue type = "tool_reference"`

          - `String name`

      - `class BetaWebFetchUrlSourceExcept`

        The tool filter variant under which every result but the named
        tools' contributes.

        - `JsonValue type = "except"`

        - `List<BetaWebFetchUrlSourceToolReference> tools`

          - `JsonValue type = "tool_reference"`

          - `String name`

    - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

        The `url_sources` variant under which a source contributes in
        full: every result of the tool filter's source, or all user input.

      - `class BetaWebFetchUrlSourceNone`

        The `url_sources` variant under which a source contributes nothing:
        no result of the tool filter's source, or no user input.

      - `class BetaWebFetchUrlSourceOnly`

        The tool filter variant under which only the named tools' results
        contribute.

      - `class BetaWebFetchUrlSourceExcept`

        The tool filter variant under which every result but the named
        tools' contributes.

    - `Optional<UserInput> userInput`

      Whether URLs in user messages are fetchable: "all" or "none".

      - `class BetaWebFetchUrlSourceAll`

        The `url_sources` variant under which a source contributes in
        full: every result of the tool filter's source, or all user input.

      - `class BetaWebFetchUrlSourceNone`

        The `url_sources` variant under which a source contributes nothing:
        no result of the tool filter's source, or no user input.

  - `Optional<Boolean> 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.

### Beta Web Fetch Tool Result Block

- `class BetaWebFetchToolResultBlock`

  - `JsonValue type = "web_fetch_tool_result"`

  - `Content content`

    - `class BetaWebFetchToolResultErrorBlock`

      - `JsonValue type = "web_fetch_tool_result_error"`

      - `BetaWebFetchToolResultErrorCode 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 BetaWebFetchBlock`

      - `JsonValue type = "web_fetch_result"`

      - `BetaDocumentBlock content`

        - `JsonValue type = "document"`

        - `Optional<BetaCitationConfig> citations`

          Citation configuration for the document

          - `boolean enabled`

        - `Source source`

          - `class BetaBase64PdfSource`

            - `JsonValue type = "base64"`

            - `String data`

              format: byte

            - `JsonValue mediaType = "application/pdf"`

          - `class BetaPlainTextSource`

            - `JsonValue type = "text"`

            - `String data`

            - `JsonValue mediaType = "text/plain"`

        - `Optional<String> title`

          The title of the document

      - `Optional<String> retrievedAt`

        ISO 8601 timestamp when the content was retrieved

      - `String url`

        Fetched content URL

  - `String toolUseId`

    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `Optional<Caller> caller`

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Web Fetch Tool Result Block Param

- `class BetaWebFetchToolResultBlockParam`

  - `JsonValue type = "web_fetch_tool_result"`

  - `Content content`

    - `class BetaWebFetchToolResultErrorBlockParam`

      - `JsonValue type = "web_fetch_tool_result_error"`

      - `BetaWebFetchToolResultErrorCode 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 BetaWebFetchBlockParam`

      - `JsonValue type = "web_fetch_result"`

      - `BetaRequestDocumentBlock content`

        - `JsonValue type = "document"`

        - `Source source`

          - `class BetaBase64PdfSource`

            - `JsonValue type = "base64"`

            - `String data`

              format: byte

            - `JsonValue mediaType = "application/pdf"`

          - `class BetaPlainTextSource`

            - `JsonValue type = "text"`

            - `String data`

            - `JsonValue mediaType = "text/plain"`

          - `class BetaContentBlockSource`

            - `JsonValue type = "content"`

            - `Content content`

              - `String`

              - `List<BetaContentBlockSourceContent>`

                - `class BetaTextBlockParam`

                  - `JsonValue type = "text"`

                  - `String text`

                    minLength: 1

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                    - `JsonValue type = "ephemeral"`

                    - `Optional<Ttl> 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<List<BetaTextCitationParam>> citations`

                    - `class BetaCitationCharLocationParam`

                      - `JsonValue type = "char_location"`

                      - `String citedText`

                      - `long documentIndex`

                        minimum: 0

                      - `Optional<String> documentTitle`

                        minLength: 1, maxLength: 500

                      - `long endCharIndex`

                      - `long startCharIndex`

                        minimum: 0

                    - `class BetaCitationPageLocationParam`

                      - `JsonValue type = "page_location"`

                      - `String citedText`

                      - `long documentIndex`

                        minimum: 0

                      - `Optional<String> documentTitle`

                        minLength: 1, maxLength: 500

                      - `long endPageNumber`

                      - `long startPageNumber`

                        minimum: 1

                    - `class BetaCitationContentBlockLocationParam`

                      - `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<String> 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 BetaCitationWebSearchResultLocationParam`

                      - `JsonValue type = "web_search_result_location"`

                      - `String citedText`

                      - `String encryptedIndex`

                      - `Optional<String> title`

                        minLength: 1, maxLength: 512

                      - `String url`

                        minLength: 1

                    - `class BetaCitationSearchResultLocationParam`

                      - `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<String> title`

                - `class BetaImageBlockParam`

                  - `JsonValue type = "image"`

                  - `Source source`

                    - `class BetaBase64ImageSource`

                      - `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 BetaUrlImageSource`

                      - `JsonValue type = "url"`

                      - `String url`

                    - `class BetaFileImageSource`

                      - `JsonValue type = "file"`

                      - `String fileId`

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<BetaImageTransformationsParam> 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> 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 BetaUrlPdfSource`

            - `JsonValue type = "url"`

            - `String url`

          - `class BetaFileDocumentSource`

            - `JsonValue type = "file"`

            - `String fileId`

        - `Optional<BetaCacheControlEphemeral> cacheControl`

          Create a cache control breakpoint at this content block.

        - `Optional<BetaCitationsConfigParam> citations`

          - `Optional<Boolean> enabled`

        - `Optional<String> context`

          minLength: 1

        - `Optional<String> title`

          minLength: 1, maxLength: 500

      - `String url`

        Fetched content URL

      - `Optional<String> retrievedAt`

        ISO 8601 timestamp when the content was retrieved

  - `String toolUseId`

    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

  - `Optional<Caller> caller`

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Web Fetch Tool Result Error Block

- `class BetaWebFetchToolResultErrorBlock`

  - `JsonValue type = "web_fetch_tool_result_error"`

  - `BetaWebFetchToolResultErrorCode 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")`

### Beta Web Fetch Tool Result Error Block Param

- `class BetaWebFetchToolResultErrorBlockParam`

  - `JsonValue type = "web_fetch_tool_result_error"`

  - `BetaWebFetchToolResultErrorCode 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")`

### Beta Web Fetch Tool Result Error Code

- `enum BetaWebFetchToolResultErrorCode`

  - `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")`

### Beta Web Fetch URL Source All

- `class BetaWebFetchUrlSourceAll`

  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"`

### Beta Web Fetch URL Source Except

- `class BetaWebFetchUrlSourceExcept`

  The tool filter variant under which every result but the named
  tools' contributes.

  - `JsonValue type = "except"`

  - `List<BetaWebFetchUrlSourceToolReference> tools`

    - `JsonValue type = "tool_reference"`

    - `String name`

### Beta Web Fetch URL Source None

- `class BetaWebFetchUrlSourceNone`

  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"`

### Beta Web Fetch URL Source Only

- `class BetaWebFetchUrlSourceOnly`

  The tool filter variant under which only the named tools' results
  contribute.

  - `JsonValue type = "only"`

  - `List<BetaWebFetchUrlSourceToolReference> tools`

    - `JsonValue type = "tool_reference"`

    - `String name`

### Beta Web Fetch URL Source Tool Reference

- `class BetaWebFetchUrlSourceToolReference`

  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`

### Beta Web Fetch URL Sources

- `class BetaWebFetchUrlSources`

  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> clientToolResults`

    Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

    - `class BetaWebFetchUrlSourceAll`

      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 BetaWebFetchUrlSourceNone`

      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 BetaWebFetchUrlSourceOnly`

      The tool filter variant under which only the named tools' results
      contribute.

      - `JsonValue type = "only"`

      - `List<BetaWebFetchUrlSourceToolReference> tools`

        - `JsonValue type = "tool_reference"`

        - `String name`

    - `class BetaWebFetchUrlSourceExcept`

      The tool filter variant under which every result but the named
      tools' contributes.

      - `JsonValue type = "except"`

      - `List<BetaWebFetchUrlSourceToolReference> tools`

        - `JsonValue type = "tool_reference"`

        - `String name`

  - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

      The `url_sources` variant under which a source contributes in
      full: every result of the tool filter's source, or all user input.

    - `class BetaWebFetchUrlSourceNone`

      The `url_sources` variant under which a source contributes nothing:
      no result of the tool filter's source, or no user input.

    - `class BetaWebFetchUrlSourceOnly`

      The tool filter variant under which only the named tools' results
      contribute.

    - `class BetaWebFetchUrlSourceExcept`

      The tool filter variant under which every result but the named
      tools' contributes.

  - `Optional<UserInput> userInput`

    Whether URLs in user messages are fetchable: "all" or "none".

    - `class BetaWebFetchUrlSourceAll`

      The `url_sources` variant under which a source contributes in
      full: every result of the tool filter's source, or all user input.

    - `class BetaWebFetchUrlSourceNone`

      The `url_sources` variant under which a source contributes nothing:
      no result of the tool filter's source, or no user input.

### Beta Web Search Result Block

- `class BetaWebSearchResultBlock`

  - `JsonValue type = "web_search_result"`

  - `String encryptedContent`

  - `Optional<String> pageAge`

  - `String title`

  - `String url`

### Beta Web Search Result Block Param

- `class BetaWebSearchResultBlockParam`

  - `JsonValue type = "web_search_result"`

  - `String encryptedContent`

  - `String title`

  - `String url`

  - `Optional<String> pageAge`

### Beta Web Search Tool 20250305

- `class BetaWebSearchTool20250305`

  - `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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<List<String>> allowedDomains`

    If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

  - `Optional<List<String>> blockedDomains`

    If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Long> maxUses`

    Maximum number of times the tool can be used in the API request.

    minimum: 1

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

  - `Optional<BetaUserLocation> userLocation`

    Parameters for the user's location. Used to provide more relevant search results.

    - `JsonValue type = "approximate"`

    - `Optional<String> city`

      The city of the user.

      minLength: 1, maxLength: 255

    - `Optional<String> 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<String> region`

      The region of the user.

      minLength: 1, maxLength: 255

    - `Optional<String> timezone`

      The [IANA timezone](https://nodatime.org/TimeZones) of the user.

      minLength: 1, maxLength: 255

### Beta Web Search Tool 20260209

- `class BetaWebSearchTool20260209`

  - `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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<List<String>> allowedDomains`

    If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

  - `Optional<List<String>> blockedDomains`

    If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Long> maxUses`

    Maximum number of times the tool can be used in the API request.

    minimum: 1

  - `Optional<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

  - `Optional<BetaUserLocation> userLocation`

    Parameters for the user's location. Used to provide more relevant search results.

    - `JsonValue type = "approximate"`

    - `Optional<String> city`

      The city of the user.

      minLength: 1, maxLength: 255

    - `Optional<String> 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<String> region`

      The region of the user.

      minLength: 1, maxLength: 255

    - `Optional<String> timezone`

      The [IANA timezone](https://nodatime.org/TimeZones) of the user.

      minLength: 1, maxLength: 255

### Beta Web Search Tool 20260318

- `class BetaWebSearchTool20260318`

  - `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<List<AllowedCaller>> allowedCallers`

    - `DIRECT("direct")`

    - `CODE_EXECUTION_20250825("code_execution_20250825")`

    - `CODE_EXECUTION_20260120("code_execution_20260120")`

    - `CODE_EXECUTION_20260521("code_execution_20260521")`

  - `Optional<List<String>> allowedDomains`

    If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

  - `Optional<List<String>> blockedDomains`

    If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

  - `Optional<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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<Boolean> deferLoading`

    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

  - `Optional<Long> maxUses`

    Maximum number of times the tool can be used in the API request.

    minimum: 1

  - `Optional<ResponseInclusion> 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<Boolean> strict`

    When true, guarantees schema validation on tool names and inputs

  - `Optional<BetaUserLocation> userLocation`

    Parameters for the user's location. Used to provide more relevant search results.

    - `JsonValue type = "approximate"`

    - `Optional<String> city`

      The city of the user.

      minLength: 1, maxLength: 255

    - `Optional<String> 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<String> region`

      The region of the user.

      minLength: 1, maxLength: 255

    - `Optional<String> timezone`

      The [IANA timezone](https://nodatime.org/TimeZones) of the user.

      minLength: 1, maxLength: 255

### Beta Web Search Tool Request Error

- `class BetaWebSearchToolRequestError`

  - `JsonValue type = "web_search_tool_result_error"`

  - `BetaWebSearchToolResultErrorCode 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")`

### Beta Web Search Tool Result Block

- `class BetaWebSearchToolResultBlock`

  - `JsonValue type = "web_search_tool_result"`

  - `BetaWebSearchToolResultBlockContent content`

    - `class BetaWebSearchToolResultError`

      - `JsonValue type = "web_search_tool_result_error"`

      - `BetaWebSearchToolResultErrorCode 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<BetaWebSearchResultBlock>`

      - `JsonValue type = "web_search_result"`

      - `String encryptedContent`

      - `Optional<String> pageAge`

      - `String title`

      - `String url`

  - `String toolUseId`

    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

  - `Optional<Caller> caller`

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Web Search Tool Result Block Content

- `class BetaWebSearchToolResultBlockContent: union`

  - `class BetaWebSearchToolResultError`

    - `JsonValue type = "web_search_tool_result_error"`

    - `BetaWebSearchToolResultErrorCode 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<BetaWebSearchResultBlock>`

    - `JsonValue type = "web_search_result"`

    - `String encryptedContent`

    - `Optional<String> pageAge`

    - `String title`

    - `String url`

### Beta Web Search Tool Result Block Param

- `class BetaWebSearchToolResultBlockParam`

  - `JsonValue type = "web_search_tool_result"`

  - `BetaWebSearchToolResultBlockParamContent content`

    - `List<BetaWebSearchResultBlockParam>`

      - `JsonValue type = "web_search_result"`

      - `String encryptedContent`

      - `String title`

      - `String url`

      - `Optional<String> pageAge`

    - `class BetaWebSearchToolRequestError`

      - `JsonValue type = "web_search_tool_result_error"`

      - `BetaWebSearchToolResultErrorCode 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<BetaCacheControlEphemeral> cacheControl`

    Create a cache control breakpoint at this content block.

    - `JsonValue type = "ephemeral"`

    - `Optional<Ttl> 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> caller`

    - `class BetaDirectCaller`

      Tool invocation directly from the model.

      - `JsonValue type = "direct"`

    - `class BetaServerToolCaller`

      Tool invocation generated by a server-side tool.

      - `JsonValue type = "code_execution_20250825"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

    - `class BetaServerToolCaller20260120`

      - `JsonValue type = "code_execution_20260120"`

      - `String toolId`

        pattern: ^srvtoolu_[a-zA-Z0-9_]+$

### Beta Web Search Tool Result Block Param Content

- `class BetaWebSearchToolResultBlockParamContent: union`

  - `List<BetaWebSearchResultBlockParam>`

    - `JsonValue type = "web_search_result"`

    - `String encryptedContent`

    - `String title`

    - `String url`

    - `Optional<String> pageAge`

  - `class BetaWebSearchToolRequestError`

    - `JsonValue type = "web_search_tool_result_error"`

    - `BetaWebSearchToolResultErrorCode 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")`

### Beta Web Search Tool Result Error

- `class BetaWebSearchToolResultError`

  - `JsonValue type = "web_search_tool_result_error"`

  - `BetaWebSearchToolResultErrorCode 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")`

### Beta Web Search Tool Result Error Code

- `enum BetaWebSearchToolResultErrorCode`

  - `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

`BetaMessageBatch beta().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<List<AnthropicBeta>> betas` (header parameter)

    Optional header to specify the beta version(s) you want to use.

    - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")`

    - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")`

    - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")`

    - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")`

    - `PDFS_2024_09_25("pdfs-2024-09-25")`

    - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")`

    - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")`

    - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")`

    - `FILES_API_2025_04_14("files-api-2025-04-14")`

    - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")`

    - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")`

    - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")`

    - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")`

    - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")`

    - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")`

    - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")`

    - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")`

    - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")`

    - `SKILLS_2025_10_02("skills-2025-10-02")`

    - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")`

    - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")`

    - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")`

    - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")`

    - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")`

    - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")`

    - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")`

    - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")`

    - `DREAMING_2026_04_21("dreaming-2026-04-21")`

    - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")`

    - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")`

    - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")`

    - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")`

    - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")`

    - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")`

    - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")`

    - `COMPACT_2026_01_12("compact-2026-01-12")`

    - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")`

    - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")`

    - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")`

    - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")`

    - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")`

    - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")`

    - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")`

    - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")`

    - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")`

    - `COMPACT_2026_09_04("compact-2026-09-04")`

    - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")`

    - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")`

    - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")`

    - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")`

    - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")`

  - `Optional<String> 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<String> 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<Request> 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<BetaMessageParam> 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<BetaContentBlockParam>`

            - `class BetaTextBlockParam`

              - `JsonValue type = "text"`

              - `String text`

                minLength: 1

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

                - `JsonValue type = "ephemeral"`

                - `Optional<Ttl> 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<List<BetaTextCitationParam>> citations`

                - `class BetaCitationCharLocationParam`

                  - `JsonValue type = "char_location"`

                  - `String citedText`

                  - `long documentIndex`

                    minimum: 0

                  - `Optional<String> documentTitle`

                    minLength: 1, maxLength: 500

                  - `long endCharIndex`

                  - `long startCharIndex`

                    minimum: 0

                - `class BetaCitationPageLocationParam`

                  - `JsonValue type = "page_location"`

                  - `String citedText`

                  - `long documentIndex`

                    minimum: 0

                  - `Optional<String> documentTitle`

                    minLength: 1, maxLength: 500

                  - `long endPageNumber`

                  - `long startPageNumber`

                    minimum: 1

                - `class BetaCitationContentBlockLocationParam`

                  - `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<String> 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 BetaCitationWebSearchResultLocationParam`

                  - `JsonValue type = "web_search_result_location"`

                  - `String citedText`

                  - `String encryptedIndex`

                  - `Optional<String> title`

                    minLength: 1, maxLength: 512

                  - `String url`

                    minLength: 1

                - `class BetaCitationSearchResultLocationParam`

                  - `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<String> title`

            - `class BetaImageBlockParam`

              - `JsonValue type = "image"`

              - `Source source`

                - `class BetaBase64ImageSource`

                  - `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 BetaUrlImageSource`

                  - `JsonValue type = "url"`

                  - `String url`

                - `class BetaFileImageSource`

                  - `JsonValue type = "file"`

                  - `String fileId`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaImageTransformationsParam> 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> 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 BetaRequestDocumentBlock`

              - `JsonValue type = "document"`

              - `Source source`

                - `class BetaBase64PdfSource`

                  - `JsonValue type = "base64"`

                  - `String data`

                    format: byte

                  - `JsonValue mediaType = "application/pdf"`

                - `class BetaPlainTextSource`

                  - `JsonValue type = "text"`

                  - `String data`

                  - `JsonValue mediaType = "text/plain"`

                - `class BetaContentBlockSource`

                  - `JsonValue type = "content"`

                  - `Content content`

                    - `String`

                    - `List<BetaContentBlockSourceContent>`

                      - `class BetaTextBlockParam`

                      - `class BetaImageBlockParam`

                - `class BetaUrlPdfSource`

                  - `JsonValue type = "url"`

                  - `String url`

                - `class BetaFileDocumentSource`

                  - `JsonValue type = "file"`

                  - `String fileId`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaCitationsConfigParam> citations`

                - `Optional<Boolean> enabled`

              - `Optional<String> context`

                minLength: 1

              - `Optional<String> title`

                minLength: 1, maxLength: 500

            - `class BetaSearchResultBlockParam`

              - `JsonValue type = "search_result"`

              - `List<BetaTextBlockParam> content`

                - `JsonValue type = "text"`

                - `String text`

                  minLength: 1

                - `Optional<BetaCacheControlEphemeral> cacheControl`

                  Create a cache control breakpoint at this content block.

                - `Optional<List<BetaTextCitationParam>> citations`

              - `String source`

              - `String title`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<BetaCitationsConfigParam> citations`

            - `class BetaThinkingBlockParam`

              - `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 BetaRedactedThinkingBlockParam`

              - `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 BetaToolUseBlockParam`

              - `JsonValue type = "tool_use"`

              - `String id`

                pattern: ^[a-zA-Z0-9_-]+$

              - `Input input`

              - `String name`

                minLength: 1, maxLength: 200

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Caller> caller`

                - `class BetaDirectCaller`

                  Tool invocation directly from the model.

                  - `JsonValue type = "direct"`

                - `class BetaServerToolCaller`

                  Tool invocation generated by a server-side tool.

                  - `JsonValue type = "code_execution_20250825"`

                  - `String toolId`

                    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

                - `class BetaServerToolCaller20260120`

                  - `JsonValue type = "code_execution_20260120"`

                  - `String toolId`

                    pattern: ^srvtoolu_[a-zA-Z0-9_]+$

              - `Optional<String> toolsetName`

                For a toolset member tool_use, the toolset family this member belongs to.

                minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$

            - `class BetaToolResultBlockParam`

              - `JsonValue type = "tool_result"`

              - `String toolUseId`

                pattern: ^[a-zA-Z0-9_-]+$

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Content> content`

                - `String`

                - `List<Block>`

                  - `class BetaTextBlockParam`

                  - `class BetaImageBlockParam`

                  - `class BetaSearchResultBlockParam`

                  - `class BetaRequestDocumentBlock`

                  - `class BetaToolReferenceBlockParam`

                    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<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                  - `class BetaBrowserStateBlockParam`

                    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<BetaBrowserStateTabEntry> 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<Boolean> active`

                        Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

                    - `Optional<List<BetaBrowserStateChange>> 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 BetaBrowserStateChangeTabOpened`

                        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 BetaBrowserStateChangeDownloadStarted`

                        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 BetaBrowserStateChangeDownloadCompleted`

                        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<String> 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<Long> sizeBytes`

                          The completed download's size.

                          minimum: 0

                      - `class BetaBrowserStateChangeDownloadFailed`

                        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<String> error`

                          The failure or cancellation detail, when known.

                          maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$

              - `Optional<Boolean> isError`

              - `Optional<String> 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 BetaServerToolUseBlockParam`

              - `JsonValue type = "server_tool_use"`

              - `String id`

                pattern: ^srvtoolu_[a-zA-Z0-9_]+$

              - `Input input`

              - `Name name`

                - `ADVISOR("advisor")`

                - `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<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Caller> caller`

                - `class BetaDirectCaller`

                  Tool invocation directly from the model.

                - `class BetaServerToolCaller`

                  Tool invocation generated by a server-side tool.

                - `class BetaServerToolCaller20260120`

            - `class BetaWebSearchToolResultBlockParam`

              - `JsonValue type = "web_search_tool_result"`

              - `BetaWebSearchToolResultBlockParamContent content`

                - `List<BetaWebSearchResultBlockParam>`

                  - `JsonValue type = "web_search_result"`

                  - `String encryptedContent`

                  - `String title`

                  - `String url`

                  - `Optional<String> pageAge`

                - `class BetaWebSearchToolRequestError`

                  - `JsonValue type = "web_search_tool_result_error"`

                  - `BetaWebSearchToolResultErrorCode 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<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Caller> caller`

                - `class BetaDirectCaller`

                  Tool invocation directly from the model.

                - `class BetaServerToolCaller`

                  Tool invocation generated by a server-side tool.

                - `class BetaServerToolCaller20260120`

            - `class BetaWebFetchToolResultBlockParam`

              - `JsonValue type = "web_fetch_tool_result"`

              - `Content content`

                - `class BetaWebFetchToolResultErrorBlockParam`

                  - `JsonValue type = "web_fetch_tool_result_error"`

                  - `BetaWebFetchToolResultErrorCode 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 BetaWebFetchBlockParam`

                  - `JsonValue type = "web_fetch_result"`

                  - `BetaRequestDocumentBlock content`

                  - `String url`

                    Fetched content URL

                  - `Optional<String> retrievedAt`

                    ISO 8601 timestamp when the content was retrieved

              - `String toolUseId`

                pattern: ^srvtoolu_[a-zA-Z0-9_]+$

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Caller> caller`

                - `class BetaDirectCaller`

                  Tool invocation directly from the model.

                - `class BetaServerToolCaller`

                  Tool invocation generated by a server-side tool.

                - `class BetaServerToolCaller20260120`

            - `class BetaAdvisorToolResultBlockParam`

              - `JsonValue type = "advisor_tool_result"`

              - `Content content`

                - `class BetaAdvisorToolResultErrorParam`

                  - `JsonValue type = "advisor_tool_result_error"`

                  - `ErrorCode errorCode`

                    - `MAX_USES_EXCEEDED("max_uses_exceeded")`

                    - `PROMPT_TOO_LONG("prompt_too_long")`

                    - `TOO_MANY_REQUESTS("too_many_requests")`

                    - `OVERLOADED("overloaded")`

                    - `UNAVAILABLE("unavailable")`

                    - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

                    - `MODEL_NOT_FOUND("model_not_found")`

                - `class BetaAdvisorResultBlockParam`

                  - `JsonValue type = "advisor_result"`

                  - `String text`

                  - `Optional<String> stopReason`

                - `class BetaAdvisorRedactedResultBlockParam`

                  - `JsonValue type = "advisor_redacted_result"`

                  - `String encryptedContent`

                    Opaque blob produced by a prior response; must be round-tripped verbatim.

                  - `Optional<String> stopReason`

              - `String toolUseId`

                pattern: ^srvtoolu_[a-zA-Z0-9_]+$

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

            - `class BetaCodeExecutionToolResultBlockParam`

              - `JsonValue type = "code_execution_tool_result"`

              - `BetaCodeExecutionToolResultBlockParamContent content`

                - `class BetaCodeExecutionToolResultErrorParam`

                  - `JsonValue type = "code_execution_tool_result_error"`

                  - `BetaCodeExecutionToolResultErrorCode errorCode`

                    - `INVALID_TOOL_INPUT("invalid_tool_input")`

                    - `UNAVAILABLE("unavailable")`

                    - `TOO_MANY_REQUESTS("too_many_requests")`

                    - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

                - `class BetaCodeExecutionResultBlockParam`

                  - `JsonValue type = "code_execution_result"`

                  - `List<BetaCodeExecutionOutputBlockParam> content`

                    - `JsonValue type = "code_execution_output"`

                    - `String fileId`

                  - `long returnCode`

                  - `String stderr`

                  - `String stdout`

                - `class BetaEncryptedCodeExecutionResultBlockParam`

                  Code execution result with encrypted stdout for PFC + web_search results.

                  - `JsonValue type = "encrypted_code_execution_result"`

                  - `List<BetaCodeExecutionOutputBlockParam> content`

                    - `JsonValue type = "code_execution_output"`

                    - `String fileId`

                  - `String encryptedStdout`

                  - `long returnCode`

                  - `String stderr`

              - `String toolUseId`

                pattern: ^srvtoolu_[a-zA-Z0-9_]+$

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

            - `class BetaBashCodeExecutionToolResultBlockParam`

              - `JsonValue type = "bash_code_execution_tool_result"`

              - `Content content`

                - `class BetaBashCodeExecutionToolResultErrorParam`

                  - `JsonValue type = "bash_code_execution_tool_result_error"`

                  - `ErrorCode 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 BetaBashCodeExecutionResultBlockParam`

                  - `JsonValue type = "bash_code_execution_result"`

                  - `List<BetaBashCodeExecutionOutputBlockParam> content`

                    - `JsonValue type = "bash_code_execution_output"`

                    - `String fileId`

                  - `long returnCode`

                  - `String stderr`

                  - `String stdout`

              - `String toolUseId`

                pattern: ^srvtoolu_[a-zA-Z0-9_]+$

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

            - `class BetaTextEditorCodeExecutionToolResultBlockParam`

              - `JsonValue type = "text_editor_code_execution_tool_result"`

              - `Content content`

                - `class BetaTextEditorCodeExecutionToolResultErrorParam`

                  - `JsonValue type = "text_editor_code_execution_tool_result_error"`

                  - `ErrorCode 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<String> errorMessage`

                - `class BetaTextEditorCodeExecutionViewResultBlockParam`

                  - `JsonValue type = "text_editor_code_execution_view_result"`

                  - `String content`

                  - `FileType fileType`

                    - `TEXT("text")`

                    - `IMAGE("image")`

                    - `PDF("pdf")`

                  - `Optional<Long> numLines`

                  - `Optional<Long> startLine`

                  - `Optional<Long> totalLines`

                - `class BetaTextEditorCodeExecutionCreateResultBlockParam`

                  - `JsonValue type = "text_editor_code_execution_create_result"`

                  - `boolean isFileUpdate`

                - `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam`

                  - `JsonValue type = "text_editor_code_execution_str_replace_result"`

                  - `Optional<List<String>> lines`

                  - `Optional<Long> newLines`

                  - `Optional<Long> newStart`

                  - `Optional<Long> oldLines`

                  - `Optional<Long> oldStart`

              - `String toolUseId`

                pattern: ^srvtoolu_[a-zA-Z0-9_]+$

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

            - `class BetaToolSearchToolResultBlockParam`

              - `JsonValue type = "tool_search_tool_result"`

              - `Content content`

                - `class BetaToolSearchToolResultErrorParam`

                  - `JsonValue type = "tool_search_tool_result_error"`

                  - `ErrorCode errorCode`

                    - `INVALID_TOOL_INPUT("invalid_tool_input")`

                    - `UNAVAILABLE("unavailable")`

                    - `TOO_MANY_REQUESTS("too_many_requests")`

                    - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

                  - `Optional<String> errorMessage`

                - `class BetaToolSearchToolSearchResultBlockParam`

                  - `JsonValue type = "tool_search_tool_search_result"`

                  - `List<BetaToolReferenceBlockParam> toolReferences`

                    - `JsonValue type = "tool_reference"`

                    - `String toolName`

                      minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$

                    - `Optional<BetaCacheControlEphemeral> cacheControl`

                      Create a cache control breakpoint at this content block.

              - `String toolUseId`

                pattern: ^srvtoolu_[a-zA-Z0-9_]+$

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

            - `class BetaMcpToolUseBlockParam`

              - `JsonValue type = "mcp_tool_use"`

              - `String id`

                pattern: ^[a-zA-Z0-9_-]+$

              - `Input input`

              - `String name`

              - `String serverName`

                The name of the MCP server

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

            - `class BetaRequestMcpToolResultBlockParam`

              - `JsonValue type = "mcp_tool_result"`

              - `String toolUseId`

                pattern: ^[a-zA-Z0-9_-]+$

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<Content> content`

                - `String`

                - `List<BetaTextBlockParam>`

                  - `JsonValue type = "text"`

                  - `String text`

                    minLength: 1

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                  - `Optional<List<BetaTextCitationParam>> citations`

              - `Optional<Boolean> isError`

            - `class BetaContainerUploadBlockParam`

              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<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

            - `class BetaCompactionBlockParam`

              A compaction block containing summary of previous context.

              Users should round-trip these blocks from responses to subsequent requests
              to maintain context across compaction boundaries.

              When content is None, the block represents a failed compaction. The server
              treats these as no-ops. Empty string content is not allowed.

              - `JsonValue type = "compaction"`

              - `Optional<BetaCacheControlEphemeral> cacheControl`

                Create a cache control breakpoint at this content block.

              - `Optional<String> content`

                Summary of previously compacted content, or null if compaction failed

              - `Optional<String> encryptedContent`

                Opaque metadata from prior compaction, to be round-tripped verbatim

              - `Optional<String> signature`

                The block's signature as returned, to be sent back verbatim

              - `Optional<List<ToolChange>> toolChanges`

                The tool changes of the compacted range, as the server returned them on this block: the `tool_addition` and `tool_removal` entries that take the request's `tools` to the tool set in effect at the end of the range. Send them back unchanged with the block.

                - `class BetaRequestToolAdditionBlock`

                  Mid-conversation directive to make a tool available.

                  `tool` is a reference to a tool (or MCP toolset) declared in the
                  request's `tools`. Under the `inline-tools-2026-09-15` beta it may
                  instead be a reference to a tool defined earlier in `messages`, or a
                  `tool_definition` object that carries an inline tool definition in
                  `definition` (the same object a `tools` entry holds). An `mcp_toolset`
                  definition also requires the `mcp-client-2026-09-15` beta. The tool is
                  offered to the model from this point in the conversation onward.

                  - `JsonValue type = "tool_addition"`

                  - `Tool tool`

                    - `class BetaToolChangeToolReference`

                      Reference to a single tool, by the name the model uses to call it: a
                      tool declared in `tools` or defined by an earlier `tool_addition`
                      block. Does not accept the composed `{server}_{name}` form the server
                      assigns to MCP-resolved tools; use `mcp_tool_reference` or
                      `mcp_toolset_reference` for those.

                      - `JsonValue type = "tool_reference"`

                      - `String name`

                        pattern: ^[a-zA-Z0-9_-]{1,128}$

                    - `class BetaToolChangeMcpToolReference`

                      Reference to a single MCP tool by its server and remote name; the
                      same `server_name`/`name` pair `mcp_tool_use` carries.

                      - `JsonValue type = "mcp_tool_reference"`

                      - `String name`

                      - `String serverName`

                    - `class BetaToolChangeMcpToolsetReference`

                      Reference to every tool in the named MCP server's toolset.

                      - `JsonValue type = "mcp_toolset_reference"`

                      - `String serverName`

                    - `class BetaToolChangeToolDefinitionParam`

                      A tool defined by value: `definition` is a `tools` entry (any kind
                      `tools` accepts, an MCP toolset included). An `mcp_toolset` given here
                      also requires the `mcp-client-2026-09-15` beta.

                      - `JsonValue type = "tool_definition"`

                      - `BetaToolUnion definition`

                        - `class BetaTool`

                          - `Optional<Type> 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> properties`

                            - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaToolBash20241022`

                          - `JsonValue type = "bash_20241022"`

                          - `JsonValue name = "bash"`

                            Name of the tool.

                            This is how the tool will be called by the model and in `tool_use` blocks.

                          - `Optional<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<List<InputExample>> inputExamples`

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaToolBash20250124`

                          - `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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<List<InputExample>> inputExamples`

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaCodeExecutionTool20250522`

                          - `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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaCodeExecutionTool20250825`

                          - `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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaCodeExecutionTool20260120`

                          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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaCodeExecutionTool20260521`

                          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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaBrowserToolset20260801`

                          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<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

                              `type`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserCloseTabConfig> closeTab`

                              `close_tab`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

                              `double_click`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserFileUploadConfig> fileUpload`

                              `file_upload`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserFindConfig> find`

                              `find`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserFormInputConfig> formInput`

                              `form_input`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserGetPageTextConfig> getPageText`

                              `get_page_text`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserHoldKeyConfig> holdKey`

                              `hold_key`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserHoverConfig> hover`

                              `hover`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

                              `javascript_exec`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserKeyConfig> key`

                              `key`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserLeftClickConfig> leftClick`

                              `left_click`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

                              `left_click_drag`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

                              `left_mouse_down`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

                              `left_mouse_up`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserListTabsConfig> listTabs`

                              `list_tabs`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserMiddleClickConfig> middleClick`

                              `middle_click`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

                              `mouse_move`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserNavigateConfig> navigate`

                              `navigate`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserNewTabConfig> newTab`

                              `new_tab`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserReadConsoleConfig> readConsole`

                              `read_console`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

                              `read_network`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserReadPageConfig> readPage`

                              `read_page`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserRightClickConfig> rightClick`

                              `right_click`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserScreenshotConfig> screenshot`

                              `screenshot`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserScrollConfig> scroll`

                              `scroll`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserScrollToConfig> scrollTo`

                              `scroll_to`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserSwitchTabConfig> switchTab`

                              `switch_tab`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserTripleClickConfig> tripleClick`

                              `triple_click`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserWaitConfig> wait`

                              `wait`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaBrowserZoomConfig> zoom`

                              `zoom`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered 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 BetaToolComputerUse20241022`

                          - `JsonValue type = "computer_20241022"`

                          - `long displayHeightPx`

                            The height of the display in pixels.

                            minimum: 1

                          - `long displayWidthPx`

                            The width of the display in pixels.

                            minimum: 1

                          - `JsonValue name = "computer"`

                            Name of the tool.

                            This is how the tool will be called by the model and in `tool_use` blocks.

                          - `Optional<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Long> displayNumber`

                            The X11 display number (e.g. 0, 1) for the display.

                            minimum: 0

                          - `Optional<List<InputExample>> inputExamples`

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaMemoryTool20250818`

                          - `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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<List<InputExample>> inputExamples`

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaToolComputerUse20250124`

                          - `JsonValue type = "computer_20250124"`

                          - `long displayHeightPx`

                            The height of the display in pixels.

                            minimum: 1

                          - `long displayWidthPx`

                            The width of the display in pixels.

                            minimum: 1

                          - `JsonValue name = "computer"`

                            Name of the tool.

                            This is how the tool will be called by the model and in `tool_use` blocks.

                          - `Optional<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Long> displayNumber`

                            The X11 display number (e.g. 0, 1) for the display.

                            minimum: 0

                          - `Optional<List<InputExample>> inputExamples`

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaToolTextEditor20241022`

                          - `JsonValue type = "text_editor_20241022"`

                          - `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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<List<InputExample>> inputExamples`

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaToolComputerUse20251124`

                          - `JsonValue type = "computer_20251124"`

                          - `long displayHeightPx`

                            The height of the display in pixels.

                            minimum: 1

                          - `long displayWidthPx`

                            The width of the display in pixels.

                            minimum: 1

                          - `JsonValue name = "computer"`

                            Name of the tool.

                            This is how the tool will be called by the model and in `tool_use` blocks.

                          - `Optional<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Long> displayNumber`

                            The X11 display number (e.g. 0, 1) for the display.

                            minimum: 0

                          - `Optional<Boolean> enableZoom`

                            Whether to enable an action to take a zoomed-in screenshot of the screen.

                          - `Optional<List<InputExample>> inputExamples`

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaComputerToolset20260801`

                          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<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

                              `type`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

                              `cursor_position`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaComputerDoubleClickConfig> doubleClick`

                              `double_click`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaComputerHoldKeyConfig> holdKey`

                              `hold_key`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaComputerKeyConfig> key`

                              `key`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaComputerLeftClickConfig> leftClick`

                              `left_click`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

                              `left_click_drag`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

                              `left_mouse_down`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

                              `left_mouse_up`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaComputerMiddleClickConfig> middleClick`

                              `middle_click`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaComputerMouseMoveConfig> mouseMove`

                              `mouse_move`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaComputerRightClickConfig> rightClick`

                              `right_click`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaComputerScreenshotConfig> screenshot`

                              `screenshot`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaComputerScrollConfig> scroll`

                              `scroll`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaComputerTripleClickConfig> tripleClick`

                              `triple_click`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaComputerWaitConfig> wait`

                              `wait`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                            - `Optional<BetaComputerZoomConfig> zoom`

                              `zoom`'s config overrides.

                              - `Optional<Boolean> deferLoading`

                                Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                              - `Optional<Boolean> enabled`

                                Whether this member is offered 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 BetaToolTextEditor20250124`

                          - `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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<List<InputExample>> inputExamples`

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaToolTextEditor20250429`

                          - `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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<List<InputExample>> inputExamples`

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaToolTextEditor20250728`

                          - `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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<List<InputExample>> inputExamples`

                          - `Optional<Long> maxCharacters`

                            Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

                            minimum: 1

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaWebSearchTool20250305`

                          - `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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<List<String>> allowedDomains`

                            If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                          - `Optional<List<String>> blockedDomains`

                            If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Long> maxUses`

                            Maximum number of times the tool can be used in the API request.

                            minimum: 1

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                          - `Optional<BetaUserLocation> userLocation`

                            Parameters for the user's location. Used to provide more relevant search results.

                            - `JsonValue type = "approximate"`

                            - `Optional<String> city`

                              The city of the user.

                              minLength: 1, maxLength: 255

                            - `Optional<String> 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<String> region`

                              The region of the user.

                              minLength: 1, maxLength: 255

                            - `Optional<String> timezone`

                              The [IANA timezone](https://nodatime.org/TimeZones) of the user.

                              minLength: 1, maxLength: 255

                        - `class BetaWebFetchTool20250910`

                          - `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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<List<String>> allowedDomains`

                            List of domains to allow fetching from

                          - `Optional<List<String>> blockedDomains`

                            List of domains to block fetching from

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<BetaCitationsConfigParam> citations`

                            Citations configuration for fetched documents. Citations are disabled by default.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Long> 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<Long> maxUses`

                            Maximum number of times the tool can be used in the API request.

                            minimum: 1

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                          - `Optional<BetaWebFetchUrlSources> urlSources`

                            Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                            - `Optional<ClientToolResults> clientToolResults`

                              Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

                              - `class BetaWebFetchUrlSourceAll`

                                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 BetaWebFetchUrlSourceNone`

                                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 BetaWebFetchUrlSourceOnly`

                                The tool filter variant under which only the named tools' results
                                contribute.

                                - `JsonValue type = "only"`

                                - `List<BetaWebFetchUrlSourceToolReference> tools`

                                  - `JsonValue type = "tool_reference"`

                                  - `String name`

                              - `class BetaWebFetchUrlSourceExcept`

                                The tool filter variant under which every result but the named
                                tools' contributes.

                                - `JsonValue type = "except"`

                                - `List<BetaWebFetchUrlSourceToolReference> tools`

                                  - `JsonValue type = "tool_reference"`

                                  - `String name`

                            - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

                                The `url_sources` variant under which a source contributes in
                                full: every result of the tool filter's source, or all user input.

                              - `class BetaWebFetchUrlSourceNone`

                                The `url_sources` variant under which a source contributes nothing:
                                no result of the tool filter's source, or no user input.

                              - `class BetaWebFetchUrlSourceOnly`

                                The tool filter variant under which only the named tools' results
                                contribute.

                              - `class BetaWebFetchUrlSourceExcept`

                                The tool filter variant under which every result but the named
                                tools' contributes.

                            - `Optional<UserInput> userInput`

                              Whether URLs in user messages are fetchable: "all" or "none".

                              - `class BetaWebFetchUrlSourceAll`

                                The `url_sources` variant under which a source contributes in
                                full: every result of the tool filter's source, or all user input.

                              - `class BetaWebFetchUrlSourceNone`

                                The `url_sources` variant under which a source contributes nothing:
                                no result of the tool filter's source, or no user input.

                        - `class BetaWebSearchTool20260209`

                          - `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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<List<String>> allowedDomains`

                            If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                          - `Optional<List<String>> blockedDomains`

                            If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Long> maxUses`

                            Maximum number of times the tool can be used in the API request.

                            minimum: 1

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                          - `Optional<BetaUserLocation> userLocation`

                            Parameters for the user's location. Used to provide more relevant search results.

                        - `class BetaWebFetchTool20260209`

                          - `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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<List<String>> allowedDomains`

                            List of domains to allow fetching from

                          - `Optional<List<String>> blockedDomains`

                            List of domains to block fetching from

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<BetaCitationsConfigParam> citations`

                            Citations configuration for fetched documents. Citations are disabled by default.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Long> 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<Long> maxUses`

                            Maximum number of times the tool can be used in the API request.

                            minimum: 1

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                          - `Optional<BetaWebFetchUrlSources> urlSources`

                            Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                        - `class BetaWebFetchTool20260309`

                          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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<List<String>> allowedDomains`

                            List of domains to allow fetching from

                          - `Optional<List<String>> blockedDomains`

                            List of domains to block fetching from

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<BetaCitationsConfigParam> citations`

                            Citations configuration for fetched documents. Citations are disabled by default.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Long> 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<Long> maxUses`

                            Maximum number of times the tool can be used in the API request.

                            minimum: 1

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                          - `Optional<BetaWebFetchUrlSources> urlSources`

                            Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                          - `Optional<Boolean> 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 BetaWebSearchTool20260318`

                          - `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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<List<String>> allowedDomains`

                            If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                          - `Optional<List<String>> blockedDomains`

                            If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Long> maxUses`

                            Maximum number of times the tool can be used in the API request.

                            minimum: 1

                          - `Optional<ResponseInclusion> 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<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                          - `Optional<BetaUserLocation> userLocation`

                            Parameters for the user's location. Used to provide more relevant search results.

                        - `class BetaWebFetchTool20260318`

                          - `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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<List<String>> allowedDomains`

                            List of domains to allow fetching from

                          - `Optional<List<String>> blockedDomains`

                            List of domains to block fetching from

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<BetaCitationsConfigParam> citations`

                            Citations configuration for fetched documents. Citations are disabled by default.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Long> 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<Long> maxUses`

                            Maximum number of times the tool can be used in the API request.

                            minimum: 1

                          - `Optional<ResponseInclusion> 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<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                          - `Optional<BetaWebFetchUrlSources> urlSources`

                            Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                          - `Optional<Boolean> 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 BetaAdvisorTool20260301`

                          - `JsonValue type = "advisor_20260301"`

                          - `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 name = "advisor"`

                            Name of the tool.

                            This is how the tool will be called by the model and in `tool_use` blocks.

                          - `Optional<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<BetaCacheControlEphemeral> caching`

                            Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Long> maxTokens`

                            Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

                            minimum: 1024

                          - `Optional<Long> maxUses`

                            Maximum number of times the tool can be used in the API request.

                            minimum: 1

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaToolSearchToolRegex20251119`

                          - `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<List<AllowedCaller>> allowedCallers`

                            - `DIRECT("direct")`

                            - `CODE_EXECUTION_20250825("code_execution_20250825")`

                            - `CODE_EXECUTION_20260120("code_execution_20260120")`

                            - `CODE_EXECUTION_20260521("code_execution_20260521")`

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Boolean> deferLoading`

                            If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                          - `Optional<Boolean> strict`

                            When true, guarantees schema validation on tool names and inputs

                        - `class BetaMcpToolset`

                          Configuration for a group of tools from an MCP server.

                          Allows configuring enabled status and defer_loading for all tools
                          from an MCP server, with optional per-tool overrides.

                          - `JsonValue type = "mcp_toolset"`

                          - `String mcpServerName`

                            Name of the MCP server to configure tools for

                            minLength: 1, maxLength: 255

                          - `Optional<BetaCacheControlEphemeral> cacheControl`

                            Create a cache control breakpoint at this content block.

                          - `Optional<Configs> configs`

                            Configuration overrides for specific tools, keyed by tool name

                            - `Optional<Boolean> deferLoading`

                            - `Optional<Boolean> enabled`

                          - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

                            Default configuration applied to all tools from this server

                            - `Optional<Boolean> deferLoading`

                            - `Optional<Boolean> enabled`

                          - `Optional<List<BetaMcpToolParam>> tools`

                            The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

                            - `InputSchema inputSchema`

                              The tool's input schema as the MCP server lists it, verbatim.

                            - `String name`

                              The tool's name as the MCP server lists it (not prefixed with the server name).

                              minLength: 1

                            - `Optional<String> description`

                              The tool's description as the MCP server lists it.

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

                - `class BetaRequestToolRemovalBlock`

                  Mid-conversation directive to withdraw a tool.

                  `tool` references a tool (or MCP toolset) by name: one declared in the
                  request's `tools` or defined earlier in `messages`. It is no longer
                  offered to the model from this point in the conversation onward.

                  - `JsonValue type = "tool_removal"`

                  - `Tool tool`

                    - `class BetaToolChangeToolReference`

                      Reference to a single tool, by the name the model uses to call it: a
                      tool declared in `tools` or defined by an earlier `tool_addition`
                      block. Does not accept the composed `{server}_{name}` form the server
                      assigns to MCP-resolved tools; use `mcp_tool_reference` or
                      `mcp_toolset_reference` for those.

                    - `class BetaToolChangeMcpToolReference`

                      Reference to a single MCP tool by its server and remote name; the
                      same `server_name`/`name` pair `mcp_tool_use` carries.

                    - `class BetaToolChangeMcpToolsetReference`

                      Reference to every tool in the named MCP server's toolset.

                  - `Optional<BetaCacheControlEphemeral> cacheControl`

                    Create a cache control breakpoint at this content block.

            - `class BetaRequestToolAdditionBlock`

              Mid-conversation directive to make a tool available.

              `tool` is a reference to a tool (or MCP toolset) declared in the
              request's `tools`. Under the `inline-tools-2026-09-15` beta it may
              instead be a reference to a tool defined earlier in `messages`, or a
              `tool_definition` object that carries an inline tool definition in
              `definition` (the same object a `tools` entry holds). An `mcp_toolset`
              definition also requires the `mcp-client-2026-09-15` beta. The tool is
              offered to the model from this point in the conversation onward.

            - `class BetaRequestToolRemovalBlock`

              Mid-conversation directive to withdraw a tool.

              `tool` references a tool (or MCP toolset) by name: one declared in the
              request's `tools` or defined earlier in `messages`. It is no longer
              offered to the model from this point in the conversation onward.

            - `class BetaMcpToolListingBlockParam`

              The tool listing an MCP server returned while an earlier response was
              produced, as that response carried it. Send the assistant message back
              unchanged, this block included, and the server uses this listing for the
              matching `mcp_toolset` instead of asking the MCP server again.

              - `JsonValue type = "mcp_tool_listing"`

              - `String mcpServerName`

                The name of the MCP server this listing came from, as `mcp_servers` declares it.

                minLength: 1, maxLength: 255

              - `List<BetaMcpToolParam> tools`

                The server's tools, exactly as the response listed them.

                - `InputSchema inputSchema`

                  The tool's input schema as the MCP server lists it, verbatim.

                - `String name`

                  The tool's name as the MCP server lists it (not prefixed with the server name).

                  minLength: 1

                - `Optional<String> description`

                  The tool's description as the MCP server lists it.

            - `class BetaFallbackBlockParam`

              A `fallback` block echoed back from a prior response.

              Accepted in `messages[].content` and not rendered into the prompt; not
              validated against the request's `fallbacks` chain or top-level `model`.

              Echo the assistant turn back verbatim, including this block in its
              original position. The block marks the boundary between content produced
              before and after a fallback hop, and the server relies on that boundary
              to validate the turn: when thinking runs flank the boundary, omitting
              the block merges them into one span the server cannot validate (the
              request is rejected), and moving it into the middle of a single run is
              likewise rejected; between non-thinking blocks the block's placement has
              no validation effect.

              - `JsonValue type = "fallback"`

              - `BetaFallbackInfoParam from`

                Identifies one hop of a fallback transition.

                - `Model model`

                  The model that will complete your prompt.

                  See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

              - `BetaFallbackInfoParam to`

                Identifies one hop of a fallback transition.

              - `Optional<JsonValue> trigger`

                The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed.

        - `Role role`

          - `USER("user")`

          - `ASSISTANT("assistant")`

          - `SYSTEM("system")`

        - `Optional<ClearAt> clearAt`

          How long this system message's text stays in front of the model. `"never"` (the default) renders it on every request that includes it. `"next_user_message"` renders it only for the user turn it follows: once a later `role: "user"` message exists in `messages` the message stays in the array (send it unchanged) but is no longer shown to the model. Only permitted on `role: "system"` messages.

          - `NEXT_USER_MESSAGE("next_user_message")`

          - `NEVER("never")`

        - `Optional<BetaSystemMessageOutputConfig> outputConfig`

          Per-message output configuration on a role:"system" input message.

          Fields here apply per-turn; `format` remains top-level only. An
          empty `{}` is accepted on a message that carries content; a message
          with neither content nor output_config fields is rejected.

          - `Optional<Effort> 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")`

      - `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<BetaCacheControlEphemeral> cacheControl`

        Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.

      - `Optional<BetaCompactionConfig> compaction`

        Compaction configuration.

        When set on `POST /v1/messages`, the request is a compaction request: the conversation in `messages` is summarized and the response holds only the resulting `compaction` block (`stop_reason` `"compaction"`), which later requests send first in `messages` in place of the messages it summarizes. `POST /v1/messages/count_tokens` accepts this parameter and ignores it: the count it returns is for the conversation in `messages` as sent. Cannot be combined with `context_management`.

        - `JsonValue type = "summarize"`

        - `Optional<String> instructions`

          Replaces the server's default summarization prompt for this request. An empty or whitespace-only value counts as absent.

          maxLength: 16384

      - `Optional<Container> container`

        Container identifier for reuse across requests.

        - `class BetaContainerParams`

          Container parameters with skills to be loaded.

          - `Optional<String> id`

            Container id

          - `Optional<List<BetaSkillParams>> 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<String> version`

              Skill version or 'latest' for most recent version

              minLength: 1, maxLength: 64

        - `String`

      - `Optional<BetaContextManagementConfig> contextManagement`

        Context management configuration.

        This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not.

        - `Optional<List<Edit>> edits`

          List of context management edits to apply

          - `class BetaClearToolUses20250919Edit`

            - `JsonValue type = "clear_tool_uses_20250919"`

            - `Optional<BetaInputTokensClearAtLeast> clearAtLeast`

              Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.

              - `JsonValue type = "input_tokens"`

              - `long value`

                minimum: 0

            - `Optional<ClearToolInputs> clearToolInputs`

              Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)

              - `boolean`

              - `List<String>`

            - `Optional<List<String>> excludeTools`

              Tool names whose uses are preserved from clearing

            - `Optional<BetaToolUsesKeep> keep`

              Number of tool uses to retain in the conversation

              - `JsonValue type = "tool_uses"`

              - `long value`

                minimum: 0

            - `Optional<Trigger> trigger`

              Condition that triggers the context management strategy

              - `class BetaInputTokensTrigger`

                - `JsonValue type = "input_tokens"`

                - `long value`

                  minimum: 1

              - `class BetaToolUsesTrigger`

                - `JsonValue type = "tool_uses"`

                - `long value`

                  minimum: 1

          - `class BetaClearThinking20251015Edit`

            - `JsonValue type = "clear_thinking_20251015"`

            - `Optional<Keep> keep`

              Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.

              - `class BetaThinkingTurns`

                - `JsonValue type = "thinking_turns"`

                - `long value`

                  minimum: 1

              - `class BetaAllThinkingTurns`

                - `JsonValue type = "all"`

              - `JsonValue`

          - `class BetaCompact20260112Edit`

            Automatically compact older context when reaching the configured trigger threshold.

            - `JsonValue type = "compact_20260112"`

            - `Optional<String> instructions`

              Additional instructions for summarization.

            - `Optional<Boolean> pauseAfterCompaction`

              Whether to pause after compaction and return the compaction block to the user.

            - `Optional<BetaInputTokensTrigger> trigger`

              When to trigger compaction. Defaults to 150000 input tokens.

      - `Optional<BetaDiagnosticsParam> 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<String> 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<FallbackCreditToken> fallbackCreditToken`

        The `fallback_credit_token` from a prior refusal's `stop_details`.

        When a preceding request was refused and returned a `fallback_credit_token`,
        pass that code here on the retry to have the retry's cache-creation tokens
        for the prefix that was warm on the refused model billed at the cache-read
        rate. Must be redeemed by the same organization and workspace, with the same
        request body (optionally extended by one appended `assistant` message whose
        content is the partial text — with any trailing whitespace stripped from
        the final text block — and paired server-tool blocks streamed before the
        refusal; the appended-assistant form is not available for requests with
        `output_format` set or forced `tool_choice`), on an eligible fallback
        model, on the same platform,
        and within 5 minutes of the refusal; a mismatch is a 400. A token minted
        mid-server-tool-loop whose partial content was continuable may only be
        redeemed with the appended-assistant form — if an exact-body retry is
        rejected with a 400 saying the token must be redeemed by continuing the
        partial response, retry with the appended-assistant form instead.

        When the appended-assistant form is used on a model that otherwise disallows
        assistant-turn prefill, this token also authorizes that one prefill.

        - `String`

        - `class BetaFallbackCreditTokenParam`

          Object form of `fallback_credit_token`: the token plus a redemption
          mode.

          Requires `anthropic-beta: fallback-credit-2026-07-01`; without that
          header the field accepts the bare string only. The bare string and the
          mode-less object are equivalent (both select `strict`), so wrapping
          an existing token changes nothing by itself.

          - `String token`

            The opaque `fallback_credit_token` from a prior refusal's `stop_details` — the same string the bare-string form carries.

            minLength: 1, maxLength: 2048

          - `Optional<Mode> mode`

            How a failing token affects the retry. `strict` (the default, and the bare-string behavior): a failing redemption is a 400 and the retry is not served. `best_effort`: the retry is served either way — a token-layer failure no longer rejects the request; the retry proceeds at normal price and the outcome is reported on the response's `usage.fallback_credit`. Two failures stay hard in both modes: a malformed token, and combining `fallback_credit_token` with `fallbacks`.

            - `STRICT("strict")`

            - `BEST_EFFORT("best_effort")`

      - `Optional<BetaFallbacksParam> fallbacks`

        Opt-in server-side retry on one or more substitute models when the requested model declines for policy reasons. Tried in order: if the first entry also declines, the second is tried, and so on. Some models don't support fallbacks; on those models, a list of fallback models returns a 400 error. See [Server-side fallback](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=java#server-side-fallback). The string "default" requests the requested model's server-defined default fallback configuration. On a model that doesn't support fallbacks, the request runs on the requested model alone, so a declined request stays declined.

        - `List<BetaFallbackParam>`

          - `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<Long> maxTokens`

          - `Optional<BetaOutputConfig> outputConfig`

            - `Optional<Effort> 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<BetaJsonOutputFormat> 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<BetaTokenTaskBudget> taskBudget`

              Configuration for token budget tracking across contexts.

              - `JsonValue type = "tokens"`

                The budget type. Currently only 'tokens' is supported.

              - `long total`

                Total token budget across all contexts in the session.

                minimum: 1024

              - `Optional<Long> remaining`

                Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided.

                minimum: 0

          - `Optional<Speed> speed`

            Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.

            - `STANDARD("standard")`

            - `FAST("fast")`

          - `Optional<Thinking> thinking`

            - `class BetaThinkingConfigEnabled`

              - `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<BetaThinkingBlockBinding> blockBinding`

                Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.

                - `Optional<BetaThinkingPrefixMismatchBehavior> prefixMismatchBehavior`

                  "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`.

                  - `ERROR("error")`

                  - `DROP_BLOCK("drop_block")`

              - `Optional<Display> 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")`

                - `UPDATES("updates")`

            - `class BetaThinkingConfigDisabled`

              - `JsonValue type = "disabled"`

            - `class BetaThinkingConfigBetweenTools`

              - `JsonValue type = "between_tools"`

            - `class BetaThinkingConfigAdaptive`

              - `JsonValue type = "adaptive"`

              - `Optional<BetaThinkingBlockBinding> blockBinding`

                Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.

              - `Optional<Display> 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")`

                - `UPDATES("updates")`

        - `JsonValue`

      - `Optional<String> inferenceGeo`

        Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used.

      - `Optional<List<BetaRequestMcpServerUrlDefinition>> mcpServers`

        MCP servers to be utilized in this request

        maxItems: 20

        - `JsonValue type = "url"`

        - `String name`

        - `String url`

        - `Optional<String> authorizationToken`

        - `Optional<BetaRequestMcpServerToolConfiguration> toolConfiguration`

          - `Optional<List<String>> allowedTools`

          - `Optional<Boolean> enabled`

      - `Optional<BetaMetadata> metadata`

        An object describing metadata about the request.

        - `Optional<String> 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<BetaOutputConfig> outputConfig`

        Configuration options for the model's output, such as the output format.

      - `Optional<ServiceTier> 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> 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<List<String>> 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<Boolean> 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`

        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<BetaTextBlockParam>`

          - `JsonValue type = "text"`

          - `String text`

            minLength: 1

          - `Optional<BetaCacheControlEphemeral> cacheControl`

            Create a cache control breakpoint at this content block.

          - `Optional<List<BetaTextCitationParam>> citations`

      - `Optional<BetaThinkingConfigParam> 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 BetaThinkingConfigEnabled`

        - `class BetaThinkingConfigDisabled`

        - `class BetaThinkingConfigBetweenTools`

        - `class BetaThinkingConfigAdaptive`

      - `Optional<BetaToolChoice> 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 BetaToolChoiceAuto`

          The model will automatically decide whether to use tools.

          - `JsonValue type = "auto"`

          - `Optional<Boolean> disableParallelToolUse`

            Whether to disable parallel tool use.

            Defaults to `false`. If set to `true`, the model will output at most one tool use.

        - `class BetaToolChoiceAny`

          The model will use any available tools.

          - `JsonValue type = "any"`

          - `Optional<Boolean> disableParallelToolUse`

            Whether to disable parallel tool use.

            Defaults to `false`. If set to `true`, the model will output exactly one tool use.

        - `class BetaToolChoiceTool`

          The model will use the specified tool with `tool_choice.name`.

          - `JsonValue type = "tool"`

          - `String name`

            The name of the tool to use.

          - `Optional<Boolean> disableParallelToolUse`

            Whether to disable parallel tool use.

            Defaults to `false`. If set to `true`, the model will output exactly one tool use.

        - `class BetaToolChoiceNone`

          The model will not be allowed to use tools.

          - `JsonValue type = "none"`

      - `Optional<List<BetaToolUnion>> 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 BetaTool`

        - `class BetaToolBash20241022`

        - `class BetaToolBash20250124`

        - `class BetaCodeExecutionTool20250522`

        - `class BetaCodeExecutionTool20250825`

        - `class BetaCodeExecutionTool20260120`

          Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).

        - `class BetaCodeExecutionTool20260521`

          Code execution tool with REPL state persistence.

        - `class BetaBrowserToolset20260801`

          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.

        - `class BetaToolComputerUse20241022`

        - `class BetaMemoryTool20250818`

        - `class BetaToolComputerUse20250124`

        - `class BetaToolTextEditor20241022`

        - `class BetaToolComputerUse20251124`

        - `class BetaComputerToolset20260801`

          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`.

        - `class BetaToolTextEditor20250124`

        - `class BetaToolTextEditor20250429`

        - `class BetaToolTextEditor20250728`

        - `class BetaWebSearchTool20250305`

        - `class BetaWebFetchTool20250910`

        - `class BetaWebSearchTool20260209`

        - `class BetaWebFetchTool20260209`

        - `class BetaWebFetchTool20260309`

          Web fetch tool with use_cache parameter for bypassing cached content.

        - `class BetaWebSearchTool20260318`

        - `class BetaWebFetchTool20260318`

        - `class BetaAdvisorTool20260301`

        - `class BetaToolSearchToolBm25_20251119`

        - `class BetaToolSearchToolRegex20251119`

        - `class BetaMcpToolset`

          Configuration for a group of tools from an MCP server.

          Allows configuring enabled status and defer_loading for all tools
          from an MCP server, with optional per-tool overrides.

      - `Optional<BetaJsonOutputFormat> outputFormat`

        **Deprecated**

        Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=java)

        A schema to specify Claude's output format in responses. This parameter will be removed in a future release.

      - `Optional<Double> 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<Long> 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<Double> 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 BetaMessageBatch`

  - `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<LocalDateTime> archivedAt`

    RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.

    format: date-time

  - `Optional<LocalDateTime> 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<LocalDateTime> 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")`

  - `BetaMessageBatchRequestCounts 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<String> 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.beta.messages.batches.BatchCreateParams;
import com.anthropic.models.beta.messages.batches.BetaMessageBatch;
import com.anthropic.models.messages.Model;

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();
        BetaMessageBatch betaMessageBatch = client.beta().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

`BetaMessageBatch beta().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<String> messageBatchId` (path parameter)

    ID of the Message Batch.

  - `Optional<List<AnthropicBeta>> betas` (header parameter)

    Optional header to specify the beta version(s) you want to use.

    - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")`

    - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")`

    - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")`

    - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")`

    - `PDFS_2024_09_25("pdfs-2024-09-25")`

    - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")`

    - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")`

    - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")`

    - `FILES_API_2025_04_14("files-api-2025-04-14")`

    - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")`

    - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")`

    - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")`

    - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")`

    - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")`

    - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")`

    - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")`

    - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")`

    - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")`

    - `SKILLS_2025_10_02("skills-2025-10-02")`

    - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")`

    - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")`

    - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")`

    - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")`

    - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")`

    - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")`

    - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")`

    - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")`

    - `DREAMING_2026_04_21("dreaming-2026-04-21")`

    - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")`

    - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")`

    - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")`

    - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")`

    - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")`

    - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")`

    - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")`

    - `COMPACT_2026_01_12("compact-2026-01-12")`

    - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")`

    - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")`

    - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")`

    - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")`

    - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")`

    - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")`

    - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")`

    - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")`

    - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")`

    - `COMPACT_2026_09_04("compact-2026-09-04")`

    - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")`

    - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")`

    - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")`

    - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")`

    - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")`

  - `Optional<String> 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 BetaMessageBatch`

  - `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<LocalDateTime> archivedAt`

    RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.

    format: date-time

  - `Optional<LocalDateTime> 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<LocalDateTime> 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")`

  - `BetaMessageBatchRequestCounts 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<String> 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.beta.messages.batches.BatchRetrieveParams;
import com.anthropic.models.beta.messages.batches.BetaMessageBatch;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        BetaMessageBatch betaMessageBatch = client.beta().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 beta().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<String> 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<String> 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<Long> limit` (query parameter)

    Number of items to return per page.

    Defaults to `20`. Ranges from `1` to `1000`.

    minimum: 1, maximum: 1000

  - `Optional<List<AnthropicBeta>> betas` (header parameter)

    Optional header to specify the beta version(s) you want to use.

    - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")`

    - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")`

    - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")`

    - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")`

    - `PDFS_2024_09_25("pdfs-2024-09-25")`

    - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")`

    - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")`

    - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")`

    - `FILES_API_2025_04_14("files-api-2025-04-14")`

    - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")`

    - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")`

    - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")`

    - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")`

    - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")`

    - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")`

    - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")`

    - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")`

    - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")`

    - `SKILLS_2025_10_02("skills-2025-10-02")`

    - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")`

    - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")`

    - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")`

    - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")`

    - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")`

    - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")`

    - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")`

    - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")`

    - `DREAMING_2026_04_21("dreaming-2026-04-21")`

    - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")`

    - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")`

    - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")`

    - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")`

    - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")`

    - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")`

    - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")`

    - `COMPACT_2026_01_12("compact-2026-01-12")`

    - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")`

    - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")`

    - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")`

    - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")`

    - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")`

    - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")`

    - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")`

    - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")`

    - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")`

    - `COMPACT_2026_09_04("compact-2026-09-04")`

    - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")`

    - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")`

    - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")`

    - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")`

    - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")`

  - `Optional<String> 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 BetaMessageBatch`

  - `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<LocalDateTime> archivedAt`

    RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.

    format: date-time

  - `Optional<LocalDateTime> 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<LocalDateTime> 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")`

  - `BetaMessageBatchRequestCounts 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<String> 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.beta.messages.batches.BatchListPage;
import com.anthropic.models.beta.messages.batches.BatchListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        BatchListPage page = client.beta().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

`BetaMessageBatch beta().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<String> messageBatchId` (path parameter)

    ID of the Message Batch.

  - `Optional<List<AnthropicBeta>> betas` (header parameter)

    Optional header to specify the beta version(s) you want to use.

    - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")`

    - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")`

    - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")`

    - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")`

    - `PDFS_2024_09_25("pdfs-2024-09-25")`

    - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")`

    - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")`

    - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")`

    - `FILES_API_2025_04_14("files-api-2025-04-14")`

    - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")`

    - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")`

    - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")`

    - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")`

    - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")`

    - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")`

    - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")`

    - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")`

    - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")`

    - `SKILLS_2025_10_02("skills-2025-10-02")`

    - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")`

    - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")`

    - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")`

    - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")`

    - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")`

    - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")`

    - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")`

    - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")`

    - `DREAMING_2026_04_21("dreaming-2026-04-21")`

    - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")`

    - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")`

    - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")`

    - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")`

    - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")`

    - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")`

    - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")`

    - `COMPACT_2026_01_12("compact-2026-01-12")`

    - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")`

    - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")`

    - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")`

    - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")`

    - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")`

    - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")`

    - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")`

    - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")`

    - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")`

    - `COMPACT_2026_09_04("compact-2026-09-04")`

    - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")`

    - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")`

    - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")`

    - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")`

    - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")`

  - `Optional<String> 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 BetaMessageBatch`

  - `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<LocalDateTime> archivedAt`

    RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.

    format: date-time

  - `Optional<LocalDateTime> 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<LocalDateTime> 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")`

  - `BetaMessageBatchRequestCounts 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<String> 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.beta.messages.batches.BatchCancelParams;
import com.anthropic.models.beta.messages.batches.BetaMessageBatch;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        BetaMessageBatch betaMessageBatch = client.beta().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

`BetaDeletedMessageBatch beta().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<String> messageBatchId` (path parameter)

    ID of the Message Batch.

  - `Optional<List<AnthropicBeta>> betas` (header parameter)

    Optional header to specify the beta version(s) you want to use.

    - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")`

    - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")`

    - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")`

    - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")`

    - `PDFS_2024_09_25("pdfs-2024-09-25")`

    - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")`

    - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")`

    - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")`

    - `FILES_API_2025_04_14("files-api-2025-04-14")`

    - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")`

    - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")`

    - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")`

    - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")`

    - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")`

    - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")`

    - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")`

    - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")`

    - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")`

    - `SKILLS_2025_10_02("skills-2025-10-02")`

    - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")`

    - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")`

    - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")`

    - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")`

    - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")`

    - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")`

    - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")`

    - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")`

    - `DREAMING_2026_04_21("dreaming-2026-04-21")`

    - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")`

    - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")`

    - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")`

    - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")`

    - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")`

    - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")`

    - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")`

    - `COMPACT_2026_01_12("compact-2026-01-12")`

    - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")`

    - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")`

    - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")`

    - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")`

    - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")`

    - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")`

    - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")`

    - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")`

    - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")`

    - `COMPACT_2026_09_04("compact-2026-09-04")`

    - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")`

    - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")`

    - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")`

    - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")`

    - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")`

  - `Optional<String> 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 BetaDeletedMessageBatch`

  - `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.beta.messages.batches.BatchDeleteParams;
import com.anthropic.models.beta.messages.batches.BetaDeletedMessageBatch;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        BetaDeletedMessageBatch betaDeletedMessageBatch = client.beta().messages().batches().delete("message_batch_id");
    }
}
```

##### Response (200)

```json
{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch_deleted"
}
```

### Retrieve Message Batch results

`StreamResponse<BetaMessageBatchIndividualResponse> beta().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<String> messageBatchId` (path parameter)

    ID of the Message Batch.

  - `Optional<List<AnthropicBeta>> betas` (header parameter)

    Optional header to specify the beta version(s) you want to use.

    - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")`

    - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")`

    - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")`

    - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")`

    - `PDFS_2024_09_25("pdfs-2024-09-25")`

    - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")`

    - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")`

    - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")`

    - `FILES_API_2025_04_14("files-api-2025-04-14")`

    - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")`

    - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")`

    - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")`

    - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")`

    - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")`

    - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")`

    - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")`

    - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")`

    - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")`

    - `SKILLS_2025_10_02("skills-2025-10-02")`

    - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")`

    - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")`

    - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")`

    - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")`

    - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")`

    - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")`

    - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")`

    - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")`

    - `DREAMING_2026_04_21("dreaming-2026-04-21")`

    - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")`

    - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")`

    - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")`

    - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")`

    - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")`

    - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")`

    - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")`

    - `COMPACT_2026_01_12("compact-2026-01-12")`

    - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")`

    - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")`

    - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")`

    - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")`

    - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")`

    - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")`

    - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")`

    - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")`

    - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")`

    - `COMPACT_2026_09_04("compact-2026-09-04")`

    - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")`

    - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")`

    - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")`

    - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")`

    - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")`

  - `Optional<String> 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 BetaMessageBatchIndividualResponse`

  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.

  - `BetaMessageBatchResult 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 BetaMessageBatchSucceededResult`

      - `JsonValue type = "succeeded"`

      - `BetaMessage 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<BetaContainer> 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<List<BetaContainerSkill>> 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<BetaContentBlock> 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 BetaTextBlock`

            - `JsonValue type = "text"`

            - `Optional<List<BetaTextCitation>> 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 BetaCitationCharLocation`

                - `JsonValue type = "char_location"`

                - `String citedText`

                - `long documentIndex`

                  minimum: 0

                - `Optional<String> documentTitle`

                - `long endCharIndex`

                - `Optional<String> fileId`

                - `long startCharIndex`

                  minimum: 0

              - `class BetaCitationPageLocation`

                - `JsonValue type = "page_location"`

                - `String citedText`

                - `long documentIndex`

                  minimum: 0

                - `Optional<String> documentTitle`

                - `long endPageNumber`

                - `Optional<String> fileId`

                - `long startPageNumber`

                  minimum: 1

              - `class BetaCitationContentBlockLocation`

                - `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<String> 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<String> fileId`

                - `long startBlockIndex`

                  0-based index of the first cited block in the source's `content` array.

                  minimum: 0

              - `class BetaCitationsWebSearchResultLocation`

                - `JsonValue type = "web_search_result_location"`

                - `String citedText`

                - `String encryptedIndex`

                - `Optional<String> title`

                  maxLength: 512

                - `String url`

              - `class BetaCitationSearchResultLocation`

                - `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<String> title`

            - `String text`

          - `class BetaThinkingBlock`

            - `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 BetaRedactedThinkingBlock`

            - `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 BetaToolUseBlock`

            - `JsonValue type = "tool_use"`

            - `String id`

              pattern: ^[a-zA-Z0-9_-]+$

            - `Input input`

            - `String name`

              minLength: 1

            - `Optional<Caller> caller`

              - `class BetaDirectCaller`

                Tool invocation directly from the model.

                - `JsonValue type = "direct"`

              - `class BetaServerToolCaller`

                Tool invocation generated by a server-side tool.

                - `JsonValue type = "code_execution_20250825"`

                - `String toolId`

                  pattern: ^srvtoolu_[a-zA-Z0-9_]+$

              - `class BetaServerToolCaller20260120`

                - `JsonValue type = "code_execution_20260120"`

                - `String toolId`

                  pattern: ^srvtoolu_[a-zA-Z0-9_]+$

            - `Optional<String> toolsetName`

              For a toolset member tool_use, the toolset family.

              minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$

          - `class BetaServerToolUseBlock`

            - `JsonValue type = "server_tool_use"`

            - `String id`

              pattern: ^srvtoolu_[a-zA-Z0-9_]+$

            - `Input input`

            - `Name name`

              - `ADVISOR("advisor")`

              - `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<Caller> caller`

              - `class BetaDirectCaller`

                Tool invocation directly from the model.

              - `class BetaServerToolCaller`

                Tool invocation generated by a server-side tool.

              - `class BetaServerToolCaller20260120`

          - `class BetaWebSearchToolResultBlock`

            - `JsonValue type = "web_search_tool_result"`

            - `BetaWebSearchToolResultBlockContent content`

              - `class BetaWebSearchToolResultError`

                - `JsonValue type = "web_search_tool_result_error"`

                - `BetaWebSearchToolResultErrorCode 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<BetaWebSearchResultBlock>`

                - `JsonValue type = "web_search_result"`

                - `String encryptedContent`

                - `Optional<String> pageAge`

                - `String title`

                - `String url`

            - `String toolUseId`

              pattern: ^srvtoolu_[a-zA-Z0-9_]+$

            - `Optional<Caller> caller`

              - `class BetaDirectCaller`

                Tool invocation directly from the model.

              - `class BetaServerToolCaller`

                Tool invocation generated by a server-side tool.

              - `class BetaServerToolCaller20260120`

          - `class BetaWebFetchToolResultBlock`

            - `JsonValue type = "web_fetch_tool_result"`

            - `Content content`

              - `class BetaWebFetchToolResultErrorBlock`

                - `JsonValue type = "web_fetch_tool_result_error"`

                - `BetaWebFetchToolResultErrorCode 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 BetaWebFetchBlock`

                - `JsonValue type = "web_fetch_result"`

                - `BetaDocumentBlock content`

                  - `JsonValue type = "document"`

                  - `Optional<BetaCitationConfig> citations`

                    Citation configuration for the document

                    - `boolean enabled`

                  - `Source source`

                    - `class BetaBase64PdfSource`

                      - `JsonValue type = "base64"`

                      - `String data`

                        format: byte

                      - `JsonValue mediaType = "application/pdf"`

                    - `class BetaPlainTextSource`

                      - `JsonValue type = "text"`

                      - `String data`

                      - `JsonValue mediaType = "text/plain"`

                  - `Optional<String> title`

                    The title of the document

                - `Optional<String> retrievedAt`

                  ISO 8601 timestamp when the content was retrieved

                - `String url`

                  Fetched content URL

            - `String toolUseId`

              pattern: ^srvtoolu_[a-zA-Z0-9_]+$

            - `Optional<Caller> caller`

              - `class BetaDirectCaller`

                Tool invocation directly from the model.

              - `class BetaServerToolCaller`

                Tool invocation generated by a server-side tool.

              - `class BetaServerToolCaller20260120`

          - `class BetaAdvisorToolResultBlock`

            - `JsonValue type = "advisor_tool_result"`

            - `Content content`

              - `class BetaAdvisorToolResultError`

                - `JsonValue type = "advisor_tool_result_error"`

                - `ErrorCode errorCode`

                  - `MAX_USES_EXCEEDED("max_uses_exceeded")`

                  - `PROMPT_TOO_LONG("prompt_too_long")`

                  - `TOO_MANY_REQUESTS("too_many_requests")`

                  - `OVERLOADED("overloaded")`

                  - `UNAVAILABLE("unavailable")`

                  - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

                  - `MODEL_NOT_FOUND("model_not_found")`

              - `class BetaAdvisorResultBlock`

                - `JsonValue type = "advisor_result"`

                - `Optional<String> stopReason`

                  The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap.

                - `String text`

              - `class BetaAdvisorRedactedResultBlock`

                - `JsonValue type = "advisor_redacted_result"`

                - `String encryptedContent`

                  Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify.

                - `Optional<String> stopReason`

                  The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`).

            - `String toolUseId`

              pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `class BetaCodeExecutionToolResultBlock`

            - `JsonValue type = "code_execution_tool_result"`

            - `BetaCodeExecutionToolResultBlockContent content`

              - `class BetaCodeExecutionToolResultError`

                - `JsonValue type = "code_execution_tool_result_error"`

                - `BetaCodeExecutionToolResultErrorCode errorCode`

                  - `INVALID_TOOL_INPUT("invalid_tool_input")`

                  - `UNAVAILABLE("unavailable")`

                  - `TOO_MANY_REQUESTS("too_many_requests")`

                  - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

              - `class BetaCodeExecutionResultBlock`

                - `JsonValue type = "code_execution_result"`

                - `List<BetaCodeExecutionOutputBlock> content`

                  - `JsonValue type = "code_execution_output"`

                  - `String fileId`

                - `long returnCode`

                - `String stderr`

                - `String stdout`

              - `class BetaEncryptedCodeExecutionResultBlock`

                Code execution result with encrypted stdout for PFC + web_search results.

                - `JsonValue type = "encrypted_code_execution_result"`

                - `List<BetaCodeExecutionOutputBlock> content`

                  - `JsonValue type = "code_execution_output"`

                  - `String fileId`

                - `String encryptedStdout`

                - `long returnCode`

                - `String stderr`

            - `String toolUseId`

              pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `class BetaBashCodeExecutionToolResultBlock`

            - `JsonValue type = "bash_code_execution_tool_result"`

            - `Content content`

              - `class BetaBashCodeExecutionToolResultError`

                - `JsonValue type = "bash_code_execution_tool_result_error"`

                - `ErrorCode 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 BetaBashCodeExecutionResultBlock`

                - `JsonValue type = "bash_code_execution_result"`

                - `List<BetaBashCodeExecutionOutputBlock> content`

                  - `JsonValue type = "bash_code_execution_output"`

                  - `String fileId`

                - `long returnCode`

                - `String stderr`

                - `String stdout`

            - `String toolUseId`

              pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `class BetaTextEditorCodeExecutionToolResultBlock`

            - `JsonValue type = "text_editor_code_execution_tool_result"`

            - `Content content`

              - `class BetaTextEditorCodeExecutionToolResultError`

                - `JsonValue type = "text_editor_code_execution_tool_result_error"`

                - `ErrorCode 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<String> errorMessage`

              - `class BetaTextEditorCodeExecutionViewResultBlock`

                - `JsonValue type = "text_editor_code_execution_view_result"`

                - `String content`

                - `FileType fileType`

                  - `TEXT("text")`

                  - `IMAGE("image")`

                  - `PDF("pdf")`

                - `Optional<Long> numLines`

                - `Optional<Long> startLine`

                - `Optional<Long> totalLines`

              - `class BetaTextEditorCodeExecutionCreateResultBlock`

                - `JsonValue type = "text_editor_code_execution_create_result"`

                - `boolean isFileUpdate`

              - `class BetaTextEditorCodeExecutionStrReplaceResultBlock`

                - `JsonValue type = "text_editor_code_execution_str_replace_result"`

                - `Optional<List<String>> lines`

                - `Optional<Long> newLines`

                - `Optional<Long> newStart`

                - `Optional<Long> oldLines`

                - `Optional<Long> oldStart`

            - `String toolUseId`

              pattern: ^srvtoolu_[a-zA-Z0-9_]+$

          - `class BetaToolSearchToolResultBlock`

            - `JsonValue type = "tool_search_tool_result"`

            - `Content content`

              - `class BetaToolSearchToolResultError`

                - `JsonValue type = "tool_search_tool_result_error"`

                - `ErrorCode errorCode`

                  - `INVALID_TOOL_INPUT("invalid_tool_input")`

                  - `UNAVAILABLE("unavailable")`

                  - `TOO_MANY_REQUESTS("too_many_requests")`

                  - `EXECUTION_TIME_EXCEEDED("execution_time_exceeded")`

                - `Optional<String> errorMessage`

              - `class BetaToolSearchToolSearchResultBlock`

                - `JsonValue type = "tool_search_tool_search_result"`

                - `List<BetaToolReferenceBlock> 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 BetaMcpToolUseBlock`

            - `JsonValue type = "mcp_tool_use"`

            - `String id`

              pattern: ^[a-zA-Z0-9_-]+$

            - `Input input`

            - `String name`

              The name of the MCP tool

            - `String serverName`

              The name of the MCP server

          - `class BetaMcpToolResultBlock`

            - `JsonValue type = "mcp_tool_result"`

            - `Content content`

              - `String`

              - `List<BetaTextBlock>`

                - `JsonValue type = "text"`

                - `Optional<List<BetaTextCitation>> 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`.

                - `String text`

            - `boolean isError`

            - `String toolUseId`

              pattern: ^[a-zA-Z0-9_-]+$

          - `class BetaContainerUploadBlock`

            Response model for a file uploaded to the container.

            - `JsonValue type = "container_upload"`

            - `String fileId`

          - `class BetaCompactionBlock`

            A compaction block returned when autocompact is triggered.

            When content is None, it indicates the compaction failed to produce a valid
            summary (e.g., malformed output from the model). Clients may round-trip
            compaction blocks with null content; the server treats them as no-ops.

            - `JsonValue type = "compaction"`

            - `Optional<String> content`

              Summary of compacted content, or null if compaction failed

            - `Optional<String> encryptedContent`

              Opaque metadata from prior compaction, to be round-tripped verbatim

            - `Optional<String> signature`

              Signature over the summary, to be sent back with the block verbatim

            - `Optional<List<ToolChange>> toolChanges`

              The tool changes of the compacted range: the `tool_addition` and `tool_removal` blocks that take the request's `tools` to the tool set in effect at the end of the range, or `[]` when the range changed no tool. Absent when the server did not compute them. Send the block back unchanged.

              - `class BetaResponseToolAdditionBlock`

                An entry of a `compaction` block's `tool_changes`: a tool the
                compacted range made available, as a reference to a `tools` entry or
                MCP toolset, or as the tool definition in effect at the end of the
                range, by value. Send it back unchanged.

                - `JsonValue type = "tool_addition"`

                - `Tool tool`

                  The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value.

                  - `class BetaResponseToolChangeToolReference`

                    Reference to a single tool, by the name the model uses to call it, as
                    a `compaction` block's `tool_changes` entry reports it: a tool
                    declared in `tools` or defined by an earlier `tool_addition` block.
                    Send it back unchanged with the block.

                    - `JsonValue type = "tool_reference"`

                    - `String name`

                  - `class BetaResponseToolChangeMcpToolReference`

                    Reference to a single MCP tool, by its server and its name on that
                    server, as a `compaction` block's `tool_changes` entry reports it.
                    Send it back unchanged with the block.

                    - `JsonValue type = "mcp_tool_reference"`

                    - `String name`

                    - `String serverName`

                  - `class BetaResponseToolChangeMcpToolsetReference`

                    Reference to every tool in the named MCP server's toolset, as a
                    `compaction` block's `tool_changes` entry reports it. Send it back
                    unchanged with the block.

                    - `JsonValue type = "mcp_toolset_reference"`

                    - `String serverName`

                  - `class BetaToolChangeToolDefinition`

                    A tool defined by value, as a `compaction` block's `tool_changes` entry
                    reports it: `definition` is the tool's definition as it was sent, in the
                    form of a `tools` entry, without `cache_control`. Send it back unchanged
                    with the block.

                    - `JsonValue type = "tool_definition"`

                    - `BetaResponseToolUnion definition`

                      - `class BetaResponseTool`

                        A custom tool definition, as sent.

                        - `Optional<Type> type`

                        - `BetaResponseToolInputSchema 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> properties`

                          - `Optional<List<String>> 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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<String> 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<Boolean> 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<List<InputExample>> inputExamples`

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaToolBash20241022`

                        - `JsonValue type = "bash_20241022"`

                        - `JsonValue name = "bash"`

                          Name of the tool.

                          This is how the tool will be called by the model and in `tool_use` blocks.

                        - `Optional<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                          - `JsonValue type = "ephemeral"`

                          - `Optional<Ttl> 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<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<List<InputExample>> inputExamples`

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaToolBash20250124`

                        - `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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<List<InputExample>> inputExamples`

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaCodeExecutionTool20250522`

                        - `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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaCodeExecutionTool20250825`

                        - `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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaCodeExecutionTool20260120`

                        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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaCodeExecutionTool20260521`

                        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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaBrowserToolset20260801`

                        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<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<BetaBrowserToolsetConfigs> 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<BetaBrowserTypeConfig> type`

                            `type`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserCloseTabConfig> closeTab`

                            `close_tab`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserDoubleClickConfig> doubleClick`

                            `double_click`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserFileUploadConfig> fileUpload`

                            `file_upload`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserFindConfig> find`

                            `find`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserFormInputConfig> formInput`

                            `form_input`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserGetPageTextConfig> getPageText`

                            `get_page_text`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserHoldKeyConfig> holdKey`

                            `hold_key`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserHoverConfig> hover`

                            `hover`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserJavascriptExecConfig> javascriptExec`

                            `javascript_exec`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserKeyConfig> key`

                            `key`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserLeftClickConfig> leftClick`

                            `left_click`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserLeftClickDragConfig> leftClickDrag`

                            `left_click_drag`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserLeftMouseDownConfig> leftMouseDown`

                            `left_mouse_down`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserLeftMouseUpConfig> leftMouseUp`

                            `left_mouse_up`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserListTabsConfig> listTabs`

                            `list_tabs`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserMiddleClickConfig> middleClick`

                            `middle_click`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserMouseMoveConfig> mouseMove`

                            `mouse_move`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserNavigateConfig> navigate`

                            `navigate`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserNewTabConfig> newTab`

                            `new_tab`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserReadConsoleConfig> readConsole`

                            `read_console`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserReadNetworkConfig> readNetwork`

                            `read_network`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserReadPageConfig> readPage`

                            `read_page`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserRightClickConfig> rightClick`

                            `right_click`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserScreenshotConfig> screenshot`

                            `screenshot`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserScrollConfig> scroll`

                            `scroll`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserScrollToConfig> scrollTo`

                            `scroll_to`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserSwitchTabConfig> switchTab`

                            `switch_tab`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserTripleClickConfig> tripleClick`

                            `triple_click`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserWaitConfig> wait`

                            `wait`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaBrowserZoomConfig> zoom`

                            `zoom`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered 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 BetaToolComputerUse20241022`

                        - `JsonValue type = "computer_20241022"`

                        - `long displayHeightPx`

                          The height of the display in pixels.

                          minimum: 1

                        - `long displayWidthPx`

                          The width of the display in pixels.

                          minimum: 1

                        - `JsonValue name = "computer"`

                          Name of the tool.

                          This is how the tool will be called by the model and in `tool_use` blocks.

                        - `Optional<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Long> displayNumber`

                          The X11 display number (e.g. 0, 1) for the display.

                          minimum: 0

                        - `Optional<List<InputExample>> inputExamples`

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaMemoryTool20250818`

                        - `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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<List<InputExample>> inputExamples`

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaToolComputerUse20250124`

                        - `JsonValue type = "computer_20250124"`

                        - `long displayHeightPx`

                          The height of the display in pixels.

                          minimum: 1

                        - `long displayWidthPx`

                          The width of the display in pixels.

                          minimum: 1

                        - `JsonValue name = "computer"`

                          Name of the tool.

                          This is how the tool will be called by the model and in `tool_use` blocks.

                        - `Optional<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Long> displayNumber`

                          The X11 display number (e.g. 0, 1) for the display.

                          minimum: 0

                        - `Optional<List<InputExample>> inputExamples`

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaToolTextEditor20241022`

                        - `JsonValue type = "text_editor_20241022"`

                        - `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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<List<InputExample>> inputExamples`

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaToolComputerUse20251124`

                        - `JsonValue type = "computer_20251124"`

                        - `long displayHeightPx`

                          The height of the display in pixels.

                          minimum: 1

                        - `long displayWidthPx`

                          The width of the display in pixels.

                          minimum: 1

                        - `JsonValue name = "computer"`

                          Name of the tool.

                          This is how the tool will be called by the model and in `tool_use` blocks.

                        - `Optional<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Long> displayNumber`

                          The X11 display number (e.g. 0, 1) for the display.

                          minimum: 0

                        - `Optional<Boolean> enableZoom`

                          Whether to enable an action to take a zoomed-in screenshot of the screen.

                        - `Optional<List<InputExample>> inputExamples`

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaComputerToolset20260801`

                        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<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<BetaComputerToolsetConfigs> 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<BetaComputerTypeConfig> type`

                            `type`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaComputerCursorPositionConfig> cursorPosition`

                            `cursor_position`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaComputerDoubleClickConfig> doubleClick`

                            `double_click`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaComputerHoldKeyConfig> holdKey`

                            `hold_key`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaComputerKeyConfig> key`

                            `key`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaComputerLeftClickConfig> leftClick`

                            `left_click`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaComputerLeftClickDragConfig> leftClickDrag`

                            `left_click_drag`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaComputerLeftMouseDownConfig> leftMouseDown`

                            `left_mouse_down`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaComputerLeftMouseUpConfig> leftMouseUp`

                            `left_mouse_up`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaComputerMiddleClickConfig> middleClick`

                            `middle_click`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaComputerMouseMoveConfig> mouseMove`

                            `mouse_move`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaComputerRightClickConfig> rightClick`

                            `right_click`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaComputerScreenshotConfig> screenshot`

                            `screenshot`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaComputerScrollConfig> scroll`

                            `scroll`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaComputerTripleClickConfig> tripleClick`

                            `triple_click`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaComputerWaitConfig> wait`

                            `wait`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

                          - `Optional<BetaComputerZoomConfig> zoom`

                            `zoom`'s config overrides.

                            - `Optional<Boolean> deferLoading`

                              Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

                            - `Optional<Boolean> enabled`

                              Whether this member is offered 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 BetaToolTextEditor20250124`

                        - `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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<List<InputExample>> inputExamples`

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaToolTextEditor20250429`

                        - `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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<List<InputExample>> inputExamples`

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaToolTextEditor20250728`

                        - `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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<List<InputExample>> inputExamples`

                        - `Optional<Long> maxCharacters`

                          Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.

                          minimum: 1

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaWebSearchTool20250305`

                        - `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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<List<String>> allowedDomains`

                          If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                        - `Optional<List<String>> blockedDomains`

                          If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Long> maxUses`

                          Maximum number of times the tool can be used in the API request.

                          minimum: 1

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                        - `Optional<BetaUserLocation> userLocation`

                          Parameters for the user's location. Used to provide more relevant search results.

                          - `JsonValue type = "approximate"`

                          - `Optional<String> city`

                            The city of the user.

                            minLength: 1, maxLength: 255

                          - `Optional<String> 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<String> region`

                            The region of the user.

                            minLength: 1, maxLength: 255

                          - `Optional<String> timezone`

                            The [IANA timezone](https://nodatime.org/TimeZones) of the user.

                            minLength: 1, maxLength: 255

                      - `class BetaWebFetchTool20250910`

                        - `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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<List<String>> allowedDomains`

                          List of domains to allow fetching from

                        - `Optional<List<String>> blockedDomains`

                          List of domains to block fetching from

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<BetaCitationsConfigParam> citations`

                          Citations configuration for fetched documents. Citations are disabled by default.

                          - `Optional<Boolean> enabled`

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Long> 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<Long> maxUses`

                          Maximum number of times the tool can be used in the API request.

                          minimum: 1

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                        - `Optional<BetaWebFetchUrlSources> urlSources`

                          Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                          - `Optional<ClientToolResults> clientToolResults`

                            Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].

                            - `class BetaWebFetchUrlSourceAll`

                              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 BetaWebFetchUrlSourceNone`

                              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 BetaWebFetchUrlSourceOnly`

                              The tool filter variant under which only the named tools' results
                              contribute.

                              - `JsonValue type = "only"`

                              - `List<BetaWebFetchUrlSourceToolReference> tools`

                                - `JsonValue type = "tool_reference"`

                                - `String name`

                            - `class BetaWebFetchUrlSourceExcept`

                              The tool filter variant under which every result but the named
                              tools' contributes.

                              - `JsonValue type = "except"`

                              - `List<BetaWebFetchUrlSourceToolReference> tools`

                                - `JsonValue type = "tool_reference"`

                                - `String name`

                          - `Optional<ServerToolResults> 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 BetaWebFetchUrlSourceAll`

                              The `url_sources` variant under which a source contributes in
                              full: every result of the tool filter's source, or all user input.

                            - `class BetaWebFetchUrlSourceNone`

                              The `url_sources` variant under which a source contributes nothing:
                              no result of the tool filter's source, or no user input.

                            - `class BetaWebFetchUrlSourceOnly`

                              The tool filter variant under which only the named tools' results
                              contribute.

                            - `class BetaWebFetchUrlSourceExcept`

                              The tool filter variant under which every result but the named
                              tools' contributes.

                          - `Optional<UserInput> userInput`

                            Whether URLs in user messages are fetchable: "all" or "none".

                            - `class BetaWebFetchUrlSourceAll`

                              The `url_sources` variant under which a source contributes in
                              full: every result of the tool filter's source, or all user input.

                            - `class BetaWebFetchUrlSourceNone`

                              The `url_sources` variant under which a source contributes nothing:
                              no result of the tool filter's source, or no user input.

                      - `class BetaWebSearchTool20260209`

                        - `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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<List<String>> allowedDomains`

                          If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                        - `Optional<List<String>> blockedDomains`

                          If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Long> maxUses`

                          Maximum number of times the tool can be used in the API request.

                          minimum: 1

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                        - `Optional<BetaUserLocation> userLocation`

                          Parameters for the user's location. Used to provide more relevant search results.

                      - `class BetaWebFetchTool20260209`

                        - `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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<List<String>> allowedDomains`

                          List of domains to allow fetching from

                        - `Optional<List<String>> blockedDomains`

                          List of domains to block fetching from

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<BetaCitationsConfigParam> citations`

                          Citations configuration for fetched documents. Citations are disabled by default.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Long> 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<Long> maxUses`

                          Maximum number of times the tool can be used in the API request.

                          minimum: 1

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                        - `Optional<BetaWebFetchUrlSources> urlSources`

                          Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                      - `class BetaWebFetchTool20260309`

                        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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<List<String>> allowedDomains`

                          List of domains to allow fetching from

                        - `Optional<List<String>> blockedDomains`

                          List of domains to block fetching from

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<BetaCitationsConfigParam> citations`

                          Citations configuration for fetched documents. Citations are disabled by default.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Long> 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<Long> maxUses`

                          Maximum number of times the tool can be used in the API request.

                          minimum: 1

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                        - `Optional<BetaWebFetchUrlSources> urlSources`

                          Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                        - `Optional<Boolean> 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 BetaWebSearchTool20260318`

                        - `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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<List<String>> allowedDomains`

                          If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`.

                        - `Optional<List<String>> blockedDomains`

                          If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`.

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Long> maxUses`

                          Maximum number of times the tool can be used in the API request.

                          minimum: 1

                        - `Optional<ResponseInclusion> 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<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                        - `Optional<BetaUserLocation> userLocation`

                          Parameters for the user's location. Used to provide more relevant search results.

                      - `class BetaWebFetchTool20260318`

                        - `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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<List<String>> allowedDomains`

                          List of domains to allow fetching from

                        - `Optional<List<String>> blockedDomains`

                          List of domains to block fetching from

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<BetaCitationsConfigParam> citations`

                          Citations configuration for fetched documents. Citations are disabled by default.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Long> 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<Long> maxUses`

                          Maximum number of times the tool can be used in the API request.

                          minimum: 1

                        - `Optional<ResponseInclusion> 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<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                        - `Optional<BetaWebFetchUrlSources> urlSources`

                          Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.

                        - `Optional<Boolean> 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 BetaAdvisorTool20260301`

                        - `JsonValue type = "advisor_20260301"`

                        - `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 name = "advisor"`

                          Name of the tool.

                          This is how the tool will be called by the model and in `tool_use` blocks.

                        - `Optional<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<BetaCacheControlEphemeral> caching`

                          Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Long> maxTokens`

                          Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.

                          minimum: 1024

                        - `Optional<Long> maxUses`

                          Maximum number of times the tool can be used in the API request.

                          minimum: 1

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaToolSearchToolBm25_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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaToolSearchToolRegex20251119`

                        - `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<List<AllowedCaller>> allowedCallers`

                          - `DIRECT("direct")`

                          - `CODE_EXECUTION_20250825("code_execution_20250825")`

                          - `CODE_EXECUTION_20260120("code_execution_20260120")`

                          - `CODE_EXECUTION_20260521("code_execution_20260521")`

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Boolean> deferLoading`

                          If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

                        - `Optional<Boolean> strict`

                          When true, guarantees schema validation on tool names and inputs

                      - `class BetaMcpToolset`

                        Configuration for a group of tools from an MCP server.

                        Allows configuring enabled status and defer_loading for all tools
                        from an MCP server, with optional per-tool overrides.

                        - `JsonValue type = "mcp_toolset"`

                        - `String mcpServerName`

                          Name of the MCP server to configure tools for

                          minLength: 1, maxLength: 255

                        - `Optional<BetaCacheControlEphemeral> cacheControl`

                          Create a cache control breakpoint at this content block.

                        - `Optional<Configs> configs`

                          Configuration overrides for specific tools, keyed by tool name

                          - `Optional<Boolean> deferLoading`

                          - `Optional<Boolean> enabled`

                        - `Optional<BetaMcpToolDefaultConfig> defaultConfig`

                          Default configuration applied to all tools from this server

                          - `Optional<Boolean> deferLoading`

                          - `Optional<Boolean> enabled`

                        - `Optional<List<BetaMcpToolParam>> tools`

                          The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.

                          - `InputSchema inputSchema`

                            The tool's input schema as the MCP server lists it, verbatim.

                          - `String name`

                            The tool's name as the MCP server lists it (not prefixed with the server name).

                            minLength: 1

                          - `Optional<String> description`

                            The tool's description as the MCP server lists it.

              - `class BetaResponseToolRemovalBlock`

                An entry of a `compaction` block's `tool_changes`: a tool of the
                request's `tools` (or an MCP tool or toolset) that the compacted range
                withdrew. Send it back unchanged.

                - `JsonValue type = "tool_removal"`

                - `Tool tool`

                  A reference to the withdrawn `tools` entry, MCP tool or MCP toolset.

                  - `class BetaResponseToolChangeToolReference`

                    Reference to a single tool, by the name the model uses to call it, as
                    a `compaction` block's `tool_changes` entry reports it: a tool
                    declared in `tools` or defined by an earlier `tool_addition` block.
                    Send it back unchanged with the block.

                  - `class BetaResponseToolChangeMcpToolReference`

                    Reference to a single MCP tool, by its server and its name on that
                    server, as a `compaction` block's `tool_changes` entry reports it.
                    Send it back unchanged with the block.

                  - `class BetaResponseToolChangeMcpToolsetReference`

                    Reference to every tool in the named MCP server's toolset, as a
                    `compaction` block's `tool_changes` entry reports it. Send it back
                    unchanged with the block.

          - `class BetaFallbackBlock`

            Marks the point in `content` where one model's output gives way to the next.

            One block appears per hop where a preceding model actually ran this turn and
            declined. A turn where no preceding model ran and declined has no such
            boundary and carries no block — the signal for whether a fallback model
            served the response is the presence of a `fallback_message` entry in
            `usage.iterations`, not this block.

            The block is treated like a server-tool content block for streaming: it
            arrives via the standard `content_block_start` / `content_block_stop`
            pair and carries no deltas.

            - `JsonValue type = "fallback"`

            - `BetaFallbackInfo from`

              The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id.

              - `Model model`

                The model that will complete your prompt.

                See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

            - `BetaFallbackInfo to`

              The fallback model producing the content that follows this block. Its `model` is always the canonical id.

            - `BetaFallbackRefusalTrigger trigger`

              What caused the `from` model to hand over at this hop.

              - `JsonValue type = "refusal"`

              - `Optional<Category> category`

                The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.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.

          - `class BetaMcpToolListingBlock`

            The tool listing the server fetched from an MCP server while producing
            this response. Send the assistant message back unchanged, this block
            included, so later requests use this listing instead of asking the MCP
            server again.

            - `JsonValue type = "mcp_tool_listing"`

            - `String mcpServerName`

            - `List<BetaMcpTool> tools`

              - `InputSchema inputSchema`

              - `String name`

              - `Optional<String> description`

        - `Optional<BetaContextManagementResponse> contextManagement`

          Context management response.

          Information about context management strategies applied during the request.

          - `List<AppliedEdit> appliedEdits`

            List of context management edits that were applied.

            - `class BetaClearToolUses20250919EditResponse`

              - `JsonValue type = "clear_tool_uses_20250919"`

                The type of context management edit applied.

              - `long clearedInputTokens`

                Number of input tokens cleared by this edit.

                minimum: 0

              - `long clearedToolUses`

                Number of tool uses that were cleared.

                minimum: 0

            - `class BetaClearThinking20251015EditResponse`

              - `JsonValue type = "clear_thinking_20251015"`

                The type of context management edit applied.

              - `long clearedInputTokens`

                Number of input tokens cleared by this edit.

                minimum: 0

              - `long clearedThinkingTurns`

                Number of thinking turns that were cleared.

                minimum: 0

        - `Optional<BetaDiagnostics> diagnostics`

          Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected.

          - `Optional<BetaCacheMissReason> 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 BetaCacheMissModelChanged`

              - `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 BetaCacheMissSystemChanged`

              - `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 BetaCacheMissToolsChanged`

              - `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 BetaCacheMissMessagesChanged`

              - `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 BetaCacheMissPreviousMessageNotFound`

              - `JsonValue type = "previous_message_not_found"`

            - `class BetaCacheMissUnavailable`

              - `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.

        - `JsonValue role = "assistant"`

          Conversational role of the generated message.

          This will always be `"assistant"`.

        - `Optional<BetaRefusalStopDetails> 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> 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<String> 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<String> fallbackCreditToken`

            Opaque code that refunds the cache-miss cost when retrying this refused
            request on the fallback model. Pass it as `fallback_credit_token` on the
            retry request. Expires 5 minutes after the refusal.

            The retry is sent either with the same request body (`system`, `messages`,
            `tools`, and other render-shaping fields), or with the same body plus one
            appended `assistant` message whose content is the partial text (with any
            trailing whitespace stripped from the final text block) and paired
            server-tool blocks from this refusal — which also authorizes that
            appended turn as an assistant-prefill continuation on models that otherwise
            disallow prefill. A token minted mid-server-tool-loop whose partial content
            was continuable may only be redeemed the second way — if a same-body retry
            is rejected with a 400 saying the token must be redeemed by continuing the
            partial response, retry the second way instead. Either way: same workspace,
            same platform; a mismatch is a 400. Resending a token for an already-warm
            prefix is permitted but yields no additional credit.

            `null` when the refused model isn't eligible for a fallback credit.

          - `Optional<Boolean> fallbackHasPrefillClaim`

            Whether the accompanying `fallback_credit_token` may be redeemed with the
            appended-assistant retry form. Only set when `fallback_credit_token` is
            present.

            `true`: retry by resending the same request body plus one appended
            `assistant` message whose content is this response's `content` with any
            trailing whitespace stripped from the final text block and unpaired
            `tool_use` blocks omitted (the same appended-turn shape described on
            `fallback_credit_token`), with the token attached. `false`: retry by
            resending the original request body unchanged, with the token attached —
            the appended-assistant form is not available for this refusal (no
            continuable partial content, or the request uses `output_format` or a
            `tool_choice` that forces tool use). One exception: when the request used
            `output_format` or a forced `tool_choice` and the refusal arrived after
            server tools (including MCP connector tools) had already executed, the
            token may not be redeemable by either retry form; if the exact-body retry
            is then rejected with a 400 saying the token must be redeemed by
            continuing the partial response, discard the token and retry without it.

            Advisory: if an appended-assistant retry is rejected with a 400 despite
            `true`, fall back to resending the original request body with the token.

          - `Optional<String> recommendedModel`

            The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise.

        - `Optional<BetaStopReason> 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")`

          - `COMPACTION("compaction")`

          - `REFUSAL("refusal")`

          - `MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")`

        - `Optional<String> 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.

        - `BetaUsage 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<BetaCacheCreation> 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<Long> cacheCreationInputTokens`

            The number of input tokens used to create the cache entry.

            minimum: 0

          - `Optional<Long> cacheReadInputTokens`

            The number of input tokens read from the cache.

            minimum: 0

          - `Optional<BetaFallbackCreditUsage> fallbackCredit`

            Outcome of the `fallback_credit_token` presented on this request.

            Present on every response to a non-batch request that carried a
            `fallback_credit_token`, in either redemption mode; absent otherwise (batch
            items accept and ignore the token and carry no outcome object).

            - `Status status`

              Whether the fallback-credit reprice was applied to this response's billing.

              A union discriminated on `type`. `redeemed`: the retry is billed as if
              the conversation had been on the retry model all along — including when the
              resulting shift is zero because there was nothing to move. `not_applied`:
              no reprice was applied; the arm's `reason` says why.

              - `class BetaFallbackCreditRedeemed`

                The reprice was applied: the retry is billed as if the conversation
                had been on the retry model all along.

                - `JsonValue type = "redeemed"`

              - `class BetaFallbackCreditNotApplied`

                No reprice was applied; `reason` says why.

                - `JsonValue type = "not_applied"`

                - `Reason reason`

                  Why the reprice was not applied.

                  A closed enum; additions to the redemption-check vocabulary arrive as
                  deliberate schema updates.

                  - `BODY_MISMATCH("body_mismatch")`

                  - `CONTINUATION_EXCLUDED("continuation_excluded")`

                  - `CONTINUATION_ONLY("continuation_only")`

                  - `EXPIRED("expired")`

                  - `INVALID_TARGET_MODEL("invalid_target_model")`

                  - `NOT_ENABLED("not_enabled")`

                  - `REPRICE_UNAVAILABLE("reprice_unavailable")`

                  - `TEMPORARILY_UNAVAILABLE("temporarily_unavailable")`

                  - `VARIANT_FIELDS_PRESENT("variant_fields_present")`

                  - `WRONG_ORGANIZATION("wrong_organization")`

                  - `WRONG_PLATFORM("wrong_platform")`

                  - `WRONG_WORKSPACE("wrong_workspace")`

                - `Optional<List<String>> removeToRedeem`

                  Request fields to remove before retrying, so the retry can redeem this
                  token.

                  Present exactly when `reason` is `variant_fields_present` — never null,
                  never an empty array; absent otherwise. Fields are named only from your own request, and only after
                  the sealed variant hash matched. A served best-effort retry has already
                  been billed at normal price; nothing redeems retroactively, but a corrected
                  re-send inside the token's five-minute window can still redeem.

          - `Optional<String> inferenceGeo`

            The geographic region where inference was performed for this request.

          - `long inputTokens`

            The number of input tokens which were used.

            minimum: 0

          - `Optional<List<Iteration>> iterations`

            Per-iteration token usage breakdown.

            Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to:

            - Calculate the context window size from the last `message` entry
            - Understand token accumulation across server-side tool use loops

            A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results.

            - `class BetaMessageIterationUsage`

              Token usage for a sampling iteration.

              - `JsonValue type = "message"`

                Usage for a sampling iteration

              - `Optional<BetaCacheCreation> cacheCreation`

                Breakdown of cached tokens by TTL

              - `long cacheCreationInputTokens`

                The number of input tokens used to create the cache entry.

                minimum: 0

              - `long cacheReadInputTokens`

                The number of input tokens read from the cache.

                minimum: 0

              - `long inputTokens`

                The number of input tokens which were used.

                minimum: 0

              - `Optional<Model> model`

                The model that will complete your prompt.

                See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

              - `long outputTokens`

                The number of output tokens which were used.

                minimum: 0

            - `class BetaCompactionIterationUsage`

              Token usage for a compaction iteration.

              - `JsonValue type = "compaction"`

                Usage for a compaction iteration

              - `Optional<BetaCacheCreation> cacheCreation`

                Breakdown of cached tokens by TTL

              - `long cacheCreationInputTokens`

                The number of input tokens used to create the cache entry.

                minimum: 0

              - `long cacheReadInputTokens`

                The number of input tokens read from the cache.

                minimum: 0

              - `long inputTokens`

                The number of input tokens which were used.

                minimum: 0

              - `long outputTokens`

                The number of output tokens which were used.

                minimum: 0

            - `class BetaAdvisorMessageIterationUsage`

              Token usage for an advisor sub-inference iteration.

              - `JsonValue type = "advisor_message"`

                Usage for an advisor sub-inference iteration

              - `Optional<BetaCacheCreation> cacheCreation`

                Breakdown of cached tokens by TTL

              - `long cacheCreationInputTokens`

                The number of input tokens used to create the cache entry.

                minimum: 0

              - `long cacheReadInputTokens`

                The number of input tokens read from the cache.

                minimum: 0

              - `long inputTokens`

                The number of input tokens which were used.

                minimum: 0

              - `Model model`

                The model that will complete your prompt.

                See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

              - `long outputTokens`

                The number of output tokens which were used.

                minimum: 0

            - `class BetaFallbackMessageIterationUsage`

              Token usage for the fallback-model attempt of a server-side fallback request.

              The terminal entry of a fallback-served turn: when a fallback hop's
              output is the returned message, the entry for the iteration that
              completed it carries this type in place of `message`. A declined hop
              and the serving hop's earlier tool-loop iterations produce `message`
              entries. Whether a fallback model served the response is signalled by
              the presence of this entry in `usage.iterations`.

              - `JsonValue type = "fallback_message"`

                Usage for the fallback-model attempt that served the response

              - `Optional<BetaCacheCreation> cacheCreation`

                Breakdown of cached tokens by TTL

              - `long cacheCreationInputTokens`

                The number of input tokens used to create the cache entry.

                minimum: 0

              - `long cacheReadInputTokens`

                The number of input tokens read from the cache.

                minimum: 0

              - `long inputTokens`

                The number of input tokens which were used.

                minimum: 0

              - `Model model`

                The model that will complete your prompt.

                See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.

              - `long outputTokens`

                The number of output tokens which were used.

                minimum: 0

          - `long outputTokens`

            The number of output tokens which were used.

            minimum: 0

          - `Optional<BetaOutputTokensDetails> 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<BetaServerToolUsage> 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> serviceTier`

            If the request used the priority, standard, or batch tier.

            - `STANDARD("standard")`

            - `PRIORITY("priority")`

            - `BATCH("batch")`

          - `Optional<Speed> speed`

            The inference speed mode used for this request.

            - `STANDARD("standard")`

            - `FAST("fast")`

        - `Optional<List<BetaInputTransformation>> inputTransformations`

          Changes the API made to the request's input before showing it to the model,
          and blocks that failed a binding check but were left unchanged: one entry per
          block, in request order. Two entry types today. `thinking_dropped` — a
          `thinking`, `redacted_thinking` or `connector_text` block from the request's
          `messages` that was removed from the prompt instead of being shown to the
          model because it failed a binding check. `thinking_mismatch_allowed` — a
          `thinking` or `redacted_thinking` block that failed the conversation check
          (the conversation before it differs from the one it was created in, or it
          carries no record of one on a model that requires it) and was shown to the
          model all the same, because that check is not enforced for this request.
          More entry types may be added over time; ignore types you do not recognize.

          Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on
          every such response from a model that supports extended thinking, as `[]`
          when there is no entry to report; without the beta, blocks are removed or
          left in place all the same but nothing is reported. Removed blocks contribute
          nothing to `usage.input_tokens`; blocks left in place count as sent. When
          streaming, the array is final in `message_start`; the final `message_delta`
          event carries it only when a server-side model fallback happened mid-stream,
          in which case it holds the serving model's entries and replaces the one in
          `message_start`.

          - `class BetaThinkingDroppedInputTransformation`

            - `JsonValue type = "thinking_dropped"`

              Always `thinking_dropped` for this entry type.

            - `String path`

              Where the removed block was in your request, as `messages.{i}.content.{j}`:
              `i` indexes the `messages` array you sent and `j` that message's `content`
              array — the same form error messages use.

            - `Reason reason`

              Which binding check removed the block: `model_binding_mismatch` — it was
              created by a model whose reasoning the requested model may not read;
              `prefix_binding_mismatch` — the conversation before it differs from the
              conversation it was created in (the rest of that turn's consecutive thinking
              blocks are removed with it, each with this reason);
              `organization_binding_mismatch` — it was created under a different
              organization (an Anthropic organization, AWS account or Google Cloud project)
              and this organization is not one of its additional organizations;
              `end_user_binding_mismatch` — it was created for a different end user, or
              was removed by the consumer-organization binding. A block that would fail
              several checks reports one reason, in this order of precedence:
              `organization_binding_mismatch`, `end_user_binding_mismatch`,
              `model_binding_mismatch`, `prefix_binding_mismatch`.

              - `MODEL_BINDING_MISMATCH("model_binding_mismatch")`

              - `PREFIX_BINDING_MISMATCH("prefix_binding_mismatch")`

              - `ORGANIZATION_BINDING_MISMATCH("organization_binding_mismatch")`

              - `END_USER_BINDING_MISMATCH("end_user_binding_mismatch")`

          - `class BetaThinkingMismatchAllowedInputTransformation`

            - `JsonValue type = "thinking_mismatch_allowed"`

              Always `thinking_mismatch_allowed` for this entry type.

            - `String path`

              Where the block is in your request, as `messages.{i}.content.{j}`:
              `i` indexes the `messages` array you sent and `j` that message's `content`
              array — the same form error messages use.

            - `Reason reason`

              Which binding check the block failed; the block was shown to the model all
              the same. Always `prefix_binding_mismatch` today — the conversation before
              the block differs from the conversation it was created in, or the block
              carries no record of one on a model that requires it. Were the check
              enforced for this request, the block would have been removed or the request
              rejected (`thinking.block_binding.prefix_mismatch_behavior`). A removal also
              takes the rest of that turn's consecutive thinking blocks, whereas here each
              block is checked on its own, so `thinking_mismatch_allowed` entries are a
              lower bound on what enforcement would remove.

              - `MODEL_BINDING_MISMATCH("model_binding_mismatch")`

              - `PREFIX_BINDING_MISMATCH("prefix_binding_mismatch")`

              - `ORGANIZATION_BINDING_MISMATCH("organization_binding_mismatch")`

              - `END_USER_BINDING_MISMATCH("end_user_binding_mismatch")`

    - `class BetaMessageBatchErroredResult`

      - `JsonValue type = "errored"`

      - `BetaErrorResponse error`

        - `JsonValue type = "error"`

        - `BetaError error`

          - `class BetaInvalidRequestError`

            - `JsonValue type = "invalid_request_error"`

            - `String message`

          - `class BetaAuthenticationError`

            - `JsonValue type = "authentication_error"`

            - `String message`

          - `class BetaBillingError`

            - `JsonValue type = "billing_error"`

            - `String message`

          - `class BetaPermissionError`

            - `JsonValue type = "permission_error"`

            - `String message`

          - `class BetaNotFoundError`

            - `JsonValue type = "not_found_error"`

            - `String message`

          - `class BetaRateLimitError`

            - `JsonValue type = "rate_limit_error"`

            - `String message`

          - `class BetaGatewayTimeoutError`

            - `JsonValue type = "timeout_error"`

            - `String message`

          - `class BetaApiError`

            - `JsonValue type = "api_error"`

            - `String message`

          - `class BetaOverloadedError`

            - `JsonValue type = "overloaded_error"`

            - `String message`

        - `Optional<String> requestId`

    - `class BetaMessageBatchCanceledResult`

      - `JsonValue type = "canceled"`

    - `class BetaMessageBatchExpiredResult`

      - `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.beta.messages.batches.BatchResultsParams;
import com.anthropic.models.beta.messages.batches.BetaMessageBatchIndividualResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        StreamResponse<BetaMessageBatchIndividualResponse> betaMessageBatchIndividualResponse = client.beta().messages().batches().resultsStreaming("message_batch_id");
    }
}
```