Loading...
    • Developer Guide
    • API Reference
    • MCP
    • Resources
    • Release Notes
    Search...
    ⌘K
    Using the API
    API overviewBeta 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

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

    Count the number of tokens in a Message.

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

    Learn more about token counting in our user guide

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

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

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

    Input messages.

    Our models are trained to operate on alternating user and assistant conversational turns. When creating a new Message, you specify the prior conversational turns with the messages parameter, and the model then generates the next Message in the conversation. Consecutive user or assistant turns in your request will be combined into a single turn.

    Each input message must be an object with a role and content. You can specify a single user-role message, or you can include multiple user and assistant messages.

    If the final message uses the assistant role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response.

    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:
    String text
    JsonValue; type "text"constant"text"constant
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Tool invocation directly from the model.

    Accepts one of the following:
    class BetaDirectCaller:

    Tool invocation directly from the model.

    JsonValue; type "direct"constant"direct"constant
    class BetaServerToolCaller:

    Tool invocation generated by a server-side tool.

    String toolId
    JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
    class BetaServerToolCaller20260120:
    String toolId
    JsonValue; type "code_execution_20260120"constant"code_execution_20260120"constant
    class BetaToolResultBlockParam:
    String toolUseId
    JsonValue; type "tool_result"constant"tool_result"constant
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Tool reference block that can be included in tool_result content.

    String toolName
    JsonValue; type "tool_reference"constant"tool_reference"constant
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    Optional<Boolean> isError
    class BetaServerToolUseBlockParam:
    String id
    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")
    JsonValue; type "server_tool_use"constant"server_tool_use"constant
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Tool invocation directly from the model.

    Accepts one of the following:
    class BetaDirectCaller:

    Tool invocation directly from the model.

    JsonValue; type "direct"constant"direct"constant
    class BetaServerToolCaller:

    Tool invocation generated by a server-side tool.

    String toolId
    JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
    class BetaServerToolCaller20260120:
    String toolId
    JsonValue; type "code_execution_20260120"constant"code_execution_20260120"constant
    class BetaWebSearchToolResultBlockParam:
    BetaWebSearchToolResultBlockParamContent content
    Accepts one of the following:
    List<BetaWebSearchResultBlockParam>
    String encryptedContent
    String title
    JsonValue; type "web_search_result"constant"web_search_result"constant
    String url
    Optional<String> pageAge
    class BetaWebSearchToolRequestError:
    BetaWebSearchToolResultErrorCode errorCode
    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")
    REQUEST_TOO_LARGE("request_too_large")
    JsonValue; type "web_search_tool_result_error"constant"web_search_tool_result_error"constant
    String toolUseId
    JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Tool invocation directly from the model.

    Accepts one of the following:
    class BetaDirectCaller:

    Tool invocation directly from the model.

    JsonValue; type "direct"constant"direct"constant
    class BetaServerToolCaller:

    Tool invocation generated by a server-side tool.

    String toolId
    JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
    class BetaServerToolCaller20260120:
    String toolId
    JsonValue; type "code_execution_20260120"constant"code_execution_20260120"constant
    class BetaWebFetchToolResultBlockParam:
    Content content
    Accepts one of the following:
    class BetaWebFetchToolResultErrorBlockParam:
    BetaWebFetchToolResultErrorCode errorCode
    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")
    JsonValue; type "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
    class BetaWebFetchBlockParam:
    BetaRequestDocumentBlock content
    Source source
    Accepts one of the following:
    class BetaBase64PdfSource:
    String data
    JsonValue; mediaType "application/pdf"constant"application/pdf"constant
    JsonValue; type "base64"constant"base64"constant
    class BetaPlainTextSource:
    String data
    JsonValue; mediaType "text/plain"constant"text/plain"constant
    JsonValue; type "text"constant"text"constant
    class BetaContentBlockSource:
    Content content
    Accepts one of the following:
    String
    List<BetaContentBlockSourceContent>
    Accepts one of the following:
    class BetaTextBlockParam:
    String text
    JsonValue; type "text"constant"text"constant
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Fetched content URL

    Optional<String> retrievedAt

    ISO 8601 timestamp when the content was retrieved

    String toolUseId
    JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Tool invocation directly from the model.

    Accepts one of the following:
    class BetaDirectCaller:

    Tool invocation directly from the model.

    JsonValue; type "direct"constant"direct"constant
    class BetaServerToolCaller:

    Tool invocation generated by a server-side tool.

    String toolId
    JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
    class BetaServerToolCaller20260120:
    String toolId
    JsonValue; type "code_execution_20260120"constant"code_execution_20260120"constant
    class BetaCodeExecutionToolResultBlockParam:
    BetaCodeExecutionToolResultBlockParamContent content

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

    Accepts one of the following:
    class BetaCodeExecutionToolResultErrorParam:
    BetaCodeExecutionToolResultErrorCode 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")
    JsonValue; type "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
    class BetaCodeExecutionResultBlockParam:
    List<BetaCodeExecutionOutputBlockParam> content
    String fileId
    JsonValue; type "code_execution_output"constant"code_execution_output"constant
    long returnCode
    String stderr
    String stdout
    JsonValue; type "code_execution_result"constant"code_execution_result"constant
    class BetaEncryptedCodeExecutionResultBlockParam:

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

    List<BetaCodeExecutionOutputBlockParam> content
    String fileId
    JsonValue; type "code_execution_output"constant"code_execution_output"constant
    String encryptedStdout
    long returnCode
    String stderr
    JsonValue; type "encrypted_code_execution_result"constant"encrypted_code_execution_result"constant
    String toolUseId
    JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

    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")
    JsonValue; type "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
    class BetaBashCodeExecutionResultBlockParam:
    List<BetaBashCodeExecutionOutputBlockParam> content
    String fileId
    JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
    long returnCode
    String stderr
    String stdout
    JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
    String toolUseId
    JsonValue; type "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

    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")
    JsonValue; type "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
    Optional<String> errorMessage
    class BetaTextEditorCodeExecutionViewResultBlockParam:
    String content
    FileType fileType
    Accepts one of the following:
    TEXT("text")
    IMAGE("image")
    PDF("pdf")
    JsonValue; type "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
    Optional<Long> numLines
    Optional<Long> startLine
    Optional<Long> totalLines
    class BetaTextEditorCodeExecutionCreateResultBlockParam:
    boolean isFileUpdate
    JsonValue; type "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
    class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:
    JsonValue; type "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
    Optional<List<String>> lines
    Optional<Long> newLines
    Optional<Long> newStart
    Optional<Long> oldLines
    Optional<Long> oldStart
    String toolUseId
    JsonValue; type "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

    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")
    JsonValue; type "tool_search_tool_result_error"constant"tool_search_tool_result_error"constant
    class BetaToolSearchToolSearchResultBlockParam:
    List<BetaToolReferenceBlockParam> toolReferences
    String toolName
    JsonValue; type "tool_reference"constant"tool_reference"constant
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    The name of the MCP server

    JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    String fileId
    JsonValue; type "container_upload"constant"container_upload"constant
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaCompactionBlockParam:

    A compaction block containing summary of previous context.

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

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

    Optional<String> content

    Summary of previously compacted content, or null if compaction failed

    JsonValue; type "compaction"constant"compaction"constant
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

    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.

    Optional<BetaCacheControlEphemeral> cacheControl

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

    Optional<BetaContextManagementConfig> contextManagement

    Context management configuration.

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

    Optional<List<BetaRequestMcpServerUrlDefinition>> mcpServers

    MCP servers to be utilized in this request

    String name
    JsonValue; type "url"constant"url"constant
    String url
    Optional<String> authorizationToken
    Optional<BetaRequestMcpServerToolConfiguration> toolConfiguration
    Optional<List<String>> allowedTools
    Optional<Boolean> enabled
    Optional<BetaOutputConfig> outputConfig

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

    DeprecatedOptional<BetaJsonOutputFormat> outputFormat

    Deprecated: Use output_config.format instead. See structured outputs

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

    Optional<Speed> speed

    The inference speed mode for this request. "fast" enables high output-tokens-per-second inference.

    STANDARD("standard")
    FAST("fast")
    Optional<System> system

    System prompt.

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

    String
    List<BetaTextBlockParam>
    String text
    JsonValue; type "text"constant"text"constant
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    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.

    Optional<BetaToolChoice> toolChoice

    How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.

    Optional<List<Tool>> tools

    Definitions of tools that the model may use.

    If you include tools in your API request, the model may return tool_use content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using tool_result content blocks.

    There are two types of tools: client tools and server tools. The behavior described below applies to client tools. For server tools, 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.

    JsonValue; type "object"constant"object"constant
    Optional<Properties> properties
    Optional<List<String>> required
    String name

    Name of the tool.

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

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<String> description

    Description of what this tool does.

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

    Optional<Boolean> eagerInputStreaming

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

    Optional<List<InputExample>> inputExamples
    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    Optional<Type> type
    class BetaToolBash20241022:
    JsonValue; name "bash"constant"bash"constant

    Name of the tool.

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

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<List<InputExample>> inputExamples
    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    class BetaToolBash20250124:
    JsonValue; name "bash"constant"bash"constant

    Name of the tool.

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

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<List<InputExample>> inputExamples
    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    class BetaCodeExecutionTool20250522:
    JsonValue; name "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.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    class BetaCodeExecutionTool20250825:
    JsonValue; name "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.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    class BetaCodeExecutionTool20260120:

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

    JsonValue; name "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.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    class BetaToolComputerUse20241022:
    long displayHeightPx

    The height of the display in pixels.

    long displayWidthPx

    The width of the display in pixels.

    JsonValue; name "computer"constant"computer"constant

    Name of the tool.

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

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<Long> displayNumber

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

    Optional<List<InputExample>> inputExamples
    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    class BetaMemoryTool20250818:
    JsonValue; name "memory"constant"memory"constant

    Name of the tool.

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

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<List<InputExample>> inputExamples
    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    class BetaToolComputerUse20250124:
    long displayHeightPx

    The height of the display in pixels.

    long displayWidthPx

    The width of the display in pixels.

    JsonValue; name "computer"constant"computer"constant

    Name of the tool.

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

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<Long> displayNumber

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

    Optional<List<InputExample>> inputExamples
    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    class BetaToolTextEditor20241022:
    JsonValue; name "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.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<List<InputExample>> inputExamples
    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    class BetaToolComputerUse20251124:
    long displayHeightPx

    The height of the display in pixels.

    long displayWidthPx

    The width of the display in pixels.

    JsonValue; name "computer"constant"computer"constant

    Name of the tool.

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

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<Long> displayNumber

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

    Optional<Boolean> enableZoom

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

    Optional<List<InputExample>> inputExamples
    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    class BetaToolTextEditor20250124:
    JsonValue; name "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.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<List<InputExample>> inputExamples
    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    class BetaToolTextEditor20250429:
    JsonValue; name "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.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<List<InputExample>> inputExamples
    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    class BetaToolTextEditor20250728:
    JsonValue; name "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.

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

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

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

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

    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    class BetaWebSearchTool20250305:
    JsonValue; name "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.

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

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

    Optional<List<String>> blockedDomains

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

    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<Long> maxUses

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

    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    Optional<BetaUserLocation> userLocation

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

    JsonValue; type "approximate"constant"approximate"constant
    Optional<String> city

    The city of the user.

    Optional<String> country

    The two letter ISO country code of the user.

    Optional<String> region

    The region of the user.

    Optional<String> timezone

    The IANA timezone of the user.

    class BetaWebFetchTool20250910:
    JsonValue; name "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.

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

    List of domains to allow fetching from

    Optional<List<String>> blockedDomains

    List of domains to block fetching from

    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<Boolean> enabled
    Optional<Boolean> deferLoading

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

    Optional<Long> maxContentTokens

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

    Optional<Long> maxUses

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

    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    class BetaWebSearchTool20260209:
    JsonValue; name "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.

    JsonValue; type "web_search_20260209"constant"web_search_20260209"constant
    Optional<List<AllowedCaller>> allowedCallers
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    CODE_EXECUTION_20260120("code_execution_20260120")
    Optional<List<String>> allowedDomains

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

    Optional<List<String>> blockedDomains

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

    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<Long> maxUses

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

    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    Optional<BetaUserLocation> userLocation

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

    JsonValue; type "approximate"constant"approximate"constant
    Optional<String> city

    The city of the user.

    Optional<String> country

    The two letter ISO country code of the user.

    Optional<String> region

    The region of the user.

    Optional<String> timezone

    The IANA timezone of the user.

    class BetaWebFetchTool20260209:
    JsonValue; name "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.

    JsonValue; type "web_fetch_20260209"constant"web_fetch_20260209"constant
    Optional<List<AllowedCaller>> allowedCallers
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    CODE_EXECUTION_20260120("code_execution_20260120")
    Optional<List<String>> allowedDomains

    List of domains to allow fetching from

    Optional<List<String>> blockedDomains

    List of domains to block fetching from

    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<Boolean> enabled
    Optional<Boolean> deferLoading

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

    Optional<Long> maxContentTokens

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

    Optional<Long> maxUses

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

    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    class BetaToolSearchToolBm25_20251119:
    JsonValue; name "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.

    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")
    Optional<List<AllowedCaller>> allowedCallers
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    CODE_EXECUTION_20260120("code_execution_20260120")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    class BetaToolSearchToolRegex20251119:
    JsonValue; name "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.

    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")
    Optional<List<AllowedCaller>> allowedCallers
    Accepts one of the following:
    DIRECT("direct")
    CODE_EXECUTION_20250825("code_execution_20250825")
    CODE_EXECUTION_20260120("code_execution_20260120")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Optional<Boolean> strict

    When true, guarantees schema validation on tool names and inputs

    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.

    String mcpServerName

    Name of the MCP server to configure tools for

    JsonValue; type "mcp_toolset"constant"mcp_toolset"constant
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

    JsonValue; type "ephemeral"constant"ephemeral"constant
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Configuration overrides for specific tools, keyed by tool name

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

    Default configuration applied to all tools from this server

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

    Information about context management applied to the message.

    long originalInputTokens

    The original token count before context management was applied

    long inputTokens

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

    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;
    
    public final class Main {
        private Main() {}
    
        public static void main(String[] args) {
            AnthropicClient client = AnthropicOkHttpClient.fromEnv();
    
            MessageCountTokensParams params = MessageCountTokensParams.builder()
                .addUserMessage("Hello, world")
                .model(Model.CLAUDE_OPUS_4_6)
                .build();
            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