---
title: Create a Message
url: https://platform.claude.com/docs/en/api/cli/beta/messages/create
---

# Create a Message

`$ ant beta:messages create`

**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=cli)

## Parameters

- `--max-tokens: number`

  The maximum number of tokens to generate before stopping.

  Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.

  Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli#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=cli) for details.

  minimum: 0

- `--message: array of BetaMessageParam`

  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=cli#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=cli).

  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=cli#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.

- `--model: "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-fable-5-1" or 17 more or string`

  The model that will complete your prompt.

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

- `--cache-control: optional object`

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

- `--compaction: optional object`

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

- `--container: optional BetaContainerParams or string`

  Container identifier for reuse across requests.

- `--context-management: optional object`

  Context management configuration.

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

- `--diagnostics: optional object`

  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.

- `--fallback-credit-token: optional string or BetaFallbackCreditTokenParam`

  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.

- `--fallbacks: optional array of BetaFallbackParam or "default"`

  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=cli#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.

- `--inference-geo: optional string`

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

- `--mcp-server: optional array of BetaRequestMCPServerURLDefinition`

  MCP servers to be utilized in this request

  maxItems: 20

- `--metadata: optional object`

  An object describing metadata about the request.

- `--output-config: optional object`

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

- `--output-format: optional object`

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

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

- `--service-tier: optional "auto" or "standard_only"`

  Determines whether to use priority capacity (if available) or standard capacity for this request.

  Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers?sdk_languages=cli) for details.

- `--speed: optional "standard" or "fast"`

  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=cli) for which models.

- `--stop-sequence: optional array of string`

  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.

- `--system: optional string or array of BetaTextBlockParam`

  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=cli#give-claude-a-role).

- `--thinking: optional BetaThinkingConfigEnabled or BetaThinkingConfigDisabled or BetaThinkingConfigBetweenTools or BetaThinkingConfigAdaptive`

  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=cli#configuring-thinking) for each model's behavior.

- `--tool-choice: optional BetaToolChoiceAuto or BetaToolChoiceAny or BetaToolChoiceTool or BetaToolChoiceNone`

  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.

- `--tool: optional array of BetaToolUnion`

  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=cli), 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=cli)).

  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=cli) for more details.

- `--beta: optional array of AnthropicBeta` (header parameter)

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

- `--user-profile-id: optional string` (header parameter)

  The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header.

- `--workspace-id: optional string` (header parameter)

  Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

  Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

- `--temperature: optional number`

  **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 will be accepted for backwards compatibility, all other values will be rejected with a 400 error.

  Amount of randomness injected into the response.

  Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks.

  Note that even with `temperature` of `0.0`, the results will not be fully deterministic.

  minimum: 0, maximum: 1

- `--top-k: optional number`

  **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error.

  Only sample from the top K options for each subsequent token.

  Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277).

  Recommended for advanced use cases only.

  minimum: 0

- `--top-p: optional number`

  **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting top_p. A value >= 0.99 will be accepted for backwards compatibility, all other values will be rejected with a 400 error.

  Use nucleus sampling.

  In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`.

  Recommended for advanced use cases only.

  minimum: 0, maximum: 1

## Returns

- `beta_message: object`

  - `type: "message"`

    Object type.

    For Messages, this is always `"message"`.

  - `id: string`

    Unique object identifier.

    The format and length of IDs may change over time.

  - `container: object`

    Information about the container used in this request.

    This will be non-null if a container tool (e.g. code execution) was used.

    - `id: string`

      Identifier for the container used in this request

    - `expires_at: string`

      The time at which the container will expire.

      format: date-time

    - `skills: array of BetaContainerSkill`

      Skills loaded in the container

      - `type: "anthropic" or "custom"`

        Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

        - `"anthropic"`

        - `"custom"`

      - `skill_id: string`

        Skill ID

        minLength: 1, maxLength: 64

      - `version: string`

        The resolved version: a skill version ID for custom skills.

        minLength: 1, maxLength: 64

  - `content: array of BetaContentBlock`

    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)"}]
    ```

    - `beta_text_block: object`

      - `type: "text"`

      - `citations: array of BetaTextCitation`

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

        - `beta_citation_char_location: object`

          - `type: "char_location"`

          - `cited_text: string`

          - `document_index: number`

            minimum: 0

          - `document_title: string`

          - `end_char_index: number`

          - `file_id: string`

          - `start_char_index: number`

            minimum: 0

        - `beta_citation_page_location: object`

          - `type: "page_location"`

          - `cited_text: string`

          - `document_index: number`

            minimum: 0

          - `document_title: string`

          - `end_page_number: number`

          - `file_id: string`

          - `start_page_number: number`

            minimum: 1

        - `beta_citation_content_block_location: object`

          - `type: "content_block_location"`

          - `cited_text: string`

            The full text of the cited block range, concatenated.

            Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.

          - `document_index: number`

            minimum: 0

          - `document_title: string`

          - `end_block_index: number`

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

            Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.

          - `file_id: string`

          - `start_block_index: number`

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

            minimum: 0

        - `beta_citations_web_search_result_location: object`

          - `type: "web_search_result_location"`

          - `cited_text: string`

          - `encrypted_index: string`

          - `title: string`

            maxLength: 512

          - `url: string`

        - `beta_citation_search_result_location: object`

          - `type: "search_result_location"`

          - `cited_text: string`

            The full text of the cited block range, concatenated.

            Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.

          - `end_block_index: number`

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

            Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.

          - `search_result_index: number`

            0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results.

            Counted separately from `document_index`; server-side web search results are not included in this count.

            minimum: 0

          - `source: string`

          - `start_block_index: number`

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

            minimum: 0

          - `title: string`

      - `text: string`

    - `beta_thinking_block: object`

      - `type: "thinking"`

      - `signature: string`

        A value used to verify that this thinking block was generated by Claude when it is passed back to the API.

        This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact.

        See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=cli) for details.

      - `thinking: string`

        The text of Claude's thinking process for this block.

    - `beta_redacted_thinking_block: object`

      - `type: "redacted_thinking"`

      - `data: string`

        The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content.

        Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.

        See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=cli#redacted-thinking-blocks) for details.

    - `beta_tool_use_block: object`

      - `type: "tool_use"`

      - `id: string`

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

      - `input: map[unknown]`

      - `name: string`

        minLength: 1

      - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120`

        - `beta_direct_caller: object`

          Tool invocation directly from the model.

          - `type: "direct"`

        - `beta_server_tool_caller: object`

          Tool invocation generated by a server-side tool.

          - `type: "code_execution_20250825"`

          - `tool_id: string`

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

        - `beta_server_tool_caller_20260120: object`

          - `type: "code_execution_20260120"`

          - `tool_id: string`

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

      - `toolset_name: optional string`

        For a toolset member tool_use, the toolset family.

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

    - `beta_server_tool_use_block: object`

      - `type: "server_tool_use"`

      - `id: string`

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

      - `input: map[unknown]`

      - `name: "advisor" or "web_search" or "web_fetch" or 5 more`

        - `"advisor"`

        - `"web_search"`

        - `"web_fetch"`

        - `"code_execution"`

        - `"bash_code_execution"`

        - `"text_editor_code_execution"`

        - `"tool_search_tool_regex"`

        - `"tool_search_tool_bm25"`

      - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120`

        - `beta_direct_caller: object`

          Tool invocation directly from the model.

        - `beta_server_tool_caller: object`

          Tool invocation generated by a server-side tool.

        - `beta_server_tool_caller_20260120: object`

    - `beta_web_search_tool_result_block: object`

      - `type: "web_search_tool_result"`

      - `content: BetaWebSearchToolResultError or array of BetaWebSearchResultBlock`

        - `beta_web_search_tool_result_error: object`

          - `type: "web_search_tool_result_error"`

          - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more`

            - `"invalid_tool_input"`

            - `"unavailable"`

            - `"max_uses_exceeded"`

            - `"too_many_requests"`

            - `"query_too_long"`

            - `"request_too_large"`

        - `union_member_1: array of BetaWebSearchResultBlock`

          - `type: "web_search_result"`

          - `encrypted_content: string`

          - `page_age: string`

          - `title: string`

          - `url: string`

      - `tool_use_id: string`

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

      - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120`

        - `beta_direct_caller: object`

          Tool invocation directly from the model.

        - `beta_server_tool_caller: object`

          Tool invocation generated by a server-side tool.

        - `beta_server_tool_caller_20260120: object`

    - `beta_web_fetch_tool_result_block: object`

      - `type: "web_fetch_tool_result"`

      - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock`

        - `beta_web_fetch_tool_result_error_block: object`

          - `type: "web_fetch_tool_result_error"`

          - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 7 more`

            - `"invalid_tool_input"`

            - `"url_too_long"`

            - `"url_not_allowed"`

            - `"url_not_in_prior_context"`

            - `"url_not_accessible"`

            - `"unsupported_content_type"`

            - `"too_many_requests"`

            - `"max_uses_exceeded"`

            - `"unavailable"`

            - `"content_too_large"`

        - `beta_web_fetch_block: object`

          - `type: "web_fetch_result"`

          - `content: object`

            - `type: "document"`

            - `citations: object`

              Citation configuration for the document

              - `enabled: boolean`

            - `source: BetaBase64PDFSource or BetaPlainTextSource`

              - `beta_base64_pdf_source: object`

                - `type: "base64"`

                - `data: string`

                  format: byte

                - `media_type: "application/pdf"`

              - `beta_plain_text_source: object`

                - `type: "text"`

                - `data: string`

                - `media_type: "text/plain"`

            - `title: string`

              The title of the document

          - `retrieved_at: string`

            ISO 8601 timestamp when the content was retrieved

          - `url: string`

            Fetched content URL

      - `tool_use_id: string`

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

      - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120`

        - `beta_direct_caller: object`

          Tool invocation directly from the model.

        - `beta_server_tool_caller: object`

          Tool invocation generated by a server-side tool.

        - `beta_server_tool_caller_20260120: object`

    - `beta_advisor_tool_result_block: object`

      - `type: "advisor_tool_result"`

      - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock`

        - `beta_advisor_tool_result_error: object`

          - `type: "advisor_tool_result_error"`

          - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 4 more`

            - `"max_uses_exceeded"`

            - `"prompt_too_long"`

            - `"too_many_requests"`

            - `"overloaded"`

            - `"unavailable"`

            - `"execution_time_exceeded"`

            - `"model_not_found"`

        - `beta_advisor_result_block: object`

          - `type: "advisor_result"`

          - `stop_reason: string`

            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.

          - `text: string`

        - `beta_advisor_redacted_result_block: object`

          - `type: "advisor_redacted_result"`

          - `encrypted_content: string`

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

          - `stop_reason: string`

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

      - `tool_use_id: string`

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

    - `beta_code_execution_tool_result_block: object`

      - `type: "code_execution_tool_result"`

      - `content: BetaCodeExecutionToolResultError or BetaCodeExecutionResultBlock or BetaEncryptedCodeExecutionResultBlock`

        - `beta_code_execution_tool_result_error: object`

          - `type: "code_execution_tool_result_error"`

          - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"`

            - `"invalid_tool_input"`

            - `"unavailable"`

            - `"too_many_requests"`

            - `"execution_time_exceeded"`

        - `beta_code_execution_result_block: object`

          - `type: "code_execution_result"`

          - `content: array of BetaCodeExecutionOutputBlock`

            - `type: "code_execution_output"`

            - `file_id: string`

          - `return_code: number`

          - `stderr: string`

          - `stdout: string`

        - `beta_encrypted_code_execution_result_block: object`

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

          - `type: "encrypted_code_execution_result"`

          - `content: array of BetaCodeExecutionOutputBlock`

            - `type: "code_execution_output"`

            - `file_id: string`

          - `encrypted_stdout: string`

          - `return_code: number`

          - `stderr: string`

      - `tool_use_id: string`

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

    - `beta_bash_code_execution_tool_result_block: object`

      - `type: "bash_code_execution_tool_result"`

      - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock`

        - `beta_bash_code_execution_tool_result_error: object`

          - `type: "bash_code_execution_tool_result_error"`

          - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more`

            - `"invalid_tool_input"`

            - `"unavailable"`

            - `"too_many_requests"`

            - `"execution_time_exceeded"`

            - `"output_file_too_large"`

        - `beta_bash_code_execution_result_block: object`

          - `type: "bash_code_execution_result"`

          - `content: array of BetaBashCodeExecutionOutputBlock`

            - `type: "bash_code_execution_output"`

            - `file_id: string`

          - `return_code: number`

          - `stderr: string`

          - `stdout: string`

      - `tool_use_id: string`

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

    - `beta_text_editor_code_execution_tool_result_block: object`

      - `type: "text_editor_code_execution_tool_result"`

      - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock`

        - `beta_text_editor_code_execution_tool_result_error: object`

          - `type: "text_editor_code_execution_tool_result_error"`

          - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more`

            - `"invalid_tool_input"`

            - `"unavailable"`

            - `"too_many_requests"`

            - `"execution_time_exceeded"`

            - `"file_not_found"`

          - `error_message: string`

        - `beta_text_editor_code_execution_view_result_block: object`

          - `type: "text_editor_code_execution_view_result"`

          - `content: string`

          - `file_type: "text" or "image" or "pdf"`

            - `"text"`

            - `"image"`

            - `"pdf"`

          - `num_lines: number`

          - `start_line: number`

          - `total_lines: number`

        - `beta_text_editor_code_execution_create_result_block: object`

          - `type: "text_editor_code_execution_create_result"`

          - `is_file_update: boolean`

        - `beta_text_editor_code_execution_str_replace_result_block: object`

          - `type: "text_editor_code_execution_str_replace_result"`

          - `lines: array of string`

          - `new_lines: number`

          - `new_start: number`

          - `old_lines: number`

          - `old_start: number`

      - `tool_use_id: string`

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

    - `beta_tool_search_tool_result_block: object`

      - `type: "tool_search_tool_result"`

      - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock`

        - `beta_tool_search_tool_result_error: object`

          - `type: "tool_search_tool_result_error"`

          - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"`

            - `"invalid_tool_input"`

            - `"unavailable"`

            - `"too_many_requests"`

            - `"execution_time_exceeded"`

          - `error_message: string`

        - `beta_tool_search_tool_search_result_block: object`

          - `type: "tool_search_tool_search_result"`

          - `tool_references: array of BetaToolReferenceBlock`

            - `type: "tool_reference"`

            - `tool_name: string`

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

      - `tool_use_id: string`

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

    - `beta_mcp_tool_use_block: object`

      - `type: "mcp_tool_use"`

      - `id: string`

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

      - `input: map[unknown]`

      - `name: string`

        The name of the MCP tool

      - `server_name: string`

        The name of the MCP server

    - `beta_mcp_tool_result_block: object`

      - `type: "mcp_tool_result"`

      - `content: string or array of BetaTextBlock`

        - `union_member_0: string`

        - `beta_mcp_tool_result_block_content: array of BetaTextBlock`

          - `type: "text"`

          - `citations: array of BetaTextCitation`

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

          - `text: string`

      - `is_error: boolean`

      - `tool_use_id: string`

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

    - `beta_container_upload_block: object`

      Response model for a file uploaded to the container.

      - `type: "container_upload"`

      - `file_id: string`

    - `beta_compaction_block: object`

      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.

      - `type: "compaction"`

      - `content: string`

        Summary of compacted content, or null if compaction failed

      - `encrypted_content: string`

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

      - `signature: optional string`

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

      - `tool_changes: optional array of BetaResponseToolAdditionBlock or BetaResponseToolRemovalBlock`

        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.

        - `beta_response_tool_addition_block: object`

          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.

          - `type: "tool_addition"`

          - `tool: BetaResponseToolChangeToolReference or BetaResponseToolChangeMCPToolReference or BetaResponseToolChangeMCPToolsetReference or BetaToolChangeToolDefinition`

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

            - `beta_response_tool_change_tool_reference: object`

              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.

              - `type: "tool_reference"`

              - `name: string`

            - `beta_response_tool_change_mcp_tool_reference: object`

              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.

              - `type: "mcp_tool_reference"`

              - `name: string`

              - `server_name: string`

            - `beta_response_tool_change_mcp_toolset_reference: object`

              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.

              - `type: "mcp_toolset_reference"`

              - `server_name: string`

            - `beta_tool_change_tool_definition: object`

              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.

              - `type: "tool_definition"`

              - `definition: BetaResponseTool or BetaToolBash20241022 or BetaToolBash20250124 or 25 more`

                - `beta_response_tool: object`

                  A custom tool definition, as sent.

                  - `type: optional "custom"`

                  - `input_schema: object`

                    [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.

                    This defines the shape of the `input` that your tool accepts and that the model will produce.

                    - `type: "object"`

                    - `properties: optional map[unknown]`

                    - `required: optional array of string`

                  - `name: string`

                    Name of the tool.

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

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `defer_loading: optional boolean`

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

                  - `description: optional string`

                    Description of what this tool does.

                    Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.

                  - `eager_input_streaming: optional boolean`

                    Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers.

                  - `input_examples: optional array of map[unknown]`

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_tool_bash_20241022: object`

                  - `type: "bash_20241022"`

                  - `name: "bash"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                      - `"5m"`

                      - `"1h"`

                  - `defer_loading: optional boolean`

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

                  - `input_examples: optional array of map[unknown]`

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_tool_bash_20250124: object`

                  - `type: "bash_20250124"`

                  - `name: "bash"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `input_examples: optional array of map[unknown]`

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_code_execution_tool_20250522: object`

                  - `type: "code_execution_20250522"`

                  - `name: "code_execution"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_code_execution_tool_20250825: object`

                  - `type: "code_execution_20250825"`

                  - `name: "code_execution"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_code_execution_tool_20260120: object`

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

                  - `type: "code_execution_20260120"`

                  - `name: "code_execution"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_code_execution_tool_20260521: object`

                  Code execution tool with REPL state persistence.

                  - `type: "code_execution_20260521"`

                  - `name: "code_execution"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_browser_toolset_20260801: object`

                  The browser toolset: a single `tools[]` entry (carrying no
                  `name`) that declares the browser tool family. The model is served
                  the family's tool with any members disabled via `configs` removed
                  from its schema.

                  - `type: "browser_toolset_20260801"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `configs: optional object`

                    Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.

                    - `type: optional object`

                      `type`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `close_tab: optional object`

                      `close_tab`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `double_click: optional object`

                      `double_click`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `file_upload: optional object`

                      `file_upload`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `find: optional object`

                      `find`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `form_input: optional object`

                      `form_input`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `get_page_text: optional object`

                      `get_page_text`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `hold_key: optional object`

                      `hold_key`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `hover: optional object`

                      `hover`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `javascript_exec: optional object`

                      `javascript_exec`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `key: optional object`

                      `key`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `left_click: optional object`

                      `left_click`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `left_click_drag: optional object`

                      `left_click_drag`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `left_mouse_down: optional object`

                      `left_mouse_down`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `left_mouse_up: optional object`

                      `left_mouse_up`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `list_tabs: optional object`

                      `list_tabs`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `middle_click: optional object`

                      `middle_click`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `mouse_move: optional object`

                      `mouse_move`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `navigate: optional object`

                      `navigate`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `new_tab: optional object`

                      `new_tab`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `read_console: optional object`

                      `read_console`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `read_network: optional object`

                      `read_network`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `read_page: optional object`

                      `read_page`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `right_click: optional object`

                      `right_click`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `screenshot: optional object`

                      `screenshot`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `scroll: optional object`

                      `scroll`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `scroll_to: optional object`

                      `scroll_to`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `switch_tab: optional object`

                      `switch_tab`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `triple_click: optional object`

                      `triple_click`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `wait: optional object`

                      `wait`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `zoom: optional object`

                      `zoom`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

                        Whether this member is offered 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_tool_computer_use_20241022: object`

                  - `type: "computer_20241022"`

                  - `display_height_px: number`

                    The height of the display in pixels.

                    minimum: 1

                  - `display_width_px: number`

                    The width of the display in pixels.

                    minimum: 1

                  - `name: "computer"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `display_number: optional number`

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

                    minimum: 0

                  - `input_examples: optional array of map[unknown]`

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_memory_tool_20250818: object`

                  - `type: "memory_20250818"`

                  - `name: "memory"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `input_examples: optional array of map[unknown]`

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_tool_computer_use_20250124: object`

                  - `type: "computer_20250124"`

                  - `display_height_px: number`

                    The height of the display in pixels.

                    minimum: 1

                  - `display_width_px: number`

                    The width of the display in pixels.

                    minimum: 1

                  - `name: "computer"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `display_number: optional number`

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

                    minimum: 0

                  - `input_examples: optional array of map[unknown]`

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_tool_text_editor_20241022: object`

                  - `type: "text_editor_20241022"`

                  - `name: "str_replace_editor"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `input_examples: optional array of map[unknown]`

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_tool_computer_use_20251124: object`

                  - `type: "computer_20251124"`

                  - `display_height_px: number`

                    The height of the display in pixels.

                    minimum: 1

                  - `display_width_px: number`

                    The width of the display in pixels.

                    minimum: 1

                  - `name: "computer"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `display_number: optional number`

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

                    minimum: 0

                  - `enable_zoom: optional boolean`

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

                  - `input_examples: optional array of map[unknown]`

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_computer_toolset_20260801: object`

                  The computer toolset: a single `tools[]` entry (carrying no
                  `name`) that declares the computer tool family. The model is
                  served the family's tool with any members disabled via `configs`
                  removed from its schema. Every member is enabled by default, zoom
                  included. The single-tool options `display_number` and
                  `enable_zoom` are not fields of a toolset entry — it carries only
                  `type`, `configs`, and `cache_control`; zoom is controlled
                  via `configs.zoom.enabled`.

                  - `type: "computer_toolset_20260801"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `configs: optional object`

                    Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.

                    - `type: optional object`

                      `type`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `cursor_position: optional object`

                      `cursor_position`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `double_click: optional object`

                      `double_click`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `hold_key: optional object`

                      `hold_key`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `key: optional object`

                      `key`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `left_click: optional object`

                      `left_click`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `left_click_drag: optional object`

                      `left_click_drag`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `left_mouse_down: optional object`

                      `left_mouse_down`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `left_mouse_up: optional object`

                      `left_mouse_up`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `middle_click: optional object`

                      `middle_click`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `mouse_move: optional object`

                      `mouse_move`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `right_click: optional object`

                      `right_click`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `screenshot: optional object`

                      `screenshot`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `scroll: optional object`

                      `scroll`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `triple_click: optional object`

                      `triple_click`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `wait: optional object`

                      `wait`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

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

                    - `zoom: optional object`

                      `zoom`'s config overrides.

                      - `defer_loading: optional boolean`

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

                      - `enabled: optional boolean`

                        Whether this member is offered 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_tool_text_editor_20250124: object`

                  - `type: "text_editor_20250124"`

                  - `name: "str_replace_editor"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `input_examples: optional array of map[unknown]`

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_tool_text_editor_20250429: object`

                  - `type: "text_editor_20250429"`

                  - `name: "str_replace_based_edit_tool"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `input_examples: optional array of map[unknown]`

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_tool_text_editor_20250728: object`

                  - `type: "text_editor_20250728"`

                  - `name: "str_replace_based_edit_tool"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `input_examples: optional array of map[unknown]`

                  - `max_characters: optional number`

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

                    minimum: 1

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_web_search_tool_20250305: object`

                  - `type: "web_search_20250305"`

                  - `name: "web_search"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `allowed_domains: optional array of string`

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

                  - `blocked_domains: optional array of string`

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

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `max_uses: optional number`

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

                    minimum: 1

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                  - `user_location: optional object`

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

                    - `type: "approximate"`

                    - `city: optional string`

                      The city of the user.

                      minLength: 1, maxLength: 255

                    - `country: optional string`

                      The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.

                      minLength: 2, maxLength: 2

                    - `region: optional string`

                      The region of the user.

                      minLength: 1, maxLength: 255

                    - `timezone: optional string`

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

                      minLength: 1, maxLength: 255

                - `beta_web_fetch_tool_20250910: object`

                  - `type: "web_fetch_20250910"`

                  - `name: "web_fetch"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `allowed_domains: optional array of string`

                    List of domains to allow fetching from

                  - `blocked_domains: optional array of string`

                    List of domains to block fetching from

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `citations: optional object`

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

                    - `enabled: optional boolean`

                  - `defer_loading: optional boolean`

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

                  - `max_content_tokens: optional number`

                    Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.

                    minimum: 1

                  - `max_uses: optional number`

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

                    minimum: 1

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                  - `url_sources: optional object`

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

                    - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`

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

                      - `beta_web_fetch_url_source_all: object`

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

                        - `type: "all"`

                      - `beta_web_fetch_url_source_none: object`

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

                        - `type: "none"`

                      - `beta_web_fetch_url_source_only: object`

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

                        - `type: "only"`

                        - `tools: array of BetaWebFetchURLSourceToolReference`

                          - `type: "tool_reference"`

                          - `name: string`

                      - `beta_web_fetch_url_source_except: object`

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

                        - `type: "except"`

                        - `tools: array of BetaWebFetchURLSourceToolReference`

                          - `type: "tool_reference"`

                          - `name: string`

                    - `server_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`

                      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.

                      - `beta_web_fetch_url_source_all: object`

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

                      - `beta_web_fetch_url_source_none: object`

                        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_url_source_only: object`

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

                      - `beta_web_fetch_url_source_except: object`

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

                    - `user_input: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone`

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

                      - `beta_web_fetch_url_source_all: object`

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

                      - `beta_web_fetch_url_source_none: object`

                        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_tool_20260209: object`

                  - `type: "web_search_20260209"`

                  - `name: "web_search"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `allowed_domains: optional array of string`

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

                  - `blocked_domains: optional array of string`

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

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `max_uses: optional number`

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

                    minimum: 1

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                  - `user_location: optional object`

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

                    - `type: "approximate"`

                    - `city: optional string`

                      The city of the user.

                      minLength: 1, maxLength: 255

                    - `country: optional string`

                      The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.

                      minLength: 2, maxLength: 2

                    - `region: optional string`

                      The region of the user.

                      minLength: 1, maxLength: 255

                    - `timezone: optional string`

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

                      minLength: 1, maxLength: 255

                - `beta_web_fetch_tool_20260209: object`

                  - `type: "web_fetch_20260209"`

                  - `name: "web_fetch"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `allowed_domains: optional array of string`

                    List of domains to allow fetching from

                  - `blocked_domains: optional array of string`

                    List of domains to block fetching from

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `citations: optional object`

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

                    - `enabled: optional boolean`

                  - `defer_loading: optional boolean`

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

                  - `max_content_tokens: optional number`

                    Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.

                    minimum: 1

                  - `max_uses: optional number`

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

                    minimum: 1

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                  - `url_sources: optional object`

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

                    - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`

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

                    - `server_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`

                      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.

                    - `user_input: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone`

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

                - `beta_web_fetch_tool_20260309: object`

                  Web fetch tool with use_cache parameter for bypassing cached content.

                  - `type: "web_fetch_20260309"`

                  - `name: "web_fetch"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `allowed_domains: optional array of string`

                    List of domains to allow fetching from

                  - `blocked_domains: optional array of string`

                    List of domains to block fetching from

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `citations: optional object`

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

                    - `enabled: optional boolean`

                  - `defer_loading: optional boolean`

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

                  - `max_content_tokens: optional number`

                    Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.

                    minimum: 1

                  - `max_uses: optional number`

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

                    minimum: 1

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                  - `url_sources: optional object`

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

                    - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`

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

                    - `server_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`

                      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.

                    - `user_input: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone`

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

                  - `use_cache: optional boolean`

                    Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.

                - `beta_web_search_tool_20260318: object`

                  - `type: "web_search_20260318"`

                  - `name: "web_search"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `allowed_domains: optional array of string`

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

                  - `blocked_domains: optional array of string`

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

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `max_uses: optional number`

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

                    minimum: 1

                  - `response_inclusion: optional "full" or "excluded"`

                    How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn.

                    - `"full"`

                    - `"excluded"`

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                  - `user_location: optional object`

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

                    - `type: "approximate"`

                    - `city: optional string`

                      The city of the user.

                      minLength: 1, maxLength: 255

                    - `country: optional string`

                      The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.

                      minLength: 2, maxLength: 2

                    - `region: optional string`

                      The region of the user.

                      minLength: 1, maxLength: 255

                    - `timezone: optional string`

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

                      minLength: 1, maxLength: 255

                - `beta_web_fetch_tool_20260318: object`

                  - `type: "web_fetch_20260318"`

                  - `name: "web_fetch"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `allowed_domains: optional array of string`

                    List of domains to allow fetching from

                  - `blocked_domains: optional array of string`

                    List of domains to block fetching from

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `citations: optional object`

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

                    - `enabled: optional boolean`

                  - `defer_loading: optional boolean`

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

                  - `max_content_tokens: optional number`

                    Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.

                    minimum: 1

                  - `max_uses: optional number`

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

                    minimum: 1

                  - `response_inclusion: optional "full" or "excluded"`

                    How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn.

                    - `"full"`

                    - `"excluded"`

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                  - `url_sources: optional object`

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

                    - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`

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

                    - `server_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`

                      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.

                    - `user_input: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone`

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

                  - `use_cache: optional boolean`

                    Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.

                - `beta_advisor_tool_20260301: object`

                  - `type: "advisor_20260301"`

                  - `model: "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-fable-5-1" or 17 more or string`

                    The model that will complete your prompt.

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

                    - `"claude-haiku-5-5"`

                      Fastest model for high-volume, real-time tasks

                    - `"claude-sonnet-5-5"`

                      Efficient model for coding and agents

                    - `"claude-fable-5-1"`

                      Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows

                    - `"claude-opus-5-5"`

                      Powerful intelligence for coding, knowledge work, and long-running agents

                    - `"claude-mythos-5-1"`

                      Our most capable model for cybersecurity and biology research, available through trusted access programs

                    - `"claude-sonnet-5"`

                      Efficient model for coding and agents

                    - `"claude-fable-5"`

                      Next generation of intelligence for the hardest knowledge work and coding problems

                    - `"claude-mythos-5"`

                      Most capable model for cybersecurity and biology research

                    - `"claude-opus-5"`

                      Powerful intelligence for long-running agents and coding

                    - `"claude-opus-4-8"`

                      Powerful intelligence for long-running agents and coding

                    - `"claude-opus-4-7"`

                      Powerful intelligence for long-running agents and coding

                    - `"claude-opus-4-6"`

                      Powerful intelligence for long-running agents and coding

                    - `"claude-sonnet-4-6"`

                      Best combination of speed and intelligence

                    - `"claude-haiku-4-5"`

                    - `"claude-haiku-4-5-20251001"`

                    - `"claude-opus-4-5"`

                      Powerful intelligence for long-running agents and coding

                    - `"claude-opus-4-5-20251101"`

                      Powerful intelligence for long-running agents and coding

                    - `"claude-mythos-preview"`

                      **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

                      New class of intelligence, strongest in coding and cybersecurity

                    - `"claude-sonnet-4-5"`

                      **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

                      High-performance model for agents and coding

                    - `"claude-sonnet-4-5-20250929"`

                      **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

                      High-performance model for agents and coding

                  - `name: "advisor"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `caching: optional object`

                    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.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `max_tokens: optional number`

                    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

                  - `max_uses: optional number`

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

                    minimum: 1

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_tool_search_tool_bm25_20251119: object`

                  - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`

                    - `"tool_search_tool_bm25_20251119"`

                    - `"tool_search_tool_bm25"`

                  - `name: "tool_search_tool_bm25"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_tool_search_tool_regex_20251119: object`

                  - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`

                    - `"tool_search_tool_regex_20251119"`

                    - `"tool_search_tool_regex"`

                  - `name: "tool_search_tool_regex"`

                    Name of the tool.

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

                  - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

                    - `"direct"`

                    - `"code_execution_20250825"`

                    - `"code_execution_20260120"`

                    - `"code_execution_20260521"`

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `defer_loading: optional boolean`

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

                  - `strict: optional boolean`

                    When true, guarantees schema validation on tool names and inputs

                - `beta_mcp_toolset: object`

                  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.

                  - `type: "mcp_toolset"`

                  - `mcp_server_name: string`

                    Name of the MCP server to configure tools for

                    minLength: 1, maxLength: 255

                  - `cache_control: optional object`

                    Create a cache control breakpoint at this content block.

                    - `type: "ephemeral"`

                    - `ttl: optional "5m" or "1h"`

                      The time-to-live for the cache control breakpoint.

                      This may be one the following values:

                      - `5m`: 5 minutes
                      - `1h`: 1 hour

                      Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=cli) for details.

                  - `configs: optional map[BetaMCPToolConfig]`

                    Configuration overrides for specific tools, keyed by tool name

                    - `defer_loading: optional boolean`

                    - `enabled: optional boolean`

                  - `default_config: optional object`

                    Default configuration applied to all tools from this server

                    - `defer_loading: optional boolean`

                    - `enabled: optional boolean`

                  - `tools: optional array of BetaMCPToolParam`

                    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.

                    - `input_schema: map[unknown]`

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

                    - `name: string`

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

                      minLength: 1

                    - `description: optional string`

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

        - `beta_response_tool_removal_block: object`

          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.

          - `type: "tool_removal"`

          - `tool: BetaResponseToolChangeToolReference or BetaResponseToolChangeMCPToolReference or BetaResponseToolChangeMCPToolsetReference`

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

            - `beta_response_tool_change_tool_reference: object`

              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.

            - `beta_response_tool_change_mcp_tool_reference: object`

              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.

            - `beta_response_tool_change_mcp_toolset_reference: object`

              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_fallback_block: object`

      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.

      - `type: "fallback"`

      - `from: object`

        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: "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-fable-5-1" or 17 more or string`

          The model that will complete your prompt.

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

          - `"claude-haiku-5-5"`

            Fastest model for high-volume, real-time tasks

          - `"claude-sonnet-5-5"`

            Efficient model for coding and agents

          - `"claude-fable-5-1"`

            Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows

          - `"claude-opus-5-5"`

            Powerful intelligence for coding, knowledge work, and long-running agents

          - `"claude-mythos-5-1"`

            Our most capable model for cybersecurity and biology research, available through trusted access programs

          - `"claude-sonnet-5"`

            Efficient model for coding and agents

          - `"claude-fable-5"`

            Next generation of intelligence for the hardest knowledge work and coding problems

          - `"claude-mythos-5"`

            Most capable model for cybersecurity and biology research

          - `"claude-opus-5"`

            Powerful intelligence for long-running agents and coding

          - `"claude-opus-4-8"`

            Powerful intelligence for long-running agents and coding

          - `"claude-opus-4-7"`

            Powerful intelligence for long-running agents and coding

          - `"claude-opus-4-6"`

            Powerful intelligence for long-running agents and coding

          - `"claude-sonnet-4-6"`

            Best combination of speed and intelligence

          - `"claude-haiku-4-5"`

          - `"claude-haiku-4-5-20251001"`

          - `"claude-opus-4-5"`

            Powerful intelligence for long-running agents and coding

          - `"claude-opus-4-5-20251101"`

            Powerful intelligence for long-running agents and coding

          - `"claude-mythos-preview"`

            **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

            New class of intelligence, strongest in coding and cybersecurity

          - `"claude-sonnet-4-5"`

            **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

            High-performance model for agents and coding

          - `"claude-sonnet-4-5-20250929"`

            **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

            High-performance model for agents and coding

      - `to: object`

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

        - `model: "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-fable-5-1" or 17 more or string`

          The model that will complete your prompt.

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

      - `trigger: object`

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

        - `type: "refusal"`

        - `category: "cyber" or "bio" or "frontier_llm" or 2 more`

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

            The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category.

          - `"bio"`

            The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category.

          - `"frontier_llm"`

            The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category.

          - `"reasoning_extraction"`

            The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=cli).

          - `"general_harms"`

            The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category.

    - `beta_mcp_tool_listing_block: object`

      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.

      - `type: "mcp_tool_listing"`

      - `mcp_server_name: string`

      - `tools: array of BetaMCPTool`

        - `input_schema: map[unknown]`

        - `name: string`

        - `description: optional string`

  - `context_management: object`

    Context management response.

    Information about context management strategies applied during the request.

    - `applied_edits: array of BetaClearToolUses20250919EditResponse or BetaClearThinking20251015EditResponse`

      List of context management edits that were applied.

      - `beta_clear_tool_uses_20250919_edit_response: object`

        - `type: "clear_tool_uses_20250919"`

          The type of context management edit applied.

        - `cleared_input_tokens: number`

          Number of input tokens cleared by this edit.

          minimum: 0

        - `cleared_tool_uses: number`

          Number of tool uses that were cleared.

          minimum: 0

      - `beta_clear_thinking_20251015_edit_response: object`

        - `type: "clear_thinking_20251015"`

          The type of context management edit applied.

        - `cleared_input_tokens: number`

          Number of input tokens cleared by this edit.

          minimum: 0

        - `cleared_thinking_turns: number`

          Number of thinking turns that were cleared.

          minimum: 0

  - `diagnostics: object`

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

    - `cache_miss_reason: BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more`

      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.

      - `beta_cache_miss_model_changed: object`

        - `type: "model_changed"`

        - `cache_missed_input_tokens: number`

          Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.

      - `beta_cache_miss_system_changed: object`

        - `type: "system_changed"`

        - `cache_missed_input_tokens: number`

          Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.

      - `beta_cache_miss_tools_changed: object`

        - `type: "tools_changed"`

        - `cache_missed_input_tokens: number`

          Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.

      - `beta_cache_miss_messages_changed: object`

        - `type: "messages_changed"`

        - `cache_missed_input_tokens: number`

          Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.

      - `beta_cache_miss_previous_message_not_found: object`

        - `type: "previous_message_not_found"`

      - `beta_cache_miss_unavailable: object`

        - `type: "unavailable"`

  - `model: "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-fable-5-1" or 17 more or string`

    The model that will complete your prompt.

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

    - `"claude-haiku-5-5"`

      Fastest model for high-volume, real-time tasks

    - `"claude-sonnet-5-5"`

      Efficient model for coding and agents

    - `"claude-fable-5-1"`

      Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows

    - `"claude-opus-5-5"`

      Powerful intelligence for coding, knowledge work, and long-running agents

    - `"claude-mythos-5-1"`

      Our most capable model for cybersecurity and biology research, available through trusted access programs

    - `"claude-sonnet-5"`

      Efficient model for coding and agents

    - `"claude-fable-5"`

      Next generation of intelligence for the hardest knowledge work and coding problems

    - `"claude-mythos-5"`

      Most capable model for cybersecurity and biology research

    - `"claude-opus-5"`

      Powerful intelligence for long-running agents and coding

    - `"claude-opus-4-8"`

      Powerful intelligence for long-running agents and coding

    - `"claude-opus-4-7"`

      Powerful intelligence for long-running agents and coding

    - `"claude-opus-4-6"`

      Powerful intelligence for long-running agents and coding

    - `"claude-sonnet-4-6"`

      Best combination of speed and intelligence

    - `"claude-haiku-4-5"`

    - `"claude-haiku-4-5-20251001"`

    - `"claude-opus-4-5"`

      Powerful intelligence for long-running agents and coding

    - `"claude-opus-4-5-20251101"`

      Powerful intelligence for long-running agents and coding

    - `"claude-mythos-preview"`

      **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

      New class of intelligence, strongest in coding and cybersecurity

    - `"claude-sonnet-4-5"`

      **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

      High-performance model for agents and coding

    - `"claude-sonnet-4-5-20250929"`

      **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

      High-performance model for agents and coding

  - `role: "assistant"`

    Conversational role of the generated message.

    This will always be `"assistant"`.

  - `stop_details: object`

    Structured information about why model output stopped.

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

    - `type: "refusal"`

    - `category: "cyber" or "bio" or "frontier_llm" or 2 more`

      The policy category that triggered the refusal.

      `null` when the refusal doesn't map to a named category.

      - `"cyber"`

        The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category.

      - `"bio"`

        The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category.

      - `"frontier_llm"`

        The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category.

      - `"reasoning_extraction"`

        The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=cli).

      - `"general_harms"`

        The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category.

    - `explanation: string`

      Human-readable explanation of the refusal.

      This text is not guaranteed to be stable. `null` when no explanation is available for the category.

    - `fallback_credit_token: string`

      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.

    - `fallback_has_prefill_claim: boolean`

      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.

    - `recommended_model: string`

      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.

  - `stop_reason: "end_turn" or "max_tokens" or "stop_sequence" or 5 more`

    The reason that we stopped.

    This may be one the following values:

    * `"end_turn"`: the model reached a natural stopping point
    * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum
    * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated
    * `"tool_use"`: the model invoked one or more tools
    * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue.
    * `"refusal"`: when streaming classifiers intervene to handle potential policy violations
    * `"model_context_window_exceeded"`: we exceeded the model's context window

    In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise.

    - `"end_turn"`

    - `"max_tokens"`

    - `"stop_sequence"`

    - `"tool_use"`

    - `"pause_turn"`

    - `"compaction"`

    - `"refusal"`

    - `"model_context_window_exceeded"`

  - `stop_sequence: string`

    Which custom stop sequence was generated, if any.

    This value will be a non-null string if one of your custom stop sequences was generated.

  - `usage: object`

    Billing and rate-limit usage.

    Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.

    Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response.

    For example, `output_tokens` will be non-zero, even for an empty string response from Claude.

    Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`.

    - `cache_creation: object`

      Breakdown of cached tokens by TTL

      - `ephemeral_1h_input_tokens: number`

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

        minimum: 0

      - `ephemeral_5m_input_tokens: number`

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

        minimum: 0

    - `cache_creation_input_tokens: number`

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

      minimum: 0

    - `cache_read_input_tokens: number`

      The number of input tokens read from the cache.

      minimum: 0

    - `fallback_credit: object`

      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: BetaFallbackCreditRedeemed or BetaFallbackCreditNotApplied`

        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.

        - `beta_fallback_credit_redeemed: object`

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

          - `type: "redeemed"`

        - `beta_fallback_credit_not_applied: object`

          No reprice was applied; `reason` says why.

          - `type: "not_applied"`

          - `reason: "body_mismatch" or "continuation_excluded" or "continuation_only" or 9 more`

            Why the reprice was not applied.

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

            - `"body_mismatch"`

            - `"continuation_excluded"`

            - `"continuation_only"`

            - `"expired"`

            - `"invalid_target_model"`

            - `"not_enabled"`

            - `"reprice_unavailable"`

            - `"temporarily_unavailable"`

            - `"variant_fields_present"`

            - `"wrong_organization"`

            - `"wrong_platform"`

            - `"wrong_workspace"`

          - `remove_to_redeem: optional array of string`

            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.

    - `inference_geo: string`

      The geographic region where inference was performed for this request.

    - `input_tokens: number`

      The number of input tokens which were used.

      minimum: 0

    - `iterations: array of BetaMessageIterationUsage or BetaCompactionIterationUsage or BetaAdvisorMessageIterationUsage or BetaFallbackMessageIterationUsage`

      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.

      - `beta_message_iteration_usage: object`

        Token usage for a sampling iteration.

        - `type: "message"`

          Usage for a sampling iteration

        - `cache_creation: object`

          Breakdown of cached tokens by TTL

          - `ephemeral_1h_input_tokens: number`

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

            minimum: 0

          - `ephemeral_5m_input_tokens: number`

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

            minimum: 0

        - `cache_creation_input_tokens: number`

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

          minimum: 0

        - `cache_read_input_tokens: number`

          The number of input tokens read from the cache.

          minimum: 0

        - `input_tokens: number`

          The number of input tokens which were used.

          minimum: 0

        - `model: "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-fable-5-1" or 17 more or string`

          The model that will complete your prompt.

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

          - `"claude-haiku-5-5"`

            Fastest model for high-volume, real-time tasks

          - `"claude-sonnet-5-5"`

            Efficient model for coding and agents

          - `"claude-fable-5-1"`

            Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows

          - `"claude-opus-5-5"`

            Powerful intelligence for coding, knowledge work, and long-running agents

          - `"claude-mythos-5-1"`

            Our most capable model for cybersecurity and biology research, available through trusted access programs

          - `"claude-sonnet-5"`

            Efficient model for coding and agents

          - `"claude-fable-5"`

            Next generation of intelligence for the hardest knowledge work and coding problems

          - `"claude-mythos-5"`

            Most capable model for cybersecurity and biology research

          - `"claude-opus-5"`

            Powerful intelligence for long-running agents and coding

          - `"claude-opus-4-8"`

            Powerful intelligence for long-running agents and coding

          - `"claude-opus-4-7"`

            Powerful intelligence for long-running agents and coding

          - `"claude-opus-4-6"`

            Powerful intelligence for long-running agents and coding

          - `"claude-sonnet-4-6"`

            Best combination of speed and intelligence

          - `"claude-haiku-4-5"`

          - `"claude-haiku-4-5-20251001"`

          - `"claude-opus-4-5"`

            Powerful intelligence for long-running agents and coding

          - `"claude-opus-4-5-20251101"`

            Powerful intelligence for long-running agents and coding

          - `"claude-mythos-preview"`

            **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

            New class of intelligence, strongest in coding and cybersecurity

          - `"claude-sonnet-4-5"`

            **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

            High-performance model for agents and coding

          - `"claude-sonnet-4-5-20250929"`

            **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

            High-performance model for agents and coding

        - `output_tokens: number`

          The number of output tokens which were used.

          minimum: 0

      - `beta_compaction_iteration_usage: object`

        Token usage for a compaction iteration.

        - `type: "compaction"`

          Usage for a compaction iteration

        - `cache_creation: object`

          Breakdown of cached tokens by TTL

          - `ephemeral_1h_input_tokens: number`

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

            minimum: 0

          - `ephemeral_5m_input_tokens: number`

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

            minimum: 0

        - `cache_creation_input_tokens: number`

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

          minimum: 0

        - `cache_read_input_tokens: number`

          The number of input tokens read from the cache.

          minimum: 0

        - `input_tokens: number`

          The number of input tokens which were used.

          minimum: 0

        - `output_tokens: number`

          The number of output tokens which were used.

          minimum: 0

      - `beta_advisor_message_iteration_usage: object`

        Token usage for an advisor sub-inference iteration.

        - `type: "advisor_message"`

          Usage for an advisor sub-inference iteration

        - `cache_creation: object`

          Breakdown of cached tokens by TTL

          - `ephemeral_1h_input_tokens: number`

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

            minimum: 0

          - `ephemeral_5m_input_tokens: number`

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

            minimum: 0

        - `cache_creation_input_tokens: number`

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

          minimum: 0

        - `cache_read_input_tokens: number`

          The number of input tokens read from the cache.

          minimum: 0

        - `input_tokens: number`

          The number of input tokens which were used.

          minimum: 0

        - `model: "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-fable-5-1" or 17 more or string`

          The model that will complete your prompt.

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

          - `"claude-haiku-5-5"`

            Fastest model for high-volume, real-time tasks

          - `"claude-sonnet-5-5"`

            Efficient model for coding and agents

          - `"claude-fable-5-1"`

            Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows

          - `"claude-opus-5-5"`

            Powerful intelligence for coding, knowledge work, and long-running agents

          - `"claude-mythos-5-1"`

            Our most capable model for cybersecurity and biology research, available through trusted access programs

          - `"claude-sonnet-5"`

            Efficient model for coding and agents

          - `"claude-fable-5"`

            Next generation of intelligence for the hardest knowledge work and coding problems

          - `"claude-mythos-5"`

            Most capable model for cybersecurity and biology research

          - `"claude-opus-5"`

            Powerful intelligence for long-running agents and coding

          - `"claude-opus-4-8"`

            Powerful intelligence for long-running agents and coding

          - `"claude-opus-4-7"`

            Powerful intelligence for long-running agents and coding

          - `"claude-opus-4-6"`

            Powerful intelligence for long-running agents and coding

          - `"claude-sonnet-4-6"`

            Best combination of speed and intelligence

          - `"claude-haiku-4-5"`

          - `"claude-haiku-4-5-20251001"`

          - `"claude-opus-4-5"`

            Powerful intelligence for long-running agents and coding

          - `"claude-opus-4-5-20251101"`

            Powerful intelligence for long-running agents and coding

          - `"claude-mythos-preview"`

            **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

            New class of intelligence, strongest in coding and cybersecurity

          - `"claude-sonnet-4-5"`

            **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

            High-performance model for agents and coding

          - `"claude-sonnet-4-5-20250929"`

            **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

            High-performance model for agents and coding

        - `output_tokens: number`

          The number of output tokens which were used.

          minimum: 0

      - `beta_fallback_message_iteration_usage: object`

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

        - `type: "fallback_message"`

          Usage for the fallback-model attempt that served the response

        - `cache_creation: object`

          Breakdown of cached tokens by TTL

          - `ephemeral_1h_input_tokens: number`

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

            minimum: 0

          - `ephemeral_5m_input_tokens: number`

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

            minimum: 0

        - `cache_creation_input_tokens: number`

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

          minimum: 0

        - `cache_read_input_tokens: number`

          The number of input tokens read from the cache.

          minimum: 0

        - `input_tokens: number`

          The number of input tokens which were used.

          minimum: 0

        - `model: "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-fable-5-1" or 17 more or string`

          The model that will complete your prompt.

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

          - `"claude-haiku-5-5"`

            Fastest model for high-volume, real-time tasks

          - `"claude-sonnet-5-5"`

            Efficient model for coding and agents

          - `"claude-fable-5-1"`

            Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows

          - `"claude-opus-5-5"`

            Powerful intelligence for coding, knowledge work, and long-running agents

          - `"claude-mythos-5-1"`

            Our most capable model for cybersecurity and biology research, available through trusted access programs

          - `"claude-sonnet-5"`

            Efficient model for coding and agents

          - `"claude-fable-5"`

            Next generation of intelligence for the hardest knowledge work and coding problems

          - `"claude-mythos-5"`

            Most capable model for cybersecurity and biology research

          - `"claude-opus-5"`

            Powerful intelligence for long-running agents and coding

          - `"claude-opus-4-8"`

            Powerful intelligence for long-running agents and coding

          - `"claude-opus-4-7"`

            Powerful intelligence for long-running agents and coding

          - `"claude-opus-4-6"`

            Powerful intelligence for long-running agents and coding

          - `"claude-sonnet-4-6"`

            Best combination of speed and intelligence

          - `"claude-haiku-4-5"`

          - `"claude-haiku-4-5-20251001"`

          - `"claude-opus-4-5"`

            Powerful intelligence for long-running agents and coding

          - `"claude-opus-4-5-20251101"`

            Powerful intelligence for long-running agents and coding

          - `"claude-mythos-preview"`

            **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

            New class of intelligence, strongest in coding and cybersecurity

          - `"claude-sonnet-4-5"`

            **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

            High-performance model for agents and coding

          - `"claude-sonnet-4-5-20250929"`

            **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.

            High-performance model for agents and coding

        - `output_tokens: number`

          The number of output tokens which were used.

          minimum: 0

    - `output_tokens: number`

      The number of output tokens which were used.

      minimum: 0

    - `output_tokens_details: object`

      Breakdown of output tokens by category.

      `output_tokens` remains the inclusive, authoritative total used for billing.
      This object provides a read-only decomposition for observability — for example,
      how many of the billed output tokens were spent on internal reasoning that may
      have been summarized before being returned to you.

      - `thinking_tokens: number`

        Number of output tokens the model generated as internal reasoning, including
        the thinking-block delimiter tokens.

        Reflects the raw reasoning the model produced, not the (possibly shorter)
        summarized thinking text returned in the response body. Computed by
        re-tokenizing the raw reasoning text, so it may differ from the model's exact
        generation count by a small number of tokens. Always ≤ `output_tokens`;
        `output_tokens - thinking_tokens` approximates the non-reasoning output.

        minimum: 0

    - `server_tool_use: object`

      The number of server tool requests.

      - `web_fetch_requests: number`

        The number of web fetch tool requests.

        minimum: 0

      - `web_search_requests: number`

        The number of web search tool requests.

        minimum: 0

    - `service_tier: "standard" or "priority" or "batch"`

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

      - `"standard"`

      - `"priority"`

      - `"batch"`

    - `speed: "standard" or "fast"`

      The inference speed mode used for this request.

      - `"standard"`

      - `"fast"`

  - `input_transformations: optional array of BetaInputTransformation`

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

    - `beta_thinking_dropped_input_transformation: object`

      - `type: "thinking_dropped"`

        Always `thinking_dropped` for this entry type.

      - `path: string`

        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: "model_binding_mismatch" or "prefix_binding_mismatch" or "organization_binding_mismatch" or "end_user_binding_mismatch"`

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

        - `"prefix_binding_mismatch"`

        - `"organization_binding_mismatch"`

        - `"end_user_binding_mismatch"`

    - `beta_thinking_mismatch_allowed_input_transformation: object`

      - `type: "thinking_mismatch_allowed"`

        Always `thinking_mismatch_allowed` for this entry type.

      - `path: string`

        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: "model_binding_mismatch" or "prefix_binding_mismatch" or "organization_binding_mismatch" or "end_user_binding_mismatch"`

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

        - `"prefix_binding_mismatch"`

        - `"organization_binding_mismatch"`

        - `"end_user_binding_mismatch"`

- `beta_raw_message_stream_event: BetaRawMessageStartEvent or BetaRawMessageDeltaEvent or BetaRawMessageStopEvent or 3 more`

  - `beta_raw_message_start_event: object`

    - `type: "message_start"`

    - `message: object`

      - `type: "message"`

        Object type.

        For Messages, this is always `"message"`.

      - `id: string`

        Unique object identifier.

        The format and length of IDs may change over time.

      - `container: object`

        Information about the container used in this request.

        This will be non-null if a container tool (e.g. code execution) was used.

      - `content: array of BetaContentBlock`

        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)"}]
        ```

      - `context_management: object`

        Context management response.

        Information about context management strategies applied during the request.

      - `diagnostics: object`

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

      - `model: "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-fable-5-1" or 17 more or string`

        The model that will complete your prompt.

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

      - `role: "assistant"`

        Conversational role of the generated message.

        This will always be `"assistant"`.

      - `stop_details: object`

        Structured information about why model output stopped.

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

      - `stop_reason: "end_turn" or "max_tokens" or "stop_sequence" or 5 more`

        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.

      - `stop_sequence: string`

        Which custom stop sequence was generated, if any.

        This value will be a non-null string if one of your custom stop sequences was generated.

      - `usage: object`

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

      - `input_transformations: optional array of BetaInputTransformation`

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

  - `beta_raw_message_delta_event: object`

    - `type: "message_delta"`

    - `context_management: object`

      Information about context management strategies applied during the request

      - `applied_edits: array of BetaClearToolUses20250919EditResponse or BetaClearThinking20251015EditResponse`

        List of context management edits that were applied.

    - `delta: object`

      - `container: object`

        Information about the container used in this request.

        This will be non-null if a container tool (e.g. code execution) was used.

        - `id: string`

          Identifier for the container used in this request

        - `expires_at: string`

          The time at which the container will expire.

          format: date-time

        - `skills: array of BetaContainerSkill`

          Skills loaded in the container

      - `stop_details: object`

        Structured information about why model output stopped.

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

        - `type: "refusal"`

        - `category: "cyber" or "bio" or "frontier_llm" or 2 more`

          The policy category that triggered the refusal.

          `null` when the refusal doesn't map to a named category.

        - `explanation: string`

          Human-readable explanation of the refusal.

          This text is not guaranteed to be stable. `null` when no explanation is available for the category.

        - `fallback_credit_token: string`

          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.

        - `fallback_has_prefill_claim: boolean`

          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.

        - `recommended_model: string`

          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.

      - `stop_reason: "end_turn" or "max_tokens" or "stop_sequence" or 5 more`

        - `"end_turn"`

        - `"max_tokens"`

        - `"stop_sequence"`

        - `"tool_use"`

        - `"pause_turn"`

        - `"compaction"`

        - `"refusal"`

        - `"model_context_window_exceeded"`

      - `stop_sequence: string`

    - `usage: object`

      Billing and rate-limit usage.

      Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.

      Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response.

      For example, `output_tokens` will be non-zero, even for an empty string response from Claude.

      Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`.

      - `cache_creation_input_tokens: number`

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

        minimum: 0

      - `cache_read_input_tokens: number`

        The cumulative number of input tokens read from the cache.

        minimum: 0

      - `fallback_credit: object`

        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: BetaFallbackCreditRedeemed or BetaFallbackCreditNotApplied`

          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.

      - `input_tokens: number`

        The cumulative number of input tokens which were used.

        minimum: 0

      - `iterations: array of BetaMessageIterationUsage or BetaCompactionIterationUsage or BetaAdvisorMessageIterationUsage or BetaFallbackMessageIterationUsage`

        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.

        - `beta_message_iteration_usage: object`

          Token usage for a sampling iteration.

        - `beta_compaction_iteration_usage: object`

          Token usage for a compaction iteration.

        - `beta_advisor_message_iteration_usage: object`

          Token usage for an advisor sub-inference iteration.

        - `beta_fallback_message_iteration_usage: object`

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

      - `output_tokens: number`

        The cumulative number of output tokens which were used.

      - `output_tokens_details: object`

        Breakdown of output tokens by category.

        `output_tokens` remains the inclusive, authoritative total used for billing.
        This object provides a read-only decomposition for observability — for example,
        how many of the billed output tokens were spent on internal reasoning that may
        have been summarized before being returned to you.

        - `thinking_tokens: number`

          Number of output tokens the model generated as internal reasoning, including
          the thinking-block delimiter tokens.

          Reflects the raw reasoning the model produced, not the (possibly shorter)
          summarized thinking text returned in the response body. Computed by
          re-tokenizing the raw reasoning text, so it may differ from the model's exact
          generation count by a small number of tokens. Always ≤ `output_tokens`;
          `output_tokens - thinking_tokens` approximates the non-reasoning output.

          minimum: 0

      - `server_tool_use: object`

        The number of server tool requests.

        - `web_fetch_requests: number`

          The number of web fetch tool requests.

          minimum: 0

        - `web_search_requests: number`

          The number of web search tool requests.

          minimum: 0

    - `input_transformations: optional array of BetaInputTransformation`

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

      - `beta_thinking_dropped_input_transformation: object`

      - `beta_thinking_mismatch_allowed_input_transformation: object`

  - `beta_raw_message_stop_event: object`

    - `type: "message_stop"`

  - `beta_raw_content_block_start_event: object`

    - `type: "content_block_start"`

    - `content_block: BetaTextBlock or BetaThinkingBlock or BetaRedactedThinkingBlock or 15 more`

      - `beta_text_block: object`

        - `type: "text"`

        - `citations: array of BetaTextCitation`

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

        - `text: string`

      - `beta_thinking_block: object`

        - `type: "thinking"`

        - `signature: string`

          A value used to verify that this thinking block was generated by Claude when it is passed back to the API.

          This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact.

          See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=cli) for details.

        - `thinking: string`

          The text of Claude's thinking process for this block.

      - `beta_redacted_thinking_block: object`

        - `type: "redacted_thinking"`

        - `data: string`

          The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content.

          Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.

          See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=cli#redacted-thinking-blocks) for details.

      - `beta_tool_use_block: object`

        - `type: "tool_use"`

        - `id: string`

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

        - `input: map[unknown]`

        - `name: string`

          minLength: 1

        - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120`

        - `toolset_name: optional string`

          For a toolset member tool_use, the toolset family.

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

      - `beta_server_tool_use_block: object`

        - `type: "server_tool_use"`

        - `id: string`

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

        - `input: map[unknown]`

        - `name: "advisor" or "web_search" or "web_fetch" or 5 more`

        - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120`

      - `beta_web_search_tool_result_block: object`

        - `type: "web_search_tool_result"`

        - `content: BetaWebSearchToolResultError or array of BetaWebSearchResultBlock`

        - `tool_use_id: string`

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

        - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120`

      - `beta_web_fetch_tool_result_block: object`

        - `type: "web_fetch_tool_result"`

        - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock`

        - `tool_use_id: string`

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

        - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120`

      - `beta_advisor_tool_result_block: object`

        - `type: "advisor_tool_result"`

        - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock`

        - `tool_use_id: string`

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

      - `beta_code_execution_tool_result_block: object`

        - `type: "code_execution_tool_result"`

        - `content: BetaCodeExecutionToolResultError or BetaCodeExecutionResultBlock or BetaEncryptedCodeExecutionResultBlock`

        - `tool_use_id: string`

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

      - `beta_bash_code_execution_tool_result_block: object`

        - `type: "bash_code_execution_tool_result"`

        - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock`

        - `tool_use_id: string`

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

      - `beta_text_editor_code_execution_tool_result_block: object`

        - `type: "text_editor_code_execution_tool_result"`

        - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock`

        - `tool_use_id: string`

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

      - `beta_tool_search_tool_result_block: object`

        - `type: "tool_search_tool_result"`

        - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock`

        - `tool_use_id: string`

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

      - `beta_mcp_tool_use_block: object`

        - `type: "mcp_tool_use"`

        - `id: string`

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

        - `input: map[unknown]`

        - `name: string`

          The name of the MCP tool

        - `server_name: string`

          The name of the MCP server

      - `beta_mcp_tool_result_block: object`

        - `type: "mcp_tool_result"`

        - `content: string or array of BetaTextBlock`

        - `is_error: boolean`

        - `tool_use_id: string`

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

      - `beta_container_upload_block: object`

        Response model for a file uploaded to the container.

        - `type: "container_upload"`

        - `file_id: string`

      - `beta_compaction_block: object`

        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.

        - `type: "compaction"`

        - `content: string`

          Summary of compacted content, or null if compaction failed

        - `encrypted_content: string`

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

        - `signature: optional string`

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

        - `tool_changes: optional array of BetaResponseToolAdditionBlock or BetaResponseToolRemovalBlock`

          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.

      - `beta_fallback_block: object`

        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.

        - `type: "fallback"`

        - `from: object`

          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.

        - `to: object`

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

        - `trigger: object`

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

      - `beta_mcp_tool_listing_block: object`

        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.

        - `type: "mcp_tool_listing"`

        - `mcp_server_name: string`

        - `tools: array of BetaMCPTool`

    - `index: number`

  - `beta_raw_content_block_delta_event: object`

    - `type: "content_block_delta"`

    - `delta: BetaTextDelta or BetaInputJSONDelta or BetaCitationsDelta or 3 more`

      - `beta_text_delta: object`

        - `type: "text_delta"`

        - `text: string`

      - `beta_input_json_delta: object`

        - `type: "input_json_delta"`

        - `partial_json: string`

      - `beta_citations_delta: object`

        - `type: "citations_delta"`

        - `citation: BetaCitationCharLocation or BetaCitationPageLocation or BetaCitationContentBlockLocation or 2 more`

          - `beta_citation_char_location: object`

            - `type: "char_location"`

            - `cited_text: string`

            - `document_index: number`

              minimum: 0

            - `document_title: string`

            - `end_char_index: number`

            - `file_id: string`

            - `start_char_index: number`

              minimum: 0

          - `beta_citation_page_location: object`

            - `type: "page_location"`

            - `cited_text: string`

            - `document_index: number`

              minimum: 0

            - `document_title: string`

            - `end_page_number: number`

            - `file_id: string`

            - `start_page_number: number`

              minimum: 1

          - `beta_citation_content_block_location: object`

            - `type: "content_block_location"`

            - `cited_text: string`

              The full text of the cited block range, concatenated.

              Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.

            - `document_index: number`

              minimum: 0

            - `document_title: string`

            - `end_block_index: number`

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

              Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.

            - `file_id: string`

            - `start_block_index: number`

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

              minimum: 0

          - `beta_citations_web_search_result_location: object`

            - `type: "web_search_result_location"`

            - `cited_text: string`

            - `encrypted_index: string`

            - `title: string`

              maxLength: 512

            - `url: string`

          - `beta_citation_search_result_location: object`

            - `type: "search_result_location"`

            - `cited_text: string`

              The full text of the cited block range, concatenated.

              Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.

            - `end_block_index: number`

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

              Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`.

            - `search_result_index: number`

              0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results.

              Counted separately from `document_index`; server-side web search results are not included in this count.

              minimum: 0

            - `source: string`

            - `start_block_index: number`

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

              minimum: 0

            - `title: string`

      - `beta_thinking_delta: object`

        - `type: "thinking_delta"`

        - `estimated_tokens: number`

          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.

        - `thinking: string`

          The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value.

      - `beta_signature_delta: object`

        - `type: "signature_delta"`

        - `signature: string`

          The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event.

      - `beta_compaction_content_block_delta: object`

        - `type: "compaction_delta"`

        - `content: string`

        - `encrypted_content: string`

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

    - `index: number`

  - `beta_raw_content_block_stop_event: object`

    - `type: "content_block_stop"`

    - `index: number`

## Example

```bash
ant beta:messages create \
  --api-key my-anthropic-api-key \
  --max-tokens 1024 \
  --message '{content: [{text: x, type: text}], role: user}' \
  --model claude-opus-5-5
```

### 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"
    }
  ]
}
```
