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

    Messages

    Create a Message
    BetaMessage beta().messages().create(MessageCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
    post/v1/messages
    Count tokens in a Message
    BetaMessageTokensCount beta().messages().countTokens(MessageCountTokensParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
    post/v1/messages/count_tokens
    ModelsExpand Collapse
    class BetaAllThinkingTurns:
    JsonValue; type "all"constant"all"constant
    Accepts one of the following:
    ALL("all")
    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
    Accepts one of the following:
    BASE64("base64")
    class BetaBase64PdfSource:
    String data
    JsonValue; mediaType "application/pdf"constant"application/pdf"constant
    Accepts one of the following:
    APPLICATION_PDF("application/pdf")
    JsonValue; type "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaBashCodeExecutionOutputBlock:
    String fileId
    JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")
    class BetaBashCodeExecutionOutputBlockParam:
    String fileId
    JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")
    class BetaBashCodeExecutionResultBlock:
    List<BetaBashCodeExecutionOutputBlock> content
    String fileId
    JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")
    class BetaBashCodeExecutionResultBlockParam:
    List<BetaBashCodeExecutionOutputBlockParam> content
    String fileId
    JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")
    class BetaBashCodeExecutionToolResultBlock:
    Content content
    Accepts one of the following:
    class BetaBashCodeExecutionToolResultError:
    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
    Accepts one of the following:
    BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")
    class BetaBashCodeExecutionResultBlock:
    List<BetaBashCodeExecutionOutputBlock> content
    String fileId
    JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")
    String toolUseId
    JsonValue; type "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")
    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
    Accepts one of the following:
    BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")
    class BetaBashCodeExecutionResultBlockParam:
    List<BetaBashCodeExecutionOutputBlockParam> content
    String fileId
    JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")
    String toolUseId
    JsonValue; type "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")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaBashCodeExecutionToolResultError:
    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
    Accepts one of the following:
    BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")
    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
    Accepts one of the following:
    BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")
    class BetaCacheControlEphemeral:
    JsonValue; type "ephemeral"constant"ephemeral"constant
    Accepts one of the following:
    EPHEMERAL("ephemeral")
    Optional<Ttl> ttl

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    minimum0
    long ephemeral5mInputTokens

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

    minimum0
    class BetaCitationCharLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationCharLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endCharIndex
    long startCharIndex
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationConfig:
    boolean enabled
    class BetaCitationContentBlockLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationPageLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    String source
    long startBlockIndex
    Optional<String> title
    JsonValue; type "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    String url
    class BetaCitationsConfigParam:
    Optional<Boolean> enabled
    class BetaCitationsDelta:
    Citation citation
    Accepts one of the following:
    class BetaCitationCharLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    String url
    class BetaCitationSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    String source
    long startBlockIndex
    Optional<String> title
    JsonValue; type "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    JsonValue; type "citations_delta"constant"citations_delta"constant
    Accepts one of the following:
    CITATIONS_DELTA("citations_delta")
    class BetaCitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    String url
    class BetaClearThinking20251015Edit:
    JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant
    Accepts one of the following:
    CLEAR_THINKING_20251015("clear_thinking_20251015")
    Optional<Keep> keep

    Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.

    Accepts one of the following:
    class BetaThinkingTurns:
    JsonValue; type "thinking_turns"constant"thinking_turns"constant
    Accepts one of the following:
    THINKING_TURNS("thinking_turns")
    long value
    class BetaAllThinkingTurns:
    JsonValue; type "all"constant"all"constant
    Accepts one of the following:
    ALL("all")
    JsonValue;
    Accepts one of the following:
    ALL("all")
    class BetaClearThinking20251015EditResponse:
    long clearedInputTokens

    Number of input tokens cleared by this edit.

    minimum0
    long clearedThinkingTurns

    Number of thinking turns that were cleared.

    minimum0
    JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant

    The type of context management edit applied.

    Accepts one of the following:
    CLEAR_THINKING_20251015("clear_thinking_20251015")
    class BetaClearToolUses20250919Edit:
    JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant
    Accepts one of the following:
    CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")
    Optional<BetaInputTokensClearAtLeast> clearAtLeast

    Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.

    JsonValue; type "input_tokens"constant"input_tokens"constant
    Accepts one of the following:
    INPUT_TOKENS("input_tokens")
    long value
    Optional<ClearToolInputs> clearToolInputs

    Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)

    Accepts one of the following:
    boolean
    List<String>
    Optional<List<String>> excludeTools

    Tool names whose uses are preserved from clearing

    Optional<BetaToolUsesKeep> keep

    Number of tool uses to retain in the conversation

    JsonValue; type "tool_uses"constant"tool_uses"constant
    Accepts one of the following:
    TOOL_USES("tool_uses")
    long value
    Optional<Trigger> trigger

    Condition that triggers the context management strategy

    Accepts one of the following:
    class BetaInputTokensTrigger:
    JsonValue; type "input_tokens"constant"input_tokens"constant
    Accepts one of the following:
    INPUT_TOKENS("input_tokens")
    long value
    class BetaToolUsesTrigger:
    JsonValue; type "tool_uses"constant"tool_uses"constant
    Accepts one of the following:
    TOOL_USES("tool_uses")
    long value
    class BetaClearToolUses20250919EditResponse:
    long clearedInputTokens

    Number of input tokens cleared by this edit.

    minimum0
    long clearedToolUses

    Number of tool uses that were cleared.

    minimum0
    JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant

    The type of context management edit applied.

    Accepts one of the following:
    CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")
    class BetaCodeExecutionOutputBlock:
    String fileId
    JsonValue; type "code_execution_output"constant"code_execution_output"constant
    Accepts one of the following:
    CODE_EXECUTION_OUTPUT("code_execution_output")
    class BetaCodeExecutionOutputBlockParam:
    String fileId
    JsonValue; type "code_execution_output"constant"code_execution_output"constant
    Accepts one of the following:
    CODE_EXECUTION_OUTPUT("code_execution_output")
    class BetaCodeExecutionResultBlock:
    List<BetaCodeExecutionOutputBlock> content
    String fileId
    JsonValue; type "code_execution_output"constant"code_execution_output"constant
    Accepts one of the following:
    CODE_EXECUTION_OUTPUT("code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "code_execution_result"constant"code_execution_result"constant
    Accepts one of the following:
    CODE_EXECUTION_RESULT("code_execution_result")
    class BetaCodeExecutionResultBlockParam:
    List<BetaCodeExecutionOutputBlockParam> content
    String fileId
    JsonValue; type "code_execution_output"constant"code_execution_output"constant
    Accepts one of the following:
    CODE_EXECUTION_OUTPUT("code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "code_execution_result"constant"code_execution_result"constant
    Accepts one of the following:
    CODE_EXECUTION_RESULT("code_execution_result")
    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.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    class BetaCodeExecutionToolResultBlock:
    BetaCodeExecutionToolResultBlockContent content
    Accepts one of the following:
    class BetaCodeExecutionToolResultError:
    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
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")
    class BetaCodeExecutionResultBlock:
    List<BetaCodeExecutionOutputBlock> content
    String fileId
    JsonValue; type "code_execution_output"constant"code_execution_output"constant
    Accepts one of the following:
    CODE_EXECUTION_OUTPUT("code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "code_execution_result"constant"code_execution_result"constant
    Accepts one of the following:
    CODE_EXECUTION_RESULT("code_execution_result")
    String toolUseId
    JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")
    class BetaCodeExecutionToolResultBlockContent: A class that can be one of several variants.union
    class BetaCodeExecutionToolResultError:
    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
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")
    class BetaCodeExecutionResultBlock:
    List<BetaCodeExecutionOutputBlock> content
    String fileId
    JsonValue; type "code_execution_output"constant"code_execution_output"constant
    Accepts one of the following:
    CODE_EXECUTION_OUTPUT("code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "code_execution_result"constant"code_execution_result"constant
    Accepts one of the following:
    CODE_EXECUTION_RESULT("code_execution_result")
    class BetaCodeExecutionToolResultBlockParam:
    BetaCodeExecutionToolResultBlockParamContent content
    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
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")
    class BetaCodeExecutionResultBlockParam:
    List<BetaCodeExecutionOutputBlockParam> content
    String fileId
    JsonValue; type "code_execution_output"constant"code_execution_output"constant
    Accepts one of the following:
    CODE_EXECUTION_OUTPUT("code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "code_execution_result"constant"code_execution_result"constant
    Accepts one of the following:
    CODE_EXECUTION_RESULT("code_execution_result")
    String toolUseId
    JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaCodeExecutionToolResultBlockParamContent: A class that can be one of several variants.union
    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
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")
    class BetaCodeExecutionResultBlockParam:
    List<BetaCodeExecutionOutputBlockParam> content
    String fileId
    JsonValue; type "code_execution_output"constant"code_execution_output"constant
    Accepts one of the following:
    CODE_EXECUTION_OUTPUT("code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "code_execution_result"constant"code_execution_result"constant
    Accepts one of the following:
    CODE_EXECUTION_RESULT("code_execution_result")
    class BetaCodeExecutionToolResultError:
    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
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")
    enum BetaCodeExecutionToolResultErrorCode:
    INVALID_TOOL_INPUT("invalid_tool_input")
    UNAVAILABLE("unavailable")
    TOO_MANY_REQUESTS("too_many_requests")
    EXECUTION_TIME_EXCEEDED("execution_time_exceeded")
    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
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")
    class BetaContainer:

    Information about the container used in the request (for the code execution tool)

    String id

    Identifier for the container used in this request

    LocalDateTime expiresAt

    The time at which the container will expire.

    formatdate-time
    Optional<List<BetaSkill>> skills

    Skills loaded in the container

    String skillId

    Skill ID

    maxLength64
    minLength1
    Type type

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

    Accepts one of the following:
    ANTHROPIC("anthropic")
    CUSTOM("custom")
    String version

    Skill version or 'latest' for most recent version

    maxLength64
    minLength1
    class BetaContainerParams:

    Container parameters with skills to be loaded.

    Optional<String> id

    Container id

    Optional<List<BetaSkillParams>> skills

    List of skills to load in the container

    String skillId

    Skill ID

    maxLength64
    minLength1
    Type type

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

    Accepts one of the following:
    ANTHROPIC("anthropic")
    CUSTOM("custom")
    Optional<String> version

    Skill version or 'latest' for most recent version

    maxLength64
    minLength1
    class BetaContainerUploadBlock:

    Response model for a file uploaded to the container.

    String fileId
    JsonValue; type "container_upload"constant"container_upload"constant
    Accepts one of the following:
    CONTAINER_UPLOAD("container_upload")
    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
    Accepts one of the following:
    CONTAINER_UPLOAD("container_upload")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaContentBlock: A class that can be one of several variants.union

    Response model for a file uploaded to the container.

    class BetaTextBlock:
    Optional<List<BetaTextCitation>> citations

    Citations supporting the text block.

    The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.

    Accepts one of the following:
    class BetaCitationCharLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    String url
    class BetaCitationSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    String source
    long startBlockIndex
    Optional<String> title
    JsonValue; type "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    String text
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class BetaThinkingBlock:
    String signature
    String thinking
    JsonValue; type "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class BetaRedactedThinkingBlock:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class BetaToolUseBlock:
    String id
    Input input
    String name
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    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
    Accepts one of the following:
    DIRECT("direct")
    class BetaServerToolCaller:

    Tool invocation generated by a server-side tool.

    String toolId
    JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
    Accepts one of the following:
    CODE_EXECUTION_20250825("code_execution_20250825")
    class BetaServerToolUseBlock:
    String id
    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
    Accepts one of the following:
    DIRECT("direct")
    class BetaServerToolCaller:

    Tool invocation generated by a server-side tool.

    String toolId
    JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
    Accepts one of the following:
    CODE_EXECUTION_20250825("code_execution_20250825")
    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
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    class BetaWebSearchToolResultBlock:
    BetaWebSearchToolResultBlockContent content
    Accepts one of the following:
    class BetaWebSearchToolResultError:
    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")
    JsonValue; type "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")
    List<BetaWebSearchResultBlock>
    String encryptedContent
    Optional<String> pageAge
    String title
    JsonValue; type "web_search_result"constant"web_search_result"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT("web_search_result")
    String url
    String toolUseId
    JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
    Accepts one of the following:
    WEB_SEARCH_TOOL_RESULT("web_search_tool_result")
    class BetaWebFetchToolResultBlock:
    Content content
    Accepts one of the following:
    class BetaWebFetchToolResultErrorBlock:
    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
    Accepts one of the following:
    WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")
    class BetaWebFetchBlock:
    BetaDocumentBlock content
    Optional<BetaCitationConfig> citations

    Citation configuration for the document

    boolean enabled
    Source source
    Accepts one of the following:
    class BetaBase64PdfSource:
    String data
    JsonValue; mediaType "application/pdf"constant"application/pdf"constant
    Accepts one of the following:
    APPLICATION_PDF("application/pdf")
    JsonValue; type "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaPlainTextSource:
    String data
    JsonValue; mediaType "text/plain"constant"text/plain"constant
    Accepts one of the following:
    TEXT_PLAIN("text/plain")
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<String> title

    The title of the document

    JsonValue; type "document"constant"document"constant
    Accepts one of the following:
    DOCUMENT("document")
    Optional<String> retrievedAt

    ISO 8601 timestamp when the content was retrieved

    JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
    Accepts one of the following:
    WEB_FETCH_RESULT("web_fetch_result")
    String url

    Fetched content URL

    String toolUseId
    JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
    Accepts one of the following:
    WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")
    class BetaCodeExecutionToolResultBlock:
    BetaCodeExecutionToolResultBlockContent content
    Accepts one of the following:
    class BetaCodeExecutionToolResultError:
    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
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")
    class BetaCodeExecutionResultBlock:
    List<BetaCodeExecutionOutputBlock> content
    String fileId
    JsonValue; type "code_execution_output"constant"code_execution_output"constant
    Accepts one of the following:
    CODE_EXECUTION_OUTPUT("code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "code_execution_result"constant"code_execution_result"constant
    Accepts one of the following:
    CODE_EXECUTION_RESULT("code_execution_result")
    String toolUseId
    JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")
    class BetaBashCodeExecutionToolResultBlock:
    Content content
    Accepts one of the following:
    class BetaBashCodeExecutionToolResultError:
    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
    Accepts one of the following:
    BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")
    class BetaBashCodeExecutionResultBlock:
    List<BetaBashCodeExecutionOutputBlock> content
    String fileId
    JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")
    String toolUseId
    JsonValue; type "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")
    class BetaTextEditorCodeExecutionToolResultBlock:
    Content content
    Accepts one of the following:
    class BetaTextEditorCodeExecutionToolResultError:
    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")
    Optional<String> errorMessage
    JsonValue; type "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")
    class BetaTextEditorCodeExecutionViewResultBlock:
    String content
    FileType fileType
    Accepts one of the following:
    TEXT("text")
    IMAGE("image")
    PDF("pdf")
    Optional<Long> numLines
    Optional<Long> startLine
    Optional<Long> totalLines
    JsonValue; type "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")
    class BetaTextEditorCodeExecutionCreateResultBlock:
    boolean isFileUpdate
    JsonValue; type "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 BetaTextEditorCodeExecutionStrReplaceResultBlock:
    Optional<List<String>> lines
    Optional<Long> newLines
    Optional<Long> newStart
    Optional<Long> oldLines
    Optional<Long> oldStart
    JsonValue; type "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")
    String toolUseId
    JsonValue; type "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")
    class BetaToolSearchToolResultBlock:
    Content content
    Accepts one of the following:
    class BetaToolSearchToolResultError:
    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")
    Optional<String> errorMessage
    JsonValue; type "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 BetaToolSearchToolSearchResultBlock:
    List<BetaToolReferenceBlock> toolReferences
    String toolName
    JsonValue; type "tool_reference"constant"tool_reference"constant
    Accepts one of the following:
    TOOL_REFERENCE("tool_reference")
    JsonValue; type "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")
    String toolUseId
    JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
    Accepts one of the following:
    TOOL_SEARCH_TOOL_RESULT("tool_search_tool_result")
    class BetaMcpToolUseBlock:
    String id
    Input input
    String name

    The name of the MCP tool

    String serverName

    The name of the MCP server

    JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
    Accepts one of the following:
    MCP_TOOL_USE("mcp_tool_use")
    class BetaMcpToolResultBlock:
    Content content
    Accepts one of the following:
    String
    List<BetaTextBlock>
    Optional<List<BetaTextCitation>> citations

    Citations supporting the text block.

    The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.

    Accepts one of the following:
    class BetaCitationCharLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    String url
    class BetaCitationSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    String source
    long startBlockIndex
    Optional<String> title
    JsonValue; type "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    String text
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    boolean isError
    String toolUseId
    JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
    Accepts one of the following:
    MCP_TOOL_RESULT("mcp_tool_result")
    class BetaContainerUploadBlock:

    Response model for a file uploaded to the container.

    String fileId
    JsonValue; type "container_upload"constant"container_upload"constant
    Accepts one of the following:
    CONTAINER_UPLOAD("container_upload")
    class BetaContentBlockParam: A class that can be one of several variants.union

    Regular text content.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    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
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    class BetaFileImageSource:
    String fileId
    JsonValue; type "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    APPLICATION_PDF("application/pdf")
    JsonValue; type "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaPlainTextSource:
    String data
    JsonValue; mediaType "text/plain"constant"text/plain"constant
    Accepts one of the following:
    TEXT_PLAIN("text/plain")
    JsonValue; type "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:
    String text
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    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
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    class BetaFileImageSource:
    String fileId
    JsonValue; type "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    TEXT("text")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    String source
    String title
    JsonValue; type "search_result"constant"search_result"constant
    Accepts one of the following:
    SEARCH_RESULT("search_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    THINKING("thinking")
    class BetaRedactedThinkingBlockParam:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class BetaToolUseBlockParam:
    String id
    Input input
    String name
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    DIRECT("direct")
    class BetaServerToolCaller:

    Tool invocation generated by a server-side tool.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    TEXT("text")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    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
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    class BetaFileImageSource:
    String fileId
    JsonValue; type "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    String source
    String title
    JsonValue; type "search_result"constant"search_result"constant
    Accepts one of the following:
    SEARCH_RESULT("search_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    APPLICATION_PDF("application/pdf")
    JsonValue; type "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaPlainTextSource:
    String data
    JsonValue; mediaType "text/plain"constant"text/plain"constant
    Accepts one of the following:
    TEXT_PLAIN("text/plain")
    JsonValue; type "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:
    String text
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    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
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    class BetaFileImageSource:
    String fileId
    JsonValue; type "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    TOOL_REFERENCE("tool_reference")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    DIRECT("direct")
    class BetaServerToolCaller:

    Tool invocation generated by a server-side tool.

    String toolId
    JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
    Accepts one of the following:
    CODE_EXECUTION_20250825("code_execution_20250825")
    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
    Accepts one of the following:
    WEB_SEARCH_RESULT("web_search_result")
    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")
    JsonValue; type "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")
    String toolUseId
    JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
    Accepts one of the following:
    WEB_SEARCH_TOOL_RESULT("web_search_tool_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    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
    Accepts one of the following:
    WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")
    class BetaWebFetchBlockParam:
    BetaRequestDocumentBlock content
    Source source
    Accepts one of the following:
    class BetaBase64PdfSource:
    String data
    JsonValue; mediaType "application/pdf"constant"application/pdf"constant
    Accepts one of the following:
    APPLICATION_PDF("application/pdf")
    JsonValue; type "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaPlainTextSource:
    String data
    JsonValue; mediaType "text/plain"constant"text/plain"constant
    Accepts one of the following:
    TEXT_PLAIN("text/plain")
    JsonValue; type "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:
    String text
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    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
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    class BetaFileImageSource:
    String fileId
    JsonValue; type "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    WEB_FETCH_RESULT("web_fetch_result")
    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
    Accepts one of the following:
    WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaCodeExecutionToolResultBlockParam:
    BetaCodeExecutionToolResultBlockParamContent content
    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
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")
    class BetaCodeExecutionResultBlockParam:
    List<BetaCodeExecutionOutputBlockParam> content
    String fileId
    JsonValue; type "code_execution_output"constant"code_execution_output"constant
    Accepts one of the following:
    CODE_EXECUTION_OUTPUT("code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "code_execution_result"constant"code_execution_result"constant
    Accepts one of the following:
    CODE_EXECUTION_RESULT("code_execution_result")
    String toolUseId
    JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")
    class BetaBashCodeExecutionResultBlockParam:
    List<BetaBashCodeExecutionOutputBlockParam> content
    String fileId
    JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")
    String toolUseId
    JsonValue; type "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")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")
    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
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")
    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
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")
    class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:
    JsonValue; type "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")
    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
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    TOOL_SEARCH_TOOL_RESULT_ERROR("tool_search_tool_result_error")
    class BetaToolSearchToolSearchResultBlockParam:
    List<BetaToolReferenceBlockParam> toolReferences
    String toolName
    JsonValue; type "tool_reference"constant"tool_reference"constant
    Accepts one of the following:
    TOOL_REFERENCE("tool_reference")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    TOOL_SEARCH_TOOL_SEARCH_RESULT("tool_search_tool_search_result")
    String toolUseId
    JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
    Accepts one of the following:
    TOOL_SEARCH_TOOL_RESULT("tool_search_tool_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    MCP_TOOL_USE("mcp_tool_use")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    MCP_TOOL_RESULT("mcp_tool_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    TEXT("text")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    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
    Accepts one of the following:
    CONTAINER_UPLOAD("container_upload")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    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
    Accepts one of the following:
    TEXT("text")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    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
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    class BetaFileImageSource:
    String fileId
    JsonValue; type "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    JsonValue; type "content"constant"content"constant
    Accepts one of the following:
    CONTENT("content")
    class BetaContentBlockSourceContent: A class that can be one of several variants.union
    class BetaTextBlockParam:
    String text
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    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
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    class BetaFileImageSource:
    String fileId
    JsonValue; type "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaContextManagementConfig:
    Optional<List<Edit>> edits

    List of context management edits to apply

    Accepts one of the following:
    class BetaClearToolUses20250919Edit:
    JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant
    Accepts one of the following:
    CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")
    Optional<BetaInputTokensClearAtLeast> clearAtLeast

    Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.

    JsonValue; type "input_tokens"constant"input_tokens"constant
    Accepts one of the following:
    INPUT_TOKENS("input_tokens")
    long value
    Optional<ClearToolInputs> clearToolInputs

    Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)

    Accepts one of the following:
    boolean
    List<String>
    Optional<List<String>> excludeTools

    Tool names whose uses are preserved from clearing

    Optional<BetaToolUsesKeep> keep

    Number of tool uses to retain in the conversation

    JsonValue; type "tool_uses"constant"tool_uses"constant
    Accepts one of the following:
    TOOL_USES("tool_uses")
    long value
    Optional<Trigger> trigger

    Condition that triggers the context management strategy

    Accepts one of the following:
    class BetaInputTokensTrigger:
    JsonValue; type "input_tokens"constant"input_tokens"constant
    Accepts one of the following:
    INPUT_TOKENS("input_tokens")
    long value
    class BetaToolUsesTrigger:
    JsonValue; type "tool_uses"constant"tool_uses"constant
    Accepts one of the following:
    TOOL_USES("tool_uses")
    long value
    class BetaClearThinking20251015Edit:
    JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant
    Accepts one of the following:
    CLEAR_THINKING_20251015("clear_thinking_20251015")
    Optional<Keep> keep

    Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.

    Accepts one of the following:
    class BetaThinkingTurns:
    JsonValue; type "thinking_turns"constant"thinking_turns"constant
    Accepts one of the following:
    THINKING_TURNS("thinking_turns")
    long value
    class BetaAllThinkingTurns:
    JsonValue; type "all"constant"all"constant
    Accepts one of the following:
    ALL("all")
    JsonValue;
    Accepts one of the following:
    ALL("all")
    class BetaContextManagementResponse:
    List<AppliedEdit> appliedEdits

    List of context management edits that were applied.

    Accepts one of the following:
    class BetaClearToolUses20250919EditResponse:
    long clearedInputTokens

    Number of input tokens cleared by this edit.

    minimum0
    long clearedToolUses

    Number of tool uses that were cleared.

    minimum0
    JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant

    The type of context management edit applied.

    Accepts one of the following:
    CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")
    class BetaClearThinking20251015EditResponse:
    long clearedInputTokens

    Number of input tokens cleared by this edit.

    minimum0
    long clearedThinkingTurns

    Number of thinking turns that were cleared.

    minimum0
    JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant

    The type of context management edit applied.

    Accepts one of the following:
    CLEAR_THINKING_20251015("clear_thinking_20251015")
    class BetaCountTokensContextManagementResponse:
    long originalInputTokens

    The original token count before context management was applied

    class BetaDirectCaller:

    Tool invocation directly from the model.

    JsonValue; type "direct"constant"direct"constant
    Accepts one of the following:
    DIRECT("direct")
    class BetaDocumentBlock:
    Optional<BetaCitationConfig> citations

    Citation configuration for the document

    boolean enabled
    Source source
    Accepts one of the following:
    class BetaBase64PdfSource:
    String data
    JsonValue; mediaType "application/pdf"constant"application/pdf"constant
    Accepts one of the following:
    APPLICATION_PDF("application/pdf")
    JsonValue; type "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaPlainTextSource:
    String data
    JsonValue; mediaType "text/plain"constant"text/plain"constant
    Accepts one of the following:
    TEXT_PLAIN("text/plain")
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<String> title

    The title of the document

    JsonValue; type "document"constant"document"constant
    Accepts one of the following:
    DOCUMENT("document")
    class BetaFileDocumentSource:
    String fileId
    JsonValue; type "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    class BetaFileImageSource:
    String fileId
    JsonValue; type "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    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
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    class BetaFileImageSource:
    String fileId
    JsonValue; type "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaInputJsonDelta:
    String partialJson
    JsonValue; type "input_json_delta"constant"input_json_delta"constant
    Accepts one of the following:
    INPUT_JSON_DELTA("input_json_delta")
    class BetaInputTokensClearAtLeast:
    JsonValue; type "input_tokens"constant"input_tokens"constant
    Accepts one of the following:
    INPUT_TOKENS("input_tokens")
    long value
    class BetaInputTokensTrigger:
    JsonValue; type "input_tokens"constant"input_tokens"constant
    Accepts one of the following:
    INPUT_TOKENS("input_tokens")
    long value
    class BetaJsonOutputFormat:
    Schema schema

    The JSON schema of the format

    JsonValue; type "json_schema"constant"json_schema"constant
    Accepts one of the following:
    JSON_SCHEMA("json_schema")
    class BetaMcpToolConfig:

    Configuration for a specific tool in an MCP toolset.

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

    Default configuration for tools in an MCP toolset.

    Optional<Boolean> deferLoading
    Optional<Boolean> enabled
    class BetaMcpToolResultBlock:
    Content content
    Accepts one of the following:
    String
    List<BetaTextBlock>
    Optional<List<BetaTextCitation>> citations

    Citations supporting the text block.

    The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.

    Accepts one of the following:
    class BetaCitationCharLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    String url
    class BetaCitationSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    String source
    long startBlockIndex
    Optional<String> title
    JsonValue; type "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    String text
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    boolean isError
    String toolUseId
    JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
    Accepts one of the following:
    MCP_TOOL_RESULT("mcp_tool_result")
    class BetaMcpToolUseBlock:
    String id
    Input input
    String name

    The name of the MCP tool

    String serverName

    The name of the MCP server

    JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
    Accepts one of the following:
    MCP_TOOL_USE("mcp_tool_use")
    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
    Accepts one of the following:
    MCP_TOOL_USE("mcp_tool_use")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    class BetaMemoryTool20250818Command: A class that can be one of several variants.union
    class BetaMemoryTool20250818ViewCommand:
    JsonValue; command "view"constant"view"constant

    Command type identifier

    Accepts one of the following:
    VIEW("view")
    String path

    Path to directory or file to view

    Optional<List<Long>> viewRange

    Optional line range for viewing specific lines

    class BetaMemoryTool20250818CreateCommand:
    JsonValue; command "create"constant"create"constant

    Command type identifier

    Accepts one of the following:
    CREATE("create")
    String fileText

    Content to write to the file

    String path

    Path where the file should be created

    class BetaMemoryTool20250818StrReplaceCommand:
    JsonValue; command "str_replace"constant"str_replace"constant

    Command type identifier

    Accepts one of the following:
    STR_REPLACE("str_replace")
    String newStr

    Text to replace with

    String oldStr

    Text to search for and replace

    String path

    Path to the file where text should be replaced

    class BetaMemoryTool20250818InsertCommand:
    JsonValue; command "insert"constant"insert"constant

    Command type identifier

    Accepts one of the following:
    INSERT("insert")
    long insertLine

    Line number where text should be inserted

    minimum1
    String insertText

    Text to insert at the specified line

    String path

    Path to the file where text should be inserted

    class BetaMemoryTool20250818DeleteCommand:
    JsonValue; command "delete"constant"delete"constant

    Command type identifier

    Accepts one of the following:
    DELETE("delete")
    String path

    Path to the file or directory to delete

    class BetaMemoryTool20250818RenameCommand:
    JsonValue; command "rename"constant"rename"constant

    Command type identifier

    Accepts one of the following:
    RENAME("rename")
    String newPath

    New path for the file or directory

    String oldPath

    Current path of the file or directory

    class BetaMemoryTool20250818CreateCommand:
    JsonValue; command "create"constant"create"constant

    Command type identifier

    Accepts one of the following:
    CREATE("create")
    String fileText

    Content to write to the file

    String path

    Path where the file should be created

    class BetaMemoryTool20250818DeleteCommand:
    JsonValue; command "delete"constant"delete"constant

    Command type identifier

    Accepts one of the following:
    DELETE("delete")
    String path

    Path to the file or directory to delete

    class BetaMemoryTool20250818InsertCommand:
    JsonValue; command "insert"constant"insert"constant

    Command type identifier

    Accepts one of the following:
    INSERT("insert")
    long insertLine

    Line number where text should be inserted

    minimum1
    String insertText

    Text to insert at the specified line

    String path

    Path to the file where text should be inserted

    class BetaMemoryTool20250818RenameCommand:
    JsonValue; command "rename"constant"rename"constant

    Command type identifier

    Accepts one of the following:
    RENAME("rename")
    String newPath

    New path for the file or directory

    String oldPath

    Current path of the file or directory

    class BetaMemoryTool20250818StrReplaceCommand:
    JsonValue; command "str_replace"constant"str_replace"constant

    Command type identifier

    Accepts one of the following:
    STR_REPLACE("str_replace")
    String newStr

    Text to replace with

    String oldStr

    Text to search for and replace

    String path

    Path to the file where text should be replaced

    class BetaMemoryTool20250818ViewCommand:
    JsonValue; command "view"constant"view"constant

    Command type identifier

    Accepts one of the following:
    VIEW("view")
    String path

    Path to directory or file to view

    Optional<List<Long>> viewRange

    Optional line range for viewing specific lines

    class BetaMessage:
    String id

    Unique object identifier.

    The format and length of IDs may change over time.

    Optional<BetaContainer> container

    Information about the container used in the request (for the code execution tool)

    String id

    Identifier for the container used in this request

    LocalDateTime expiresAt

    The time at which the container will expire.

    formatdate-time
    Optional<List<BetaSkill>> skills

    Skills loaded in the container

    String skillId

    Skill ID

    maxLength64
    minLength1
    Type type

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

    Accepts one of the following:
    ANTHROPIC("anthropic")
    CUSTOM("custom")
    String version

    Skill version or 'latest' for most recent version

    maxLength64
    minLength1
    List<BetaContentBlock> content

    Content generated by the model.

    This is an array of content blocks, each of which has a type that determines its shape.

    Example:

    [{"type": "text", "text": "Hi, I'm Claude."}]
    

    If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.

    For example, if the input messages were:

    [
      {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
      {"role": "assistant", "content": "The best answer is ("}
    ]
    

    Then the response content might be:

    [{"type": "text", "text": "B)"}]
    
    Accepts one of the following:
    class BetaTextBlock:
    Optional<List<BetaTextCitation>> citations

    Citations supporting the text block.

    The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.

    Accepts one of the following:
    class BetaCitationCharLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    String url
    class BetaCitationSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    String source
    long startBlockIndex
    Optional<String> title
    JsonValue; type "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    String text
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class BetaThinkingBlock:
    String signature
    String thinking
    JsonValue; type "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class BetaRedactedThinkingBlock:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class BetaToolUseBlock:
    String id
    Input input
    String name
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    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
    Accepts one of the following:
    DIRECT("direct")
    class BetaServerToolCaller:

    Tool invocation generated by a server-side tool.

    String toolId
    JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
    Accepts one of the following:
    CODE_EXECUTION_20250825("code_execution_20250825")
    class BetaServerToolUseBlock:
    String id
    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
    Accepts one of the following:
    DIRECT("direct")
    class BetaServerToolCaller:

    Tool invocation generated by a server-side tool.

    String toolId
    JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
    Accepts one of the following:
    CODE_EXECUTION_20250825("code_execution_20250825")
    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
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    class BetaWebSearchToolResultBlock:
    BetaWebSearchToolResultBlockContent content
    Accepts one of the following:
    class BetaWebSearchToolResultError:
    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")
    JsonValue; type "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")
    List<BetaWebSearchResultBlock>
    String encryptedContent
    Optional<String> pageAge
    String title
    JsonValue; type "web_search_result"constant"web_search_result"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT("web_search_result")
    String url
    String toolUseId
    JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
    Accepts one of the following:
    WEB_SEARCH_TOOL_RESULT("web_search_tool_result")
    class BetaWebFetchToolResultBlock:
    Content content
    Accepts one of the following:
    class BetaWebFetchToolResultErrorBlock:
    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
    Accepts one of the following:
    WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")
    class BetaWebFetchBlock:
    BetaDocumentBlock content
    Optional<BetaCitationConfig> citations

    Citation configuration for the document

    boolean enabled
    Source source
    Accepts one of the following:
    class BetaBase64PdfSource:
    String data
    JsonValue; mediaType "application/pdf"constant"application/pdf"constant
    Accepts one of the following:
    APPLICATION_PDF("application/pdf")
    JsonValue; type "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaPlainTextSource:
    String data
    JsonValue; mediaType "text/plain"constant"text/plain"constant
    Accepts one of the following:
    TEXT_PLAIN("text/plain")
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<String> title

    The title of the document

    JsonValue; type "document"constant"document"constant
    Accepts one of the following:
    DOCUMENT("document")
    Optional<String> retrievedAt

    ISO 8601 timestamp when the content was retrieved

    JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
    Accepts one of the following:
    WEB_FETCH_RESULT("web_fetch_result")
    String url

    Fetched content URL

    String toolUseId
    JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
    Accepts one of the following:
    WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")
    class BetaCodeExecutionToolResultBlock:
    BetaCodeExecutionToolResultBlockContent content
    Accepts one of the following:
    class BetaCodeExecutionToolResultError:
    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
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")
    class BetaCodeExecutionResultBlock:
    List<BetaCodeExecutionOutputBlock> content
    String fileId
    JsonValue; type "code_execution_output"constant"code_execution_output"constant
    Accepts one of the following:
    CODE_EXECUTION_OUTPUT("code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "code_execution_result"constant"code_execution_result"constant
    Accepts one of the following:
    CODE_EXECUTION_RESULT("code_execution_result")
    String toolUseId
    JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")
    class BetaBashCodeExecutionToolResultBlock:
    Content content
    Accepts one of the following:
    class BetaBashCodeExecutionToolResultError:
    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
    Accepts one of the following:
    BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")
    class BetaBashCodeExecutionResultBlock:
    List<BetaBashCodeExecutionOutputBlock> content
    String fileId
    JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")
    String toolUseId
    JsonValue; type "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")
    class BetaTextEditorCodeExecutionToolResultBlock:
    Content content
    Accepts one of the following:
    class BetaTextEditorCodeExecutionToolResultError:
    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")
    Optional<String> errorMessage
    JsonValue; type "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")
    class BetaTextEditorCodeExecutionViewResultBlock:
    String content
    FileType fileType
    Accepts one of the following:
    TEXT("text")
    IMAGE("image")
    PDF("pdf")
    Optional<Long> numLines
    Optional<Long> startLine
    Optional<Long> totalLines
    JsonValue; type "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")
    class BetaTextEditorCodeExecutionCreateResultBlock:
    boolean isFileUpdate
    JsonValue; type "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 BetaTextEditorCodeExecutionStrReplaceResultBlock:
    Optional<List<String>> lines
    Optional<Long> newLines
    Optional<Long> newStart
    Optional<Long> oldLines
    Optional<Long> oldStart
    JsonValue; type "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")
    String toolUseId
    JsonValue; type "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")
    class BetaToolSearchToolResultBlock:
    Content content
    Accepts one of the following:
    class BetaToolSearchToolResultError:
    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")
    Optional<String> errorMessage
    JsonValue; type "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 BetaToolSearchToolSearchResultBlock:
    List<BetaToolReferenceBlock> toolReferences
    String toolName
    JsonValue; type "tool_reference"constant"tool_reference"constant
    Accepts one of the following:
    TOOL_REFERENCE("tool_reference")
    JsonValue; type "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")
    String toolUseId
    JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
    Accepts one of the following:
    TOOL_SEARCH_TOOL_RESULT("tool_search_tool_result")
    class BetaMcpToolUseBlock:
    String id
    Input input
    String name

    The name of the MCP tool

    String serverName

    The name of the MCP server

    JsonValue; type "mcp_tool_use"constant"mcp_tool_use"constant
    Accepts one of the following:
    MCP_TOOL_USE("mcp_tool_use")
    class BetaMcpToolResultBlock:
    Content content
    Accepts one of the following:
    String
    List<BetaTextBlock>
    Optional<List<BetaTextCitation>> citations

    Citations supporting the text block.

    The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.

    Accepts one of the following:
    class BetaCitationCharLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    String url
    class BetaCitationSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    String source
    long startBlockIndex
    Optional<String> title
    JsonValue; type "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    String text
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    boolean isError
    String toolUseId
    JsonValue; type "mcp_tool_result"constant"mcp_tool_result"constant
    Accepts one of the following:
    MCP_TOOL_RESULT("mcp_tool_result")
    class BetaContainerUploadBlock:

    Response model for a file uploaded to the container.

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

    Context management response.

    Information about context management strategies applied during the request.

    List<AppliedEdit> appliedEdits

    List of context management edits that were applied.

    Accepts one of the following:
    class BetaClearToolUses20250919EditResponse:
    long clearedInputTokens

    Number of input tokens cleared by this edit.

    minimum0
    long clearedToolUses

    Number of tool uses that were cleared.

    minimum0
    JsonValue; type "clear_tool_uses_20250919"constant"clear_tool_uses_20250919"constant

    The type of context management edit applied.

    Accepts one of the following:
    CLEAR_TOOL_USES_20250919("clear_tool_uses_20250919")
    class BetaClearThinking20251015EditResponse:
    long clearedInputTokens

    Number of input tokens cleared by this edit.

    minimum0
    long clearedThinkingTurns

    Number of thinking turns that were cleared.

    minimum0
    JsonValue; type "clear_thinking_20251015"constant"clear_thinking_20251015"constant

    The type of context management edit applied.

    Accepts one of the following:
    CLEAR_THINKING_20251015("clear_thinking_20251015")
    Model model

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    CLAUDE_OPUS_4_5_20251101("claude-opus-4-5-20251101")

    Premium model combining maximum intelligence with practical performance

    CLAUDE_OPUS_4_5("claude-opus-4-5")

    Premium model combining maximum intelligence with practical performance

    CLAUDE_3_7_SONNET_LATEST("claude-3-7-sonnet-latest")

    High-performance model with early extended thinking

    CLAUDE_3_7_SONNET_20250219("claude-3-7-sonnet-20250219")

    High-performance model with early extended thinking

    CLAUDE_3_5_HAIKU_LATEST("claude-3-5-haiku-latest")

    Fastest and most compact model for near-instant responsiveness

    CLAUDE_3_5_HAIKU_20241022("claude-3-5-haiku-20241022")

    Our fastest model

    CLAUDE_HAIKU_4_5("claude-haiku-4-5")

    Hybrid model, capable of near-instant responses and extended thinking

    CLAUDE_HAIKU_4_5_20251001("claude-haiku-4-5-20251001")

    Hybrid model, capable of near-instant responses and extended thinking

    CLAUDE_SONNET_4_20250514("claude-sonnet-4-20250514")

    High-performance model with extended thinking

    CLAUDE_SONNET_4_0("claude-sonnet-4-0")

    High-performance model with extended thinking

    CLAUDE_4_SONNET_20250514("claude-4-sonnet-20250514")

    High-performance model with extended thinking

    CLAUDE_SONNET_4_5("claude-sonnet-4-5")

    Our best model for real-world agents and coding

    CLAUDE_SONNET_4_5_20250929("claude-sonnet-4-5-20250929")

    Our best model for real-world agents and coding

    CLAUDE_OPUS_4_0("claude-opus-4-0")

    Our most capable model

    CLAUDE_OPUS_4_20250514("claude-opus-4-20250514")

    Our most capable model

    CLAUDE_4_OPUS_20250514("claude-4-opus-20250514")

    Our most capable model

    CLAUDE_OPUS_4_1_20250805("claude-opus-4-1-20250805")

    Our most capable model

    CLAUDE_3_OPUS_LATEST("claude-3-opus-latest")

    Excels at writing and complex tasks

    CLAUDE_3_OPUS_20240229("claude-3-opus-20240229")

    Excels at writing and complex tasks

    CLAUDE_3_HAIKU_20240307("claude-3-haiku-20240307")

    Our previous most fast and cost-effective

    JsonValue; role "assistant"constant"assistant"constant

    Conversational role of the generated message.

    This will always be "assistant".

    Accepts one of the following:
    ASSISTANT("assistant")
    Optional<BetaStopReason> stopReason

    The reason that we stopped.

    This may be one the following values:

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

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

    Accepts one of the following:
    END_TURN("end_turn")
    MAX_TOKENS("max_tokens")
    STOP_SEQUENCE("stop_sequence")
    TOOL_USE("tool_use")
    PAUSE_TURN("pause_turn")
    REFUSAL("refusal")
    MODEL_CONTEXT_WINDOW_EXCEEDED("model_context_window_exceeded")
    Optional<String> stopSequence

    Which custom stop sequence was generated, if any.

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

    JsonValue; type "message"constant"message"constant

    Object type.

    For Messages, this is always "message".

    Accepts one of the following:
    MESSAGE("message")
    BetaUsage usage

    Billing and rate-limit usage.

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

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

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

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

    Optional<BetaCacheCreation> cacheCreation

    Breakdown of cached tokens by TTL

    long ephemeral1hInputTokens

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

    minimum0
    long ephemeral5mInputTokens

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

    minimum0
    Optional<Long> cacheCreationInputTokens

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

    minimum0
    Optional<Long> cacheReadInputTokens

    The number of input tokens read from the cache.

    minimum0
    long inputTokens

    The number of input tokens which were used.

    minimum0
    long outputTokens

    The number of output tokens which were used.

    minimum0
    Optional<BetaServerToolUsage> serverToolUse

    The number of server tool requests.

    long webFetchRequests

    The number of web fetch tool requests.

    minimum0
    long webSearchRequests

    The number of web search tool requests.

    minimum0
    Optional<ServiceTier> serviceTier

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

    Accepts one of the following:
    STANDARD("standard")
    PRIORITY("priority")
    BATCH("batch")
    class BetaMessageDeltaUsage:
    Optional<Long> cacheCreationInputTokens

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

    minimum0
    Optional<Long> cacheReadInputTokens

    The cumulative number of input tokens read from the cache.

    minimum0
    Optional<Long> inputTokens

    The cumulative number of input tokens which were used.

    minimum0
    long outputTokens

    The cumulative number of output tokens which were used.

    Optional<BetaServerToolUsage> serverToolUse

    The number of server tool requests.

    long webFetchRequests

    The number of web fetch tool requests.

    minimum0
    long webSearchRequests

    The number of web search tool requests.

    minimum0
    class BetaMessageParam:
    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
    Accepts one of the following:
    TEXT("text")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    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
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    class BetaFileImageSource:
    String fileId
    JsonValue; type "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    APPLICATION_PDF("application/pdf")
    JsonValue; type "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaPlainTextSource:
    String data
    JsonValue; mediaType "text/plain"constant"text/plain"constant
    Accepts one of the following:
    TEXT_PLAIN("text/plain")
    JsonValue; type "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:
    String text
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    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
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    class BetaFileImageSource:
    String fileId
    JsonValue; type "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    TEXT("text")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    String source
    String title
    JsonValue; type "search_result"constant"search_result"constant
    Accepts one of the following:
    SEARCH_RESULT("search_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    THINKING("thinking")
    class BetaRedactedThinkingBlockParam:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class BetaToolUseBlockParam:
    String id
    Input input
    String name
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    DIRECT("direct")
    class BetaServerToolCaller:

    Tool invocation generated by a server-side tool.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    TEXT("text")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    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
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    class BetaFileImageSource:
    String fileId
    JsonValue; type "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    String source
    String title
    JsonValue; type "search_result"constant"search_result"constant
    Accepts one of the following:
    SEARCH_RESULT("search_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    APPLICATION_PDF("application/pdf")
    JsonValue; type "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaPlainTextSource:
    String data
    JsonValue; mediaType "text/plain"constant"text/plain"constant
    Accepts one of the following:
    TEXT_PLAIN("text/plain")
    JsonValue; type "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:
    String text
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    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
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    class BetaFileImageSource:
    String fileId
    JsonValue; type "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    TOOL_REFERENCE("tool_reference")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    DIRECT("direct")
    class BetaServerToolCaller:

    Tool invocation generated by a server-side tool.

    String toolId
    JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
    Accepts one of the following:
    CODE_EXECUTION_20250825("code_execution_20250825")
    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
    Accepts one of the following:
    WEB_SEARCH_RESULT("web_search_result")
    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")
    JsonValue; type "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")
    String toolUseId
    JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
    Accepts one of the following:
    WEB_SEARCH_TOOL_RESULT("web_search_tool_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    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
    Accepts one of the following:
    WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")
    class BetaWebFetchBlockParam:
    BetaRequestDocumentBlock content
    Source source
    Accepts one of the following:
    class BetaBase64PdfSource:
    String data
    JsonValue; mediaType "application/pdf"constant"application/pdf"constant
    Accepts one of the following:
    APPLICATION_PDF("application/pdf")
    JsonValue; type "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaPlainTextSource:
    String data
    JsonValue; mediaType "text/plain"constant"text/plain"constant
    Accepts one of the following:
    TEXT_PLAIN("text/plain")
    JsonValue; type "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:
    String text
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    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
    Accepts one of the following:
    BASE64("base64")
    class BetaUrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    class BetaFileImageSource:
    String fileId
    JsonValue; type "file"constant"file"constant
    Accepts one of the following:
    FILE("file")
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    WEB_FETCH_RESULT("web_fetch_result")
    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
    Accepts one of the following:
    WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaCodeExecutionToolResultBlockParam:
    BetaCodeExecutionToolResultBlockParamContent content
    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
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")
    class BetaCodeExecutionResultBlockParam:
    List<BetaCodeExecutionOutputBlockParam> content
    String fileId
    JsonValue; type "code_execution_output"constant"code_execution_output"constant
    Accepts one of the following:
    CODE_EXECUTION_OUTPUT("code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "code_execution_result"constant"code_execution_result"constant
    Accepts one of the following:
    CODE_EXECUTION_RESULT("code_execution_result")
    String toolUseId
    JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")
    class BetaBashCodeExecutionResultBlockParam:
    List<BetaBashCodeExecutionOutputBlockParam> content
    String fileId
    JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")
    String toolUseId
    JsonValue; type "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")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")
    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
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")
    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
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")
    class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:
    JsonValue; type "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")
    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
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    TOOL_SEARCH_TOOL_RESULT_ERROR("tool_search_tool_result_error")
    class BetaToolSearchToolSearchResultBlockParam:
    List<BetaToolReferenceBlockParam> toolReferences
    String toolName
    JsonValue; type "tool_reference"constant"tool_reference"constant
    Accepts one of the following:
    TOOL_REFERENCE("tool_reference")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    TOOL_SEARCH_TOOL_SEARCH_RESULT("tool_search_tool_search_result")
    String toolUseId
    JsonValue; type "tool_search_tool_result"constant"tool_search_tool_result"constant
    Accepts one of the following:
    TOOL_SEARCH_TOOL_RESULT("tool_search_tool_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    MCP_TOOL_USE("mcp_tool_use")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    MCP_TOOL_RESULT("mcp_tool_result")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    TEXT("text")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    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
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocationParam:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    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
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    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
    Accepts one of the following:
    CONTAINER_UPLOAD("container_upload")
    Optional<BetaCacheControlEphemeral> cacheControl

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    Role role
    Accepts one of the following:
    USER("user")
    ASSISTANT("assistant")
    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.

    class BetaMetadata:
    Optional<String> userId

    An external identifier for the user who is associated with the request.

    This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number.

    maxLength256
    class BetaOutputConfig:
    Optional<Effort> effort

    All possible effort levels.

    Accepts one of the following:
    LOW("low")
    MEDIUM("medium")
    HIGH("high")
    class BetaPlainTextSource:
    String data
    JsonValue; mediaType "text/plain"constant"text/plain"constant
    Accepts one of the following:
    TEXT_PLAIN("text/plain")
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class BetaRawContentBlockDelta: A class that can be one of several variants.union
    class BetaTextDelta:
    String text
    JsonValue; type "text_delta"constant"text_delta"constant
    Accepts one of the following:
    TEXT_DELTA("text_delta")
    class BetaInputJsonDelta:
    String partialJson
    JsonValue; type "input_json_delta"constant"input_json_delta"constant
    Accepts one of the following:
    INPUT_JSON_DELTA("input_json_delta")
    class BetaCitationsDelta:
    Citation citation
    Accepts one of the following:
    class BetaCitationCharLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    String url
    class BetaCitationSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    String source
    long startBlockIndex
    Optional<String> title
    JsonValue; type "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    JsonValue; type "citations_delta"constant"citations_delta"constant
    Accepts one of the following:
    CITATIONS_DELTA("citations_delta")
    class BetaThinkingDelta:
    String thinking
    JsonValue; type "thinking_delta"constant"thinking_delta"constant
    Accepts one of the following:
    THINKING_DELTA("thinking_delta")
    class BetaSignatureDelta:
    String signature
    JsonValue; type "signature_delta"constant"signature_delta"constant
    Accepts one of the following:
    SIGNATURE_DELTA("signature_delta")
    class BetaRawContentBlockDeltaEvent:
    BetaRawContentBlockDelta delta
    Accepts one of the following:
    class BetaTextDelta:
    String text
    JsonValue; type "text_delta"constant"text_delta"constant
    Accepts one of the following:
    TEXT_DELTA("text_delta")
    class BetaInputJsonDelta:
    String partialJson
    JsonValue; type "input_json_delta"constant"input_json_delta"constant
    Accepts one of the following:
    INPUT_JSON_DELTA("input_json_delta")
    class BetaCitationsDelta:
    Citation citation
    Accepts one of the following:
    class BetaCitationCharLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    String url
    class BetaCitationSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    String source
    long startBlockIndex
    Optional<String> title
    JsonValue; type "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    JsonValue; type "citations_delta"constant"citations_delta"constant
    Accepts one of the following:
    CITATIONS_DELTA("citations_delta")
    class BetaThinkingDelta:
    String thinking
    JsonValue; type "thinking_delta"constant"thinking_delta"constant
    Accepts one of the following:
    THINKING_DELTA("thinking_delta")
    class BetaSignatureDelta:
    String signature
    JsonValue; type "signature_delta"constant"signature_delta"constant
    Accepts one of the following:
    SIGNATURE_DELTA("signature_delta")
    long index
    JsonValue; type "content_block_delta"constant"content_block_delta"constant
    Accepts one of the following:
    CONTENT_BLOCK_DELTA("content_block_delta")
    class BetaRawContentBlockStartEvent:
    ContentBlock contentBlock

    Response model for a file uploaded to the container.

    Accepts one of the following:
    class BetaTextBlock:
    Optional<List<BetaTextCitation>> citations

    Citations supporting the text block.

    The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.

    Accepts one of the following:
    class BetaCitationCharLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocation:
    String citedText
    long documentIndex
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    JsonValue; type "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    String url
    class BetaCitationSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    String source
    long startBlockIndex
    Optional<String> title
    JsonValue; type "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    String text
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class BetaThinkingBlock:
    String signature
    String thinking
    JsonValue; type "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class BetaRedactedThinkingBlock:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class BetaToolUseBlock:
    String id
    Input input
    String name
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    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
    Accepts one of the following:
    DIRECT("direct")
    class BetaServerToolCaller:

    Tool invocation generated by a server-side tool.

    String toolId
    JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
    Accepts one of the following:
    CODE_EXECUTION_20250825("code_execution_20250825")
    class BetaServerToolUseBlock:
    String id
    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
    Accepts one of the following:
    DIRECT("direct")
    class BetaServerToolCaller:

    Tool invocation generated by a server-side tool.

    String toolId
    JsonValue; type "code_execution_20250825"constant"code_execution_20250825"constant
    Accepts one of the following:
    CODE_EXECUTION_20250825("code_execution_20250825")
    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
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    class BetaWebSearchToolResultBlock:
    BetaWebSearchToolResultBlockContent content
    Accepts one of the following:
    class BetaWebSearchToolResultError:
    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")
    JsonValue; type "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")
    List<BetaWebSearchResultBlock>
    String encryptedContent
    Optional<String> pageAge
    String title
    JsonValue; type "web_search_result"constant"web_search_result"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT("web_search_result")
    String url
    String toolUseId
    JsonValue; type "web_search_tool_result"constant"web_search_tool_result"constant
    Accepts one of the following:
    WEB_SEARCH_TOOL_RESULT("web_search_tool_result")
    class BetaWebFetchToolResultBlock:
    Content content
    Accepts one of the following:
    class BetaWebFetchToolResultErrorBlock:
    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
    Accepts one of the following:
    WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")
    class BetaWebFetchBlock:
    BetaDocumentBlock content
    Optional<BetaCitationConfig> citations

    Citation configuration for the document

    boolean enabled
    Source source
    Accepts one of the following:
    class BetaBase64PdfSource:
    String data
    JsonValue; mediaType "application/pdf"constant"application/pdf"constant
    Accepts one of the following:
    APPLICATION_PDF("application/pdf")
    JsonValue; type "base64"constant"base64"constant
    Accepts one of the following:
    BASE64("base64")
    class BetaPlainTextSource:
    String data
    JsonValue; mediaType "text/plain"constant"text/plain"constant
    Accepts one of the following:
    TEXT_PLAIN("text/plain")
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<String> title

    The title of the document

    JsonValue; type "document"constant"document"constant
    Accepts one of the following:
    DOCUMENT("document")
    Optional<String> retrievedAt

    ISO 8601 timestamp when the content was retrieved

    JsonValue; type "web_fetch_result"constant"web_fetch_result"constant
    Accepts one of the following:
    WEB_FETCH_RESULT("web_fetch_result")
    String url

    Fetched content URL

    String toolUseId
    JsonValue; type "web_fetch_tool_result"constant"web_fetch_tool_result"constant
    Accepts one of the following:
    WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")
    class BetaCodeExecutionToolResultBlock:
    BetaCodeExecutionToolResultBlockContent content
    Accepts one of the following:
    class BetaCodeExecutionToolResultError:
    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
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")
    class BetaCodeExecutionResultBlock:
    List<BetaCodeExecutionOutputBlock> content
    String fileId
    JsonValue; type "code_execution_output"constant"code_execution_output"constant
    Accepts one of the following:
    CODE_EXECUTION_OUTPUT("code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "code_execution_result"constant"code_execution_result"constant
    Accepts one of the following:
    CODE_EXECUTION_RESULT("code_execution_result")
    String toolUseId
    JsonValue; type "code_execution_tool_result"constant"code_execution_tool_result"constant
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")
    class BetaBashCodeExecutionToolResultBlock:
    Content content
    Accepts one of the following:
    class BetaBashCodeExecutionToolResultError:
    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
    Accepts one of the following:
    BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")
    class BetaBashCodeExecutionResultBlock:
    List<BetaBashCodeExecutionOutputBlock> content
    String fileId
    JsonValue; type "bash_code_execution_output"constant"bash_code_execution_output"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")
    long returnCode
    String stderr
    String stdout
    JsonValue; type "bash_code_execution_result"constant"bash_code_execution_result"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")
    String toolUseId
    JsonValue; type "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")
    class BetaTextEditorCodeExecutionToolResultBlock:
    Content content
    Accepts one of the following:
    class BetaTextEditorCodeExecutionToolResultError:
    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")
    Optional<String> errorMessage
    JsonValue; type "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")
    class BetaTextEditorCodeExecutionViewResultBlock:
    String content
    FileType fileType
    Accepts one of the following:
    TEXT("text")
    IMAGE("image")
    PDF("pdf")
    Optional<Long> numLines
    Optional<Long> startLine
    Optional<Long> totalLines
    JsonValue; type "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")
    class BetaTextEditorCodeExecutionCreateResultBlock:
    boolean isFileUpdate
    JsonValue; type "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"