Loading...
    • Developer Guide
    • API Reference
    • MCP
    • Resources
    • Release Notes
    Search...
    ⌘K
    Using the API
    Features overviewClient SDKsBeta headersErrors
    Messages
    Create a Message
    Count tokens in a Message
    Models
    List Models
    Get a Model
    Beta
    Create a Message
    Count tokens in a Message
    Admin
    Completions
    Create a Text Completion
    Support & configuration
    Rate limitsService tiersVersionsIP addressesSupported regionsOpenAI SDK compatibility
    Console
    Log in

    Count tokens in a Message

    beta().messages().countTokens(MessageCountTokensParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : BetaMessageTokensCount
    post/v1/messages/count_tokens

    Count the number of tokens in a Message.

    The Token Count API can be used to count the number of tokens in a Message, including tools, images, and documents, without creating it.

    Learn more about token counting in our user guide

    ParametersExpand Collapse
    params: MessageCountTokensParams
    betas: Optional<List<AnthropicBeta>>

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

    MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")
    PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")
    COMPUTER_USE_2024_10_22("computer-use-2024-10-22")
    COMPUTER_USE_2025_01_24("computer-use-2025-01-24")
    PDFS_2024_09_25("pdfs-2024-09-25")
    TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")
    TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")
    OUTPUT_128K_2025_02_19("output-128k-2025-02-19")
    FILES_API_2025_04_14("files-api-2025-04-14")
    MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")
    MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")
    DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")
    INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")
    CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")
    EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")
    CONTEXT_1M_2025_08_07("context-1m-2025-08-07")
    CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")
    MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")
    SKILLS_2025_10_02("skills-2025-10-02")
    messages: List<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.

    Example with a single user message:

    [{"role": "user", "content": "Hello, Claude"}]
    

    Example with multiple conversational turns:

    [
      {"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:

    [
      {"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:

    {"role": "user", "content": "Hello, Claude"}
    
    {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]}
    

    See input examples.

    Note that if you want to include a system prompt, you can use the top-level system parameter — there is no "system" role for input messages in the Messages API.

    There is a limit of 100,000 messages in a single request.

    content: Content
    Accepts one of the following:
    String
    List<BetaContentBlockParam>
    Accepts one of the following:
    class BetaTextBlockParam:
    text: String
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    citations: Optional<List<BetaTextCitationParam>>
    Accepts one of the following:
    class BetaCitationCharLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endCharIndex: Long
    startCharIndex: Long
    type: JsonValue; "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endPageNumber: Long
    startPageNumber: Long
    type: JsonValue; "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endBlockIndex: Long
    startBlockIndex: Long
    type: JsonValue; "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    citedText: String
    encryptedIndex: String
    title: Optional<String>
    type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    url: String
    class BetaCitationSearchResultLocationParam:
    citedText: String
    endBlockIndex: Long
    searchResultIndex: Long
    source: String
    startBlockIndex: Long
    title: Optional<String>
    type: JsonValue; "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    class BetaImageBlockParam:
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource:
    data: String
    mediaType: MediaType
    Accepts one of the following:
    IMAGE_JPEG("image/jpeg")
    IMAGE_PNG("image/png")
    IMAGE_GIF("image/gif")
    IMAGE_WEBP("image/webp")
    type: JsonValue; "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    type: JsonValue; "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    url: String
    class BetaFileImageSource:
    fileId: String
    type: JsonValue; "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    type: JsonValue; "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaRequestDocumentBlock:
    source: Source
    Accepts one of the following:
    class BetaBase64PdfSource:
    data: String
    mediaType: JsonValue; "application/pdf"constant"application/pdf"constant
    Accepts one of the following:
    APPLICATION_PDF("application/pdf")
    type: JsonValue; "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaPlainTextSource:
    data: String
    mediaType: JsonValue; "text/plain"constant"text/plain"constant
    Accepts one of the following:
    TEXT_PLAIN("text/plain")
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class BetaContentBlockSource:
    content: Content
    Accepts one of the following:
    String
    List<BetaContentBlockSourceContent>
    Accepts one of the following:
    class BetaTextBlockParam:
    text: String
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    citations: Optional<List<BetaTextCitationParam>>
    Accepts one of the following:
    class BetaCitationCharLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endCharIndex: Long
    startCharIndex: Long
    type: JsonValue; "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endPageNumber: Long
    startPageNumber: Long
    type: JsonValue; "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endBlockIndex: Long
    startBlockIndex: Long
    type: JsonValue; "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    citedText: String
    encryptedIndex: String
    title: Optional<String>
    type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    url: String
    class BetaCitationSearchResultLocationParam:
    citedText: String
    endBlockIndex: Long
    searchResultIndex: Long
    source: String
    startBlockIndex: Long
    title: Optional<String>
    type: JsonValue; "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    class BetaImageBlockParam:
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource:
    data: String
    mediaType: MediaType
    Accepts one of the following:
    IMAGE_JPEG("image/jpeg")
    IMAGE_PNG("image/png")
    IMAGE_GIF("image/gif")
    IMAGE_WEBP("image/webp")
    type: JsonValue; "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    type: JsonValue; "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    url: String
    class BetaFileImageSource:
    fileId: String
    type: JsonValue; "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    type: JsonValue; "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    type: JsonValue; "content"constant"content"constant
    Accepts one of the following:
    CONTENT("content")
    class BetaUrlPdfSource:
    type: JsonValue; "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    url: String
    class BetaFileDocumentSource:
    fileId: String
    type: JsonValue; "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    type: JsonValue; "document"constant"document"constant
    Accepts one of the following:
    DOCUMENT("document")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    citations: Optional<BetaCitationsConfigParam>
    enabled: Optional<Boolean>
    context: Optional<String>
    title: Optional<String>
    class BetaSearchResultBlockParam:
    content: List<BetaTextBlockParam>
    text: String
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    citations: Optional<List<BetaTextCitationParam>>
    Accepts one of the following:
    class BetaCitationCharLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endCharIndex: Long
    startCharIndex: Long
    type: JsonValue; "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endPageNumber: Long
    startPageNumber: Long
    type: JsonValue; "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endBlockIndex: Long
    startBlockIndex: Long
    type: JsonValue; "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    citedText: String
    encryptedIndex: String
    title: Optional<String>
    type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    url: String
    class BetaCitationSearchResultLocationParam:
    citedText: String
    endBlockIndex: Long
    searchResultIndex: Long
    source: String
    startBlockIndex: Long
    title: Optional<String>
    type: JsonValue; "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    source: String
    title: String
    type: JsonValue; "search_result"constant"search_result"constant
    Accepts one of the following:
    SEARCH_RESULT("search_result")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    citations: Optional<BetaCitationsConfigParam>
    enabled: Optional<Boolean>
    class BetaThinkingBlockParam:
    signature: String
    thinking: String
    type: JsonValue; "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class BetaRedactedThinkingBlockParam:
    data: String
    type: JsonValue; "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class BetaToolUseBlockParam:
    id: String
    input: Input
    name: String
    type: JsonValue; "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    caller: Optional<Caller>

    Tool invocation directly from the model.

    Accepts one of the following:
    class BetaDirectCaller:

    Tool invocation directly from the model.

    type: JsonValue; "direct"constant"direct"constant
    Accepts one of the following:
    DIRECT("direct")
    class BetaServerToolCaller:

    Tool invocation generated by a server-side tool.

    toolId: String
    type: JsonValue; "code_execution_20250825"constant"code_execution_20250825"constant
    Accepts one of the following:
    CODE_EXECUTION_20250825("code_execution_20250825")
    class BetaToolResultBlockParam:
    toolUseId: String
    type: JsonValue; "tool_result"constant"tool_result"constant
    Accepts one of the following:
    TOOL_RESULT("tool_result")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    content: Optional<Content>
    Accepts one of the following:
    String
    List<Block>
    Accepts one of the following:
    class BetaTextBlockParam:
    text: String
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    citations: Optional<List<BetaTextCitationParam>>
    Accepts one of the following:
    class BetaCitationCharLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endCharIndex: Long
    startCharIndex: Long
    type: JsonValue; "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endPageNumber: Long
    startPageNumber: Long
    type: JsonValue; "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endBlockIndex: Long
    startBlockIndex: Long
    type: JsonValue; "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    citedText: String
    encryptedIndex: String
    title: Optional<String>
    type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    url: String
    class BetaCitationSearchResultLocationParam:
    citedText: String
    endBlockIndex: Long
    searchResultIndex: Long
    source: String
    startBlockIndex: Long
    title: Optional<String>
    type: JsonValue; "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    class BetaImageBlockParam:
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource:
    data: String
    mediaType: MediaType
    Accepts one of the following:
    IMAGE_JPEG("image/jpeg")
    IMAGE_PNG("image/png")
    IMAGE_GIF("image/gif")
    IMAGE_WEBP("image/webp")
    type: JsonValue; "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    type: JsonValue; "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    url: String
    class BetaFileImageSource:
    fileId: String
    type: JsonValue; "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    type: JsonValue; "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaSearchResultBlockParam:
    content: List<BetaTextBlockParam>
    text: String
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    citations: Optional<List<BetaTextCitationParam>>
    Accepts one of the following:
    class BetaCitationCharLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endCharIndex: Long
    startCharIndex: Long
    type: JsonValue; "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endPageNumber: Long
    startPageNumber: Long
    type: JsonValue; "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endBlockIndex: Long
    startBlockIndex: Long
    type: JsonValue; "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    citedText: String
    encryptedIndex: String
    title: Optional<String>
    type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    url: String
    class BetaCitationSearchResultLocationParam:
    citedText: String
    endBlockIndex: Long
    searchResultIndex: Long
    source: String
    startBlockIndex: Long
    title: Optional<String>
    type: JsonValue; "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    source: String
    title: String
    type: JsonValue; "search_result"constant"search_result"constant
    Accepts one of the following:
    SEARCH_RESULT("search_result")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    citations: Optional<BetaCitationsConfigParam>
    enabled: Optional<Boolean>
    class BetaRequestDocumentBlock:
    source: Source
    Accepts one of the following:
    class BetaBase64PdfSource:
    data: String
    mediaType: JsonValue; "application/pdf"constant"application/pdf"constant
    Accepts one of the following:
    APPLICATION_PDF("application/pdf")
    type: JsonValue; "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaPlainTextSource:
    data: String
    mediaType: JsonValue; "text/plain"constant"text/plain"constant
    Accepts one of the following:
    TEXT_PLAIN("text/plain")
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class BetaContentBlockSource:
    content: Content
    Accepts one of the following:
    String
    List<BetaContentBlockSourceContent>
    Accepts one of the following:
    class BetaTextBlockParam:
    text: String
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    citations: Optional<List<BetaTextCitationParam>>
    Accepts one of the following:
    class BetaCitationCharLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endCharIndex: Long
    startCharIndex: Long
    type: JsonValue; "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endPageNumber: Long
    startPageNumber: Long
    type: JsonValue; "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endBlockIndex: Long
    startBlockIndex: Long
    type: JsonValue; "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    citedText: String
    encryptedIndex: String
    title: Optional<String>
    type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    url: String
    class BetaCitationSearchResultLocationParam:
    citedText: String
    endBlockIndex: Long
    searchResultIndex: Long
    source: String
    startBlockIndex: Long
    title: Optional<String>
    type: JsonValue; "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    class BetaImageBlockParam:
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource:
    data: String
    mediaType: MediaType
    Accepts one of the following:
    IMAGE_JPEG("image/jpeg")
    IMAGE_PNG("image/png")
    IMAGE_GIF("image/gif")
    IMAGE_WEBP("image/webp")
    type: JsonValue; "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    type: JsonValue; "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    url: String
    class BetaFileImageSource:
    fileId: String
    type: JsonValue; "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    type: JsonValue; "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    type: JsonValue; "content"constant"content"constant
    Accepts one of the following:
    CONTENT("content")
    class BetaUrlPdfSource:
    type: JsonValue; "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    url: String
    class BetaFileDocumentSource:
    fileId: String
    type: JsonValue; "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    type: JsonValue; "document"constant"document"constant
    Accepts one of the following:
    DOCUMENT("document")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    citations: Optional<BetaCitationsConfigParam>
    enabled: Optional<Boolean>
    context: Optional<String>
    title: Optional<String>
    class BetaToolReferenceBlockParam:

    Tool reference block that can be included in tool_result content.

    toolName: String
    type: JsonValue; "tool_reference"constant"tool_reference"constant
    Accepts one of the following:
    TOOL_REFERENCE("tool_reference")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    isError: Optional<Boolean>
    class BetaServerToolUseBlockParam:
    id: String
    input: Input
    name: Name
    Accepts one of the following:
    WEB_SEARCH("web_search")
    WEB_FETCH("web_fetch")
    CODE_EXECUTION("code_execution")
    BASH_CODE_EXECUTION("bash_code_execution")
    TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")
    TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")
    TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")
    type: JsonValue; "server_tool_use"constant"server_tool_use"constant
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    caller: Optional<Caller>

    Tool invocation directly from the model.

    Accepts one of the following:
    class BetaDirectCaller:

    Tool invocation directly from the model.

    type: JsonValue; "direct"constant"direct"constant
    Accepts one of the following:
    DIRECT("direct")
    class BetaServerToolCaller:

    Tool invocation generated by a server-side tool.

    toolId: String
    type: JsonValue; "code_execution_20250825"constant"code_execution_20250825"constant
    Accepts one of the following:
    CODE_EXECUTION_20250825("code_execution_20250825")
    class BetaWebSearchToolResultBlockParam:
    content: BetaWebSearchToolResultBlockParamContent
    Accepts one of the following:
    List<BetaWebSearchResultBlockParam>
    encryptedContent: String
    title: String
    type: JsonValue; "web_search_result"constant"web_search_result"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT("web_search_result")
    url: String
    pageAge: Optional<String>
    class BetaWebSearchToolRequestError:
    errorCode: BetaWebSearchToolResultErrorCode
    Accepts one of the following:
    INVALID_TOOL_INPUT("invalid_tool_input")
    UNAVAILABLE("unavailable")
    MAX_USES_EXCEEDED("max_uses_exceeded")
    TOO_MANY_REQUESTS("too_many_requests")
    QUERY_TOO_LONG("query_too_long")
    type: JsonValue; "web_search_tool_result_error"constant"web_search_tool_result_error"constant
    Accepts one of the following:
    WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")
    toolUseId: String
    type: JsonValue; "web_search_tool_result"constant"web_search_tool_result"constant
    Accepts one of the following:
    WEB_SEARCH_TOOL_RESULT("web_search_tool_result")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaWebFetchToolResultBlockParam:
    content: Content
    Accepts one of the following:
    class BetaWebFetchToolResultErrorBlockParam:
    errorCode: BetaWebFetchToolResultErrorCode
    Accepts one of the following:
    INVALID_TOOL_INPUT("invalid_tool_input")
    URL_TOO_LONG("url_too_long")
    URL_NOT_ALLOWED("url_not_allowed")
    URL_NOT_ACCESSIBLE("url_not_accessible")
    UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")
    TOO_MANY_REQUESTS("too_many_requests")
    MAX_USES_EXCEEDED("max_uses_exceeded")
    UNAVAILABLE("unavailable")
    type: JsonValue; "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
    Accepts one of the following:
    WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")
    class BetaWebFetchBlockParam:
    content: BetaRequestDocumentBlock
    source: Source
    Accepts one of the following:
    class BetaBase64PdfSource:
    data: String
    mediaType: JsonValue; "application/pdf"constant"application/pdf"constant
    Accepts one of the following:
    APPLICATION_PDF("application/pdf")
    type: JsonValue; "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaPlainTextSource:
    data: String
    mediaType: JsonValue; "text/plain"constant"text/plain"constant
    Accepts one of the following:
    TEXT_PLAIN("text/plain")
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class BetaContentBlockSource:
    content: Content
    Accepts one of the following:
    String
    List<BetaContentBlockSourceContent>
    Accepts one of the following:
    class BetaTextBlockParam:
    text: String
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    citations: Optional<List<BetaTextCitationParam>>
    Accepts one of the following:
    class BetaCitationCharLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endCharIndex: Long
    startCharIndex: Long
    type: JsonValue; "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endPageNumber: Long
    startPageNumber: Long
    type: JsonValue; "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endBlockIndex: Long
    startBlockIndex: Long
    type: JsonValue; "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    citedText: String
    encryptedIndex: String
    title: Optional<String>
    type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    url: String
    class BetaCitationSearchResultLocationParam:
    citedText: String
    endBlockIndex: Long
    searchResultIndex: Long
    source: String
    startBlockIndex: Long
    title: Optional<String>
    type: JsonValue; "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    class BetaImageBlockParam:
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource:
    data: String
    mediaType: MediaType
    Accepts one of the following:
    IMAGE_JPEG("image/jpeg")
    IMAGE_PNG("image/png")
    IMAGE_GIF("image/gif")
    IMAGE_WEBP("image/webp")
    type: JsonValue; "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    type: JsonValue; "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    url: String
    class BetaFileImageSource:
    fileId: String
    type: JsonValue; "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    type: JsonValue; "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    type: JsonValue; "content"constant"content"constant
    Accepts one of the following:
    CONTENT("content")
    class BetaUrlPdfSource:
    type: JsonValue; "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    url: String
    class BetaFileDocumentSource:
    fileId: String
    type: JsonValue; "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    type: JsonValue; "document"constant"document"constant
    Accepts one of the following:
    DOCUMENT("document")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    citations: Optional<BetaCitationsConfigParam>
    enabled: Optional<Boolean>
    context: Optional<String>
    title: Optional<String>
    type: JsonValue; "web_fetch_result"constant"web_fetch_result"constant
    Accepts one of the following:
    WEB_FETCH_RESULT("web_fetch_result")
    url: String

    Fetched content URL

    retrievedAt: Optional<String>

    ISO 8601 timestamp when the content was retrieved

    toolUseId: String
    type: JsonValue; "web_fetch_tool_result"constant"web_fetch_tool_result"constant
    Accepts one of the following:
    WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaCodeExecutionToolResultBlockParam:
    content: BetaCodeExecutionToolResultBlockParamContent
    Accepts one of the following:
    class BetaCodeExecutionToolResultErrorParam:
    errorCode: BetaCodeExecutionToolResultErrorCode
    Accepts one of the following:
    INVALID_TOOL_INPUT("invalid_tool_input")
    UNAVAILABLE("unavailable")
    TOO_MANY_REQUESTS("too_many_requests")
    EXECUTION_TIME_EXCEEDED("execution_time_exceeded")
    type: JsonValue; "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")
    class BetaCodeExecutionResultBlockParam:
    content: List<BetaCodeExecutionOutputBlockParam>
    fileId: String
    type: JsonValue; "code_execution_output"constant"code_execution_output"constant
    Accepts one of the following:
    CODE_EXECUTION_OUTPUT("code_execution_output")
    returnCode: Long
    stderr: String
    stdout: String
    type: JsonValue; "code_execution_result"constant"code_execution_result"constant
    Accepts one of the following:
    CODE_EXECUTION_RESULT("code_execution_result")
    toolUseId: String
    type: JsonValue; "code_execution_tool_result"constant"code_execution_tool_result"constant
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaBashCodeExecutionToolResultBlockParam:
    content: Content
    Accepts one of the following:
    class BetaBashCodeExecutionToolResultErrorParam:
    errorCode: ErrorCode
    Accepts one of the following:
    INVALID_TOOL_INPUT("invalid_tool_input")
    UNAVAILABLE("unavailable")
    TOO_MANY_REQUESTS("too_many_requests")
    EXECUTION_TIME_EXCEEDED("execution_time_exceeded")
    OUTPUT_FILE_TOO_LARGE("output_file_too_large")
    type: JsonValue; "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")
    class BetaBashCodeExecutionResultBlockParam:
    content: List<BetaBashCodeExecutionOutputBlockParam>
    fileId: String
    type: JsonValue; "bash_code_execution_output"constant"bash_code_execution_output"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")
    returnCode: Long
    stderr: String
    stdout: String
    type: JsonValue; "bash_code_execution_result"constant"bash_code_execution_result"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")
    toolUseId: String
    type: JsonValue; "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaTextEditorCodeExecutionToolResultBlockParam:
    content: Content
    Accepts one of the following:
    class BetaTextEditorCodeExecutionToolResultErrorParam:
    errorCode: ErrorCode
    Accepts one of the following:
    INVALID_TOOL_INPUT("invalid_tool_input")
    UNAVAILABLE("unavailable")
    TOO_MANY_REQUESTS("too_many_requests")
    EXECUTION_TIME_EXCEEDED("execution_time_exceeded")
    FILE_NOT_FOUND("file_not_found")
    type: JsonValue; "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")
    errorMessage: Optional<String>
    class BetaTextEditorCodeExecutionViewResultBlockParam:
    content: String
    fileType: FileType
    Accepts one of the following:
    TEXT("text")
    IMAGE("image")
    PDF("pdf")
    type: JsonValue; "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")
    numLines: Optional<Long>
    startLine: Optional<Long>
    totalLines: Optional<Long>
    class BetaTextEditorCodeExecutionCreateResultBlockParam:
    isFileUpdate: Boolean
    type: JsonValue; "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")
    class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:
    type: JsonValue; "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")
    lines: Optional<List<String>>
    newLines: Optional<Long>
    newStart: Optional<Long>
    oldLines: Optional<Long>
    oldStart: Optional<Long>
    toolUseId: String
    type: JsonValue; "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaToolSearchToolResultBlockParam:
    content: Content
    Accepts one of the following:
    class BetaToolSearchToolResultErrorParam:
    errorCode: ErrorCode
    Accepts one of the following:
    INVALID_TOOL_INPUT("invalid_tool_input")
    UNAVAILABLE("unavailable")
    TOO_MANY_REQUESTS("too_many_requests")
    EXECUTION_TIME_EXCEEDED("execution_time_exceeded")
    type: JsonValue; "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
    Accepts one of the following:
    TOOL_SEARCH_TOOL_RESULT_ERROR("tool_search_tool_result_error")
    class BetaToolSearchToolSearchResultBlockParam:
    toolReferences: List<BetaToolReferenceBlockParam>
    toolName: String
    type: JsonValue; "tool_reference"constant"tool_reference"constant
    Accepts one of the following:
    TOOL_REFERENCE("tool_reference")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    type: JsonValue; "tool_search_tool_search_result"constant"tool_search_tool_search_result"constant
    Accepts one of the following:
    TOOL_SEARCH_TOOL_SEARCH_RESULT("tool_search_tool_search_result")
    toolUseId: String
    type: JsonValue; "tool_search_tool_result"constant"tool_search_tool_result"constant
    Accepts one of the following:
    TOOL_SEARCH_TOOL_RESULT("tool_search_tool_result")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaMcpToolUseBlockParam:
    id: String
    input: Input
    name: String
    serverName: String

    The name of the MCP server

    type: JsonValue; "mcp_tool_use"constant"mcp_tool_use"constant
    Accepts one of the following:
    MCP_TOOL_USE("mcp_tool_use")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaRequestMcpToolResultBlockParam:
    toolUseId: String
    type: JsonValue; "mcp_tool_result"constant"mcp_tool_result"constant
    Accepts one of the following:
    MCP_TOOL_RESULT("mcp_tool_result")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    content: Optional<Content>
    Accepts one of the following:
    String
    List<BetaTextBlockParam>
    text: String
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    citations: Optional<List<BetaTextCitationParam>>
    Accepts one of the following:
    class BetaCitationCharLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endCharIndex: Long
    startCharIndex: Long
    type: JsonValue; "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endPageNumber: Long
    startPageNumber: Long
    type: JsonValue; "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endBlockIndex: Long
    startBlockIndex: Long
    type: JsonValue; "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    citedText: String
    encryptedIndex: String
    title: Optional<String>
    type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    url: String
    class BetaCitationSearchResultLocationParam:
    citedText: String
    endBlockIndex: Long
    searchResultIndex: Long
    source: String
    startBlockIndex: Long
    title: Optional<String>
    type: JsonValue; "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    isError: Optional<Boolean>
    class BetaContainerUploadBlockParam:

    A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory.

    fileId: String
    type: JsonValue; "container_upload"constant"container_upload"constant
    Accepts one of the following:
    CONTAINER_UPLOAD("container_upload")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    role: Role
    Accepts one of the following:
    USER("user")
    ASSISTANT("assistant")
    model: Model

    The model that will complete your prompt.

    See models for additional details and options.

    contextManagement: Optional<BetaContextManagementConfig>

    Context management configuration.

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

    mcpServers: Optional<List<BetaRequestMcpServerUrlDefinition>>

    MCP servers to be utilized in this request

    name: String
    type: JsonValue; "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    url: String
    authorizationToken: Optional<String>
    toolConfiguration: Optional<BetaRequestMcpServerToolConfiguration>
    allowedTools: Optional<List<String>>
    enabled: Optional<Boolean>
    outputConfig: Optional<BetaOutputConfig>

    Configuration options for the model's output. Controls aspects like how much effort the model puts into its response.

    outputFormat: Optional<BetaJsonOutputFormat>

    A schema to specify Claude's output format in responses.

    system: Optional<System>

    System prompt.

    A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our guide to system prompts.

    String
    List<BetaTextBlockParam>
    text: String
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    citations: Optional<List<BetaTextCitationParam>>
    Accepts one of the following:
    class BetaCitationCharLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endCharIndex: Long
    startCharIndex: Long
    type: JsonValue; "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endPageNumber: Long
    startPageNumber: Long
    type: JsonValue; "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    citedText: String
    documentIndex: Long
    documentTitle: Optional<String>
    endBlockIndex: Long
    startBlockIndex: Long
    type: JsonValue; "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    citedText: String
    encryptedIndex: String
    title: Optional<String>
    type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    url: String
    class BetaCitationSearchResultLocationParam:
    citedText: String
    endBlockIndex: Long
    searchResultIndex: Long
    source: String
    startBlockIndex: Long
    title: Optional<String>
    type: JsonValue; "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    thinking: Optional<BetaThinkingConfigParam>

    Configuration for enabling Claude's extended thinking.

    When enabled, responses include thinking content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your max_tokens limit.

    See extended thinking for details.

    toolChoice: Optional<BetaToolChoice>

    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.

    tools: Optional<List<Tool>>

    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, see their individual documentation as each has its own behavior (e.g., the web search tool).

    Each tool definition includes:

    • name: Name of the tool.
    • description: Optional, but strongly-recommended description of the tool.
    • input_schema: JSON schema for the tool input shape that the model will produce in tool_use output content blocks.

    For example, if you defined tools as:

    [
      {
        "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:

    [
      {
        "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:

    [
      {
        "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 for more details.

    class BetaTool:
    inputSchema: InputSchema

    JSON schema for this tool's input.

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

    type: JsonValue; "object"constant"object"constant
    Accepts one of the following:
    OBJECT("object")
    properties: Optional<Properties>
    required: Optional<List<String>>
    name: String

    Name of the tool.

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

    maxLength128
    minLength1
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    deferLoading: 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.

    inputExamples: Optional<List<InputExample>>
    strict: Optional<Boolean>
    type: Optional<Type>
    Accepts one of the following:
    CUSTOM("custom")
    class BetaToolBash20241022:
    name: JsonValue; "bash"constant"bash"constant

    Name of the tool.

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

    Accepts one of the following:
    BASH("bash")
    type: JsonValue; "bash_20241022"constant"bash_20241022"constant
    Accepts one of the following:
    BASH_20241022("bash_20241022")
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    deferLoading: Optional<Boolean>

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

    inputExamples: Optional<List<InputExample>>
    strict: Optional<Boolean>
    class BetaToolBash20250124:
    name: JsonValue; "bash"constant"bash"constant

    Name of the tool.

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

    Accepts one of the following:
    BASH("bash")
    type: JsonValue; "bash_20250124"constant"bash_20250124"constant
    Accepts one of the following:
    BASH_20250124("bash_20250124")
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    deferLoading: Optional<Boolean>

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

    inputExamples: Optional<List<InputExample>>
    strict: Optional<Boolean>
    class BetaCodeExecutionTool20250522:
    name: JsonValue; "code_execution"constant"code_execution"constant

    Name of the tool.

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

    Accepts one of the following:
    CODE_EXECUTION("code_execution")
    type: JsonValue; "code_execution_20250522"constant"code_execution_20250522"constant
    Accepts one of the following:
    CODE_EXECUTION_20250522("code_execution_20250522")
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    deferLoading: 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>
    class BetaCodeExecutionTool20250825:
    name: JsonValue; "code_execution"constant"code_execution"constant

    Name of the tool.

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

    Accepts one of the following:
    CODE_EXECUTION("code_execution")
    type: JsonValue; "code_execution_20250825"constant"code_execution_20250825"constant
    Accepts one of the following:
    CODE_EXECUTION_20250825("code_execution_20250825")
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    deferLoading: 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>
    class BetaToolComputerUse20241022:
    displayHeightPx: Long

    The height of the display in pixels.

    minimum1
    displayWidthPx: Long

    The width of the display in pixels.

    minimum1
    name: JsonValue; "computer"constant"computer"constant

    Name of the tool.

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

    Accepts one of the following:
    COMPUTER("computer")
    type: JsonValue; "computer_20241022"constant"computer_20241022"constant
    Accepts one of the following:
    COMPUTER_20241022("computer_20241022")
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    deferLoading: Optional<Boolean>

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

    displayNumber: Optional<Long>

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

    minimum0
    inputExamples: Optional<List<InputExample>>
    strict: Optional<Boolean>
    class BetaMemoryTool20250818:
    name: JsonValue; "memory"constant"memory"constant

    Name of the tool.

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

    Accepts one of the following:
    MEMORY("memory")
    type: JsonValue; "memory_20250818"constant"memory_20250818"constant
    Accepts one of the following:
    MEMORY_20250818("memory_20250818")
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    deferLoading: Optional<Boolean>

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

    inputExamples: Optional<List<InputExample>>
    strict: Optional<Boolean>
    class BetaToolComputerUse20250124:
    displayHeightPx: Long

    The height of the display in pixels.

    minimum1
    displayWidthPx: Long

    The width of the display in pixels.

    minimum1
    name: JsonValue; "computer"constant"computer"constant

    Name of the tool.

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

    Accepts one of the following:
    COMPUTER("computer")
    type: JsonValue; "computer_20250124"constant"computer_20250124"constant
    Accepts one of the following:
    COMPUTER_20250124("computer_20250124")
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    deferLoading: Optional<Boolean>

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

    displayNumber: Optional<Long>

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

    minimum0
    inputExamples: Optional<List<InputExample>>
    strict: Optional<Boolean>
    class BetaToolTextEditor20241022:
    name: JsonValue; "str_replace_editor"constant"str_replace_editor"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_EDITOR("str_replace_editor")
    type: JsonValue; "text_editor_20241022"constant"text_editor_20241022"constant
    Accepts one of the following:
    TEXT_EDITOR_20241022("text_editor_20241022")
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    deferLoading: Optional<Boolean>

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

    inputExamples: Optional<List<InputExample>>
    strict: Optional<Boolean>
    class BetaToolComputerUse20251124:
    displayHeightPx: Long

    The height of the display in pixels.

    minimum1
    displayWidthPx: Long

    The width of the display in pixels.

    minimum1
    name: JsonValue; "computer"constant"computer"constant

    Name of the tool.

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

    Accepts one of the following:
    COMPUTER("computer")
    type: JsonValue; "computer_20251124"constant"computer_20251124"constant
    Accepts one of the following:
    COMPUTER_20251124("computer_20251124")
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    deferLoading: Optional<Boolean>

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

    displayNumber: Optional<Long>

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

    minimum0
    enableZoom: Optional<Boolean>

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

    inputExamples: Optional<List<InputExample>>
    strict: Optional<Boolean>
    class BetaToolTextEditor20250124:
    name: JsonValue; "str_replace_editor"constant"str_replace_editor"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_EDITOR("str_replace_editor")
    type: JsonValue; "text_editor_20250124"constant"text_editor_20250124"constant
    Accepts one of the following:
    TEXT_EDITOR_20250124("text_editor_20250124")
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    deferLoading: Optional<Boolean>

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

    inputExamples: Optional<List<InputExample>>
    strict: Optional<Boolean>
    class BetaToolTextEditor20250429:
    name: JsonValue; "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_BASED_EDIT_TOOL("str_replace_based_edit_tool")
    type: JsonValue; "text_editor_20250429"constant"text_editor_20250429"constant
    Accepts one of the following:
    TEXT_EDITOR_20250429("text_editor_20250429")
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    deferLoading: Optional<Boolean>

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

    inputExamples: Optional<List<InputExample>>
    strict: Optional<Boolean>
    class BetaToolTextEditor20250728:
    name: JsonValue; "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_BASED_EDIT_TOOL("str_replace_based_edit_tool")
    type: JsonValue; "text_editor_20250728"constant"text_editor_20250728"constant
    Accepts one of the following:
    TEXT_EDITOR_20250728("text_editor_20250728")
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    deferLoading: Optional<Boolean>

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

    inputExamples: Optional<List<InputExample>>
    maxCharacters: Optional<Long>

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

    minimum1
    strict: Optional<Boolean>
    class BetaWebSearchTool20250305:
    name: JsonValue; "web_search"constant"web_search"constant

    Name of the tool.

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

    Accepts one of the following:
    WEB_SEARCH("web_search")
    type: JsonValue; "web_search_20250305"constant"web_search_20250305"constant
    Accepts one of the following:
    WEB_SEARCH_20250305("web_search_20250305")
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    allowedDomains: Optional<List<String>>

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

    blockedDomains: Optional<List<String>>

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

    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    deferLoading: Optional<Boolean>

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

    maxUses: Optional<Long>

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

    exclusiveMinimum0
    strict: Optional<Boolean>
    userLocation: Optional<UserLocation>

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

    type: JsonValue; "approximate"constant"approximate"constant
    Accepts one of the following:
    APPROXIMATE("approximate")
    city: Optional<String>

    The city of the user.

    maxLength255
    minLength1
    country: Optional<String>

    The two letter ISO country code of the user.

    maxLength2
    minLength2
    region: Optional<String>

    The region of the user.

    maxLength255
    minLength1
    timezone: Optional<String>

    The IANA timezone of the user.

    maxLength255
    minLength1
    class BetaWebFetchTool20250910:
    name: JsonValue; "web_fetch"constant"web_fetch"constant

    Name of the tool.

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

    Accepts one of the following:
    WEB_FETCH("web_fetch")
    type: JsonValue; "web_fetch_20250910"constant"web_fetch_20250910"constant
    Accepts one of the following:
    WEB_FETCH_20250910("web_fetch_20250910")
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    allowedDomains: Optional<List<String>>

    List of domains to allow fetching from

    blockedDomains: Optional<List<String>>

    List of domains to block fetching from

    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    citations: Optional<BetaCitationsConfigParam>

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

    enabled: Optional<Boolean>
    deferLoading: Optional<Boolean>

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

    maxContentTokens: Optional<Long>

    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.

    exclusiveMinimum0
    maxUses: Optional<Long>

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

    exclusiveMinimum0
    strict: Optional<Boolean>
    class BetaToolSearchToolBm25_20251119:
    name: JsonValue; "tool_search_tool_bm25"constant"tool_search_tool_bm25"constant

    Name of the tool.

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

    Accepts one of the following:
    TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")
    type: Type
    Accepts one of the following:
    TOOL_SEARCH_TOOL_BM25_20251119("tool_search_tool_bm25_20251119")
    TOOL_SEARCH_TOOL_BM25("tool_search_tool_bm25")
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    deferLoading: 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>
    class BetaToolSearchToolRegex20251119:
    name: JsonValue; "tool_search_tool_regex"constant"tool_search_tool_regex"constant

    Name of the tool.

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

    Accepts one of the following:
    TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")
    type: Type
    Accepts one of the following:
    TOOL_SEARCH_TOOL_REGEX_20251119("tool_search_tool_regex_20251119")
    TOOL_SEARCH_TOOL_REGEX("tool_search_tool_regex")
    allowedCallers: Optional<List<AllowedCaller>>
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    deferLoading: 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>
    class BetaMcpToolset:

    Configuration for a group of tools from an MCP server.

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

    mcpServerName: String

    Name of the MCP server to configure tools for

    maxLength255
    minLength1
    type: JsonValue; "mcp_toolset"constant"mcp_toolset"constant
    Accepts one of the following:
    MCP_TOOLSET("mcp_toolset")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

    type: JsonValue; "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    ttl: Optional<Ttl>

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

    This may be one the following values:

    • 5m: 5 minutes
    • 1h: 1 hour

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    configs: Optional<Configs>

    Configuration overrides for specific tools, keyed by tool name

    deferLoading: Optional<Boolean>
    enabled: Optional<Boolean>
    defaultConfig: Optional<BetaMcpToolDefaultConfig>

    Default configuration applied to all tools from this server

    deferLoading: Optional<Boolean>
    enabled: Optional<Boolean>
    ReturnsExpand Collapse
    class BetaMessageTokensCount:
    contextManagement: Optional<BetaCountTokensContextManagementResponse>

    Information about context management applied to the message.

    originalInputTokens: Long

    The original token count before context management was applied

    inputTokens: Long

    The total number of tokens across the provided list of messages, system prompt, and tools.

    Count tokens in a Message
    package com.anthropic.example
    
    import com.anthropic.client.AnthropicClient
    import com.anthropic.client.okhttp.AnthropicOkHttpClient
    import com.anthropic.models.beta.messages.BetaMessageTokensCount
    import com.anthropic.models.beta.messages.MessageCountTokensParams
    import com.anthropic.models.messages.Model
    
    fun main() {
        val client: AnthropicClient = AnthropicOkHttpClient.fromEnv()
    
        val params: MessageCountTokensParams = MessageCountTokensParams.builder()
            .addUserMessage("Hello, world")
            .model(Model.CLAUDE_OPUS_4_5_20251101)
            .build()
        val betaMessageTokensCount: BetaMessageTokensCount = client.beta().messages().countTokens(params)
    }
    Response 200
    {
      "context_management": {
        "original_input_tokens": 0
      },
      "input_tokens": 2095
    }
    Returns Examples
    Response 200
    {
      "context_management": {
        "original_input_tokens": 0
      },
      "input_tokens": 2095
    }

    Solutions

    • AI agents
    • Code modernization
    • Coding
    • Customer support
    • Education
    • Financial services
    • Government
    • Life sciences

    Partners

    • Amazon Bedrock
    • Google Cloud's Vertex AI

    Learn

    • Blog
    • Catalog
    • Courses
    • Use cases
    • Connectors
    • Customer stories
    • Engineering at Anthropic
    • Events
    • Powered by Claude
    • Service partners
    • Startups program

    Company

    • Anthropic
    • Careers
    • Economic Futures
    • Research
    • News
    • Responsible Scaling Policy
    • Security and compliance
    • Transparency

    Learn

    • Blog
    • Catalog
    • Courses
    • Use cases
    • Connectors
    • Customer stories
    • Engineering at Anthropic
    • Events
    • Powered by Claude
    • Service partners
    • Startups program

    Help and security

    • Availability
    • Status
    • Support
    • Discord

    Terms and policies

    • Privacy policy
    • Responsible disclosure policy
    • Terms of service: Commercial
    • Terms of service: Consumer
    • Usage policy