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
    Batches
    Create a Message Batch
    Retrieve a Message Batch
    List Message Batches
    Cancel a Message Batch
    Delete a Message Batch
    Retrieve Message Batch results
    Models
    List Models
    Get a Model
    Beta
    Models
    List Models
    Get a Model
    Messages
    Create a Message
    Count tokens in a Message
    Batches
    Create a Message Batch
    Retrieve a Message Batch
    List Message Batches
    Cancel a Message Batch
    Delete a Message Batch
    Retrieve Message Batch results
    Files
    Upload File
    List Files
    Download File
    Get File Metadata
    Delete File
    Skills
    Create Skill
    List Skills
    Get Skill
    Delete Skill
    Versions
    Create Skill Version
    List Skill Versions
    Get Skill Version
    Delete Skill Version
    Admin
    Organizations
    Get Current Organization
    Invites
    Create Invite
    Get Invite
    List Invites
    Delete Invite
    Users
    Get User
    List Users
    Update User
    Remove User
    Workspaces
    Create Workspace
    Get Workspace
    List Workspaces
    Update Workspace
    Archive Workspace
    Members
    Create Workspace Member
    Get Workspace Member
    List Workspace Members
    Update Workspace Member
    Delete Workspace Member
    API Keys
    Get Api Key
    List Api Keys
    Update Api Key
    Usage Report
    Get Messages Usage Report
    Get Claude Code Usage Report
    Cost Report
    Get Cost Report
    Completions
    Create a Text Completion

    Support & configuration

    Rate limitsService tiersVersionsIP addressesSupported regionsOpenAI SDK compatibility
    Console

    Messages

    Count tokens in a Message
    MessageTokensCount messages().countTokens(MessageCountTokensParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
    post/v1/messages/count_tokens
    Create a Message
    Message messages().create(MessageCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
    post/v1/messages
    ModelsExpand Collapse
    class Base64ImageSource:
    String data
    formatbyte
    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 Base64PdfSource:
    String data
    formatbyte
    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 CacheControlEphemeral:
    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 CacheCreation:
    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 CitationCharLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationContentBlockLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationPageLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationsConfigParam:
    Optional<Boolean> enabled
    class CitationsDelta:
    Citation citation
    Accepts one of the following:
    class CitationCharLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    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 CitationsSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 CitationsSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 CitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    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 ContentBlock: A class that can be one of several variants.union
    class TextBlock:
    Optional<List<TextCitation>> 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 CitationCharLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    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 CitationsSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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
    maxLength5000000
    minLength0
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class ThinkingBlock:
    String signature
    String thinking
    JsonValue; type "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class RedactedThinkingBlock:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class ToolUseBlock:
    String id
    Input input
    String name
    minLength1
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    class ServerToolUseBlock:
    String id
    Input input
    JsonValue; name "web_search"constant"web_search"constant
    Accepts one of the following:
    WEB_SEARCH("web_search")
    JsonValue; type "server_tool_use"constant"server_tool_use"constant
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    class WebSearchToolResultBlock:
    WebSearchToolResultBlockContent content
    Accepts one of the following:
    class WebSearchToolResultError:
    ErrorCode 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<WebSearchResultBlock>
    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 ContentBlockParam: A class that can be one of several variants.union

    Regular text content.

    class TextBlockParam:
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 ImageBlockParam:
    Source source
    Accepts one of the following:
    class Base64ImageSource:
    String data
    formatbyte
    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 UrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<CacheControlEphemeral> 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 DocumentBlockParam:
    Source source
    Accepts one of the following:
    class Base64PdfSource:
    String data
    formatbyte
    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 PlainTextSource:
    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 ContentBlockSource:
    Content content
    Accepts one of the following:
    String
    List<ContentBlockSourceContent>
    Accepts one of the following:
    class TextBlockParam:
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 ImageBlockParam:
    Source source
    Accepts one of the following:
    class Base64ImageSource:
    String data
    formatbyte
    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 UrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<CacheControlEphemeral> 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 UrlPdfSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "document"constant"document"constant
    Accepts one of the following:
    DOCUMENT("document")
    Optional<CacheControlEphemeral> 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<CitationsConfigParam> citations
    Optional<Boolean> enabled
    Optional<String> context
    minLength1
    Optional<String> title
    maxLength500
    minLength1
    class SearchResultBlockParam:
    List<TextBlockParam> content
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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<CacheControlEphemeral> 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<CitationsConfigParam> citations
    Optional<Boolean> enabled
    class ThinkingBlockParam:
    String signature
    String thinking
    JsonValue; type "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class RedactedThinkingBlockParam:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class ToolUseBlockParam:
    String id
    Input input
    String name
    maxLength200
    minLength1
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    Optional<CacheControlEphemeral> 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 ToolResultBlockParam:
    String toolUseId
    JsonValue; type "tool_result"constant"tool_result"constant
    Accepts one of the following:
    TOOL_RESULT("tool_result")
    Optional<CacheControlEphemeral> 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 TextBlockParam:
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 ImageBlockParam:
    Source source
    Accepts one of the following:
    class Base64ImageSource:
    String data
    formatbyte
    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 UrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<CacheControlEphemeral> 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 SearchResultBlockParam:
    List<TextBlockParam> content
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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<CacheControlEphemeral> 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<CitationsConfigParam> citations
    Optional<Boolean> enabled
    class DocumentBlockParam:
    Source source
    Accepts one of the following:
    class Base64PdfSource:
    String data
    formatbyte
    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 PlainTextSource:
    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 ContentBlockSource:
    Content content
    Accepts one of the following:
    String
    List<ContentBlockSourceContent>
    Accepts one of the following:
    class TextBlockParam:
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 ImageBlockParam:
    Source source
    Accepts one of the following:
    class Base64ImageSource:
    String data
    formatbyte
    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 UrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<CacheControlEphemeral> 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 UrlPdfSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "document"constant"document"constant
    Accepts one of the following:
    DOCUMENT("document")
    Optional<CacheControlEphemeral> 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<CitationsConfigParam> citations
    Optional<Boolean> enabled
    Optional<String> context
    minLength1
    Optional<String> title
    maxLength500
    minLength1
    Optional<Boolean> isError
    class ServerToolUseBlockParam:
    String id
    Input input
    JsonValue; name "web_search"constant"web_search"constant
    Accepts one of the following:
    WEB_SEARCH("web_search")
    JsonValue; type "server_tool_use"constant"server_tool_use"constant
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    Optional<CacheControlEphemeral> 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 WebSearchToolResultBlockParam:
    WebSearchToolResultBlockParamContent content
    Accepts one of the following:
    List<WebSearchResultBlockParam>
    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 WebSearchToolRequestError:
    ErrorCode 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<CacheControlEphemeral> 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 ContentBlockSource:
    Content content
    Accepts one of the following:
    String
    List<ContentBlockSourceContent>
    Accepts one of the following:
    class TextBlockParam:
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 ImageBlockParam:
    Source source
    Accepts one of the following:
    class Base64ImageSource:
    String data
    formatbyte
    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 UrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<CacheControlEphemeral> 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 ContentBlockSourceContent: A class that can be one of several variants.union
    class TextBlockParam:
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 ImageBlockParam:
    Source source
    Accepts one of the following:
    class Base64ImageSource:
    String data
    formatbyte
    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 UrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<CacheControlEphemeral> 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 DocumentBlockParam:
    Source source
    Accepts one of the following:
    class Base64PdfSource:
    String data
    formatbyte
    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 PlainTextSource:
    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 ContentBlockSource:
    Content content
    Accepts one of the following:
    String
    List<ContentBlockSourceContent>
    Accepts one of the following:
    class TextBlockParam:
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 ImageBlockParam:
    Source source
    Accepts one of the following:
    class Base64ImageSource:
    String data
    formatbyte
    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 UrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<CacheControlEphemeral> 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 UrlPdfSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "document"constant"document"constant
    Accepts one of the following:
    DOCUMENT("document")
    Optional<CacheControlEphemeral> 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<CitationsConfigParam> citations
    Optional<Boolean> enabled
    Optional<String> context
    minLength1
    Optional<String> title
    maxLength500
    minLength1
    class ImageBlockParam:
    Source source
    Accepts one of the following:
    class Base64ImageSource:
    String data
    formatbyte
    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 UrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<CacheControlEphemeral> 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 InputJsonDelta:
    String partialJson
    JsonValue; type "input_json_delta"constant"input_json_delta"constant
    Accepts one of the following:
    INPUT_JSON_DELTA("input_json_delta")
    class Message:
    String id

    Unique object identifier.

    The format and length of IDs may change over time.

    List<ContentBlock> 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 TextBlock:
    Optional<List<TextCitation>> 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 CitationCharLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    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 CitationsSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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
    maxLength5000000
    minLength0
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class ThinkingBlock:
    String signature
    String thinking
    JsonValue; type "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class RedactedThinkingBlock:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class ToolUseBlock:
    String id
    Input input
    String name
    minLength1
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    class ServerToolUseBlock:
    String id
    Input input
    JsonValue; name "web_search"constant"web_search"constant
    Accepts one of the following:
    WEB_SEARCH("web_search")
    JsonValue; type "server_tool_use"constant"server_tool_use"constant
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    class WebSearchToolResultBlock:
    WebSearchToolResultBlockContent content
    Accepts one of the following:
    class WebSearchToolResultError:
    ErrorCode 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<WebSearchResultBlock>
    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")
    Model model

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    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<StopReason> 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")
    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")
    Usage 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<CacheCreation> 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<ServerToolUsage> serverToolUse

    The number of server tool requests.

    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 MessageCountTokensTool: A class that can be one of several variants.union
    class Tool:
    InputSchema inputSchema

    JSON schema for this tool's input.

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

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

    Name of the tool.

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

    maxLength128
    minLength1
    Optional<CacheControlEphemeral> 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<String> description

    Description of what this tool does.

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

    Optional<Type> type
    Accepts one of the following:
    CUSTOM("custom")
    class ToolBash20250124:
    JsonValue; name "bash"constant"bash"constant

    Name of the tool.

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

    Accepts one of the following:
    BASH("bash")
    JsonValue; type "bash_20250124"constant"bash_20250124"constant
    Accepts one of the following:
    BASH_20250124("bash_20250124")
    Optional<CacheControlEphemeral> 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 ToolTextEditor20250124:
    JsonValue; name "str_replace_editor"constant"str_replace_editor"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_EDITOR("str_replace_editor")
    JsonValue; type "text_editor_20250124"constant"text_editor_20250124"constant
    Accepts one of the following:
    TEXT_EDITOR_20250124("text_editor_20250124")
    Optional<CacheControlEphemeral> 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 ToolTextEditor20250429:
    JsonValue; name "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_BASED_EDIT_TOOL("str_replace_based_edit_tool")
    JsonValue; type "text_editor_20250429"constant"text_editor_20250429"constant
    Accepts one of the following:
    TEXT_EDITOR_20250429("text_editor_20250429")
    Optional<CacheControlEphemeral> 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 ToolTextEditor20250728:
    JsonValue; name "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_BASED_EDIT_TOOL("str_replace_based_edit_tool")
    JsonValue; type "text_editor_20250728"constant"text_editor_20250728"constant
    Accepts one of the following:
    TEXT_EDITOR_20250728("text_editor_20250728")
    Optional<CacheControlEphemeral> 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<Long> maxCharacters

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

    minimum1
    class WebSearchTool20250305:
    JsonValue; name "web_search"constant"web_search"constant

    Name of the tool.

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

    Accepts one of the following:
    WEB_SEARCH("web_search")
    JsonValue; type "web_search_20250305"constant"web_search_20250305"constant
    Accepts one of the following:
    WEB_SEARCH_20250305("web_search_20250305")
    Optional<List<String>> allowedDomains

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

    Optional<List<String>> blockedDomains

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

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

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

    exclusiveMinimum0
    Optional<UserLocation> userLocation

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

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

    The city of the user.

    maxLength255
    minLength1
    Optional<String> country

    The two letter ISO country code of the user.

    maxLength2
    minLength2
    Optional<String> region

    The region of the user.

    maxLength255
    minLength1
    Optional<String> timezone

    The IANA timezone of the user.

    maxLength255
    minLength1
    class MessageDeltaUsage:
    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<ServerToolUsage> serverToolUse

    The number of server tool requests.

    long webSearchRequests

    The number of web search tool requests.

    minimum0
    class MessageParam:
    Content content
    Accepts one of the following:
    String
    List<ContentBlockParam>
    Accepts one of the following:
    class TextBlockParam:
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 ImageBlockParam:
    Source source
    Accepts one of the following:
    class Base64ImageSource:
    String data
    formatbyte
    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 UrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<CacheControlEphemeral> 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 DocumentBlockParam:
    Source source
    Accepts one of the following:
    class Base64PdfSource:
    String data
    formatbyte
    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 PlainTextSource:
    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 ContentBlockSource:
    Content content
    Accepts one of the following:
    String
    List<ContentBlockSourceContent>
    Accepts one of the following:
    class TextBlockParam:
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 ImageBlockParam:
    Source source
    Accepts one of the following:
    class Base64ImageSource:
    String data
    formatbyte
    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 UrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<CacheControlEphemeral> 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 UrlPdfSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "document"constant"document"constant
    Accepts one of the following:
    DOCUMENT("document")
    Optional<CacheControlEphemeral> 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<CitationsConfigParam> citations
    Optional<Boolean> enabled
    Optional<String> context
    minLength1
    Optional<String> title
    maxLength500
    minLength1
    class SearchResultBlockParam:
    List<TextBlockParam> content
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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<CacheControlEphemeral> 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<CitationsConfigParam> citations
    Optional<Boolean> enabled
    class ThinkingBlockParam:
    String signature
    String thinking
    JsonValue; type "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class RedactedThinkingBlockParam:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class ToolUseBlockParam:
    String id
    Input input
    String name
    maxLength200
    minLength1
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    Optional<CacheControlEphemeral> 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 ToolResultBlockParam:
    String toolUseId
    JsonValue; type "tool_result"constant"tool_result"constant
    Accepts one of the following:
    TOOL_RESULT("tool_result")
    Optional<CacheControlEphemeral> 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 TextBlockParam:
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 ImageBlockParam:
    Source source
    Accepts one of the following:
    class Base64ImageSource:
    String data
    formatbyte
    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 UrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<CacheControlEphemeral> 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 SearchResultBlockParam:
    List<TextBlockParam> content
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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<CacheControlEphemeral> 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<CitationsConfigParam> citations
    Optional<Boolean> enabled
    class DocumentBlockParam:
    Source source
    Accepts one of the following:
    class Base64PdfSource:
    String data
    formatbyte
    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 PlainTextSource:
    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 ContentBlockSource:
    Content content
    Accepts one of the following:
    String
    List<ContentBlockSourceContent>
    Accepts one of the following:
    class TextBlockParam:
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 ImageBlockParam:
    Source source
    Accepts one of the following:
    class Base64ImageSource:
    String data
    formatbyte
    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 UrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<CacheControlEphemeral> 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 UrlPdfSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "document"constant"document"constant
    Accepts one of the following:
    DOCUMENT("document")
    Optional<CacheControlEphemeral> 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<CitationsConfigParam> citations
    Optional<Boolean> enabled
    Optional<String> context
    minLength1
    Optional<String> title
    maxLength500
    minLength1
    Optional<Boolean> isError
    class ServerToolUseBlockParam:
    String id
    Input input
    JsonValue; name "web_search"constant"web_search"constant
    Accepts one of the following:
    WEB_SEARCH("web_search")
    JsonValue; type "server_tool_use"constant"server_tool_use"constant
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    Optional<CacheControlEphemeral> 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 WebSearchToolResultBlockParam:
    WebSearchToolResultBlockParamContent content
    Accepts one of the following:
    List<WebSearchResultBlockParam>
    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 WebSearchToolRequestError:
    ErrorCode 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<CacheControlEphemeral> 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 MessageTokensCount:
    long inputTokens

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

    class Metadata:
    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 PlainTextSource:
    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 RawContentBlockDelta: A class that can be one of several variants.union
    class TextDelta:
    String text
    JsonValue; type "text_delta"constant"text_delta"constant
    Accepts one of the following:
    TEXT_DELTA("text_delta")
    class InputJsonDelta:
    String partialJson
    JsonValue; type "input_json_delta"constant"input_json_delta"constant
    Accepts one of the following:
    INPUT_JSON_DELTA("input_json_delta")
    class CitationsDelta:
    Citation citation
    Accepts one of the following:
    class CitationCharLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    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 CitationsSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 ThinkingDelta:
    String thinking
    JsonValue; type "thinking_delta"constant"thinking_delta"constant
    Accepts one of the following:
    THINKING_DELTA("thinking_delta")
    class SignatureDelta:
    String signature
    JsonValue; type "signature_delta"constant"signature_delta"constant
    Accepts one of the following:
    SIGNATURE_DELTA("signature_delta")
    class RawContentBlockDeltaEvent:
    RawContentBlockDelta delta
    Accepts one of the following:
    class TextDelta:
    String text
    JsonValue; type "text_delta"constant"text_delta"constant
    Accepts one of the following:
    TEXT_DELTA("text_delta")
    class InputJsonDelta:
    String partialJson
    JsonValue; type "input_json_delta"constant"input_json_delta"constant
    Accepts one of the following:
    INPUT_JSON_DELTA("input_json_delta")
    class CitationsDelta:
    Citation citation
    Accepts one of the following:
    class CitationCharLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    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 CitationsSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 ThinkingDelta:
    String thinking
    JsonValue; type "thinking_delta"constant"thinking_delta"constant
    Accepts one of the following:
    THINKING_DELTA("thinking_delta")
    class SignatureDelta:
    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 RawContentBlockStartEvent:
    ContentBlock contentBlock
    Accepts one of the following:
    class TextBlock:
    Optional<List<TextCitation>> 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 CitationCharLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    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 CitationsSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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
    maxLength5000000
    minLength0
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class ThinkingBlock:
    String signature
    String thinking
    JsonValue; type "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class RedactedThinkingBlock:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class ToolUseBlock:
    String id
    Input input
    String name
    minLength1
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    class ServerToolUseBlock:
    String id
    Input input
    JsonValue; name "web_search"constant"web_search"constant
    Accepts one of the following:
    WEB_SEARCH("web_search")
    JsonValue; type "server_tool_use"constant"server_tool_use"constant
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    class WebSearchToolResultBlock:
    WebSearchToolResultBlockContent content
    Accepts one of the following:
    class WebSearchToolResultError:
    ErrorCode 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<WebSearchResultBlock>
    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")
    long index
    JsonValue; type "content_block_start"constant"content_block_start"constant
    Accepts one of the following:
    CONTENT_BLOCK_START("content_block_start")
    class RawContentBlockStopEvent:
    long index
    JsonValue; type "content_block_stop"constant"content_block_stop"constant
    Accepts one of the following:
    CONTENT_BLOCK_STOP("content_block_stop")
    class RawMessageDeltaEvent:
    Delta delta
    Optional<StopReason> stopReason
    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")
    Optional<String> stopSequence
    JsonValue; type "message_delta"constant"message_delta"constant
    Accepts one of the following:
    MESSAGE_DELTA("message_delta")
    MessageDeltaUsage usage

    Billing and rate-limit usage.

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

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

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

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

    Optional<Long> cacheCreationInputTokens

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

    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<ServerToolUsage> serverToolUse

    The number of server tool requests.

    long webSearchRequests

    The number of web search tool requests.

    minimum0
    class RawMessageStartEvent:
    Message message
    String id

    Unique object identifier.

    The format and length of IDs may change over time.

    List<ContentBlock> 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 TextBlock:
    Optional<List<TextCitation>> 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 CitationCharLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    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 CitationsSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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
    maxLength5000000
    minLength0
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class ThinkingBlock:
    String signature
    String thinking
    JsonValue; type "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class RedactedThinkingBlock:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class ToolUseBlock:
    String id
    Input input
    String name
    minLength1
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    class ServerToolUseBlock:
    String id
    Input input
    JsonValue; name "web_search"constant"web_search"constant
    Accepts one of the following:
    WEB_SEARCH("web_search")
    JsonValue; type "server_tool_use"constant"server_tool_use"constant
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    class WebSearchToolResultBlock:
    WebSearchToolResultBlockContent content
    Accepts one of the following:
    class WebSearchToolResultError:
    ErrorCode 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<WebSearchResultBlock>
    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")
    Model model

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    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<StopReason> 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")
    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")
    Usage 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<CacheCreation> 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<ServerToolUsage> serverToolUse

    The number of server tool requests.

    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")
    JsonValue; type "message_start"constant"message_start"constant
    Accepts one of the following:
    MESSAGE_START("message_start")
    class RawMessageStopEvent:
    JsonValue; type "message_stop"constant"message_stop"constant
    Accepts one of the following:
    MESSAGE_STOP("message_stop")
    class RawMessageStreamEvent: A class that can be one of several variants.union
    class RawMessageStartEvent:
    Message message
    String id

    Unique object identifier.

    The format and length of IDs may change over time.

    List<ContentBlock> 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 TextBlock:
    Optional<List<TextCitation>> 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 CitationCharLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    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 CitationsSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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
    maxLength5000000
    minLength0
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class ThinkingBlock:
    String signature
    String thinking
    JsonValue; type "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class RedactedThinkingBlock:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class ToolUseBlock:
    String id
    Input input
    String name
    minLength1
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    class ServerToolUseBlock:
    String id
    Input input
    JsonValue; name "web_search"constant"web_search"constant
    Accepts one of the following:
    WEB_SEARCH("web_search")
    JsonValue; type "server_tool_use"constant"server_tool_use"constant
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    class WebSearchToolResultBlock:
    WebSearchToolResultBlockContent content
    Accepts one of the following:
    class WebSearchToolResultError:
    ErrorCode 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<WebSearchResultBlock>
    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")
    Model model

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    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<StopReason> 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")
    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")
    Usage 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<CacheCreation> 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<ServerToolUsage> serverToolUse

    The number of server tool requests.

    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")
    JsonValue; type "message_start"constant"message_start"constant
    Accepts one of the following:
    MESSAGE_START("message_start")
    class RawMessageDeltaEvent:
    Delta delta
    Optional<StopReason> stopReason
    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")
    Optional<String> stopSequence
    JsonValue; type "message_delta"constant"message_delta"constant
    Accepts one of the following:
    MESSAGE_DELTA("message_delta")
    MessageDeltaUsage usage

    Billing and rate-limit usage.

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

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

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

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

    Optional<Long> cacheCreationInputTokens

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

    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<ServerToolUsage> serverToolUse

    The number of server tool requests.

    long webSearchRequests

    The number of web search tool requests.

    minimum0
    class RawMessageStopEvent:
    JsonValue; type "message_stop"constant"message_stop"constant
    Accepts one of the following:
    MESSAGE_STOP("message_stop")
    class RawContentBlockStartEvent:
    ContentBlock contentBlock
    Accepts one of the following:
    class TextBlock:
    Optional<List<TextCitation>> 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 CitationCharLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    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 CitationsSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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
    maxLength5000000
    minLength0
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class ThinkingBlock:
    String signature
    String thinking
    JsonValue; type "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class RedactedThinkingBlock:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class ToolUseBlock:
    String id
    Input input
    String name
    minLength1
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    class ServerToolUseBlock:
    String id
    Input input
    JsonValue; name "web_search"constant"web_search"constant
    Accepts one of the following:
    WEB_SEARCH("web_search")
    JsonValue; type "server_tool_use"constant"server_tool_use"constant
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    class WebSearchToolResultBlock:
    WebSearchToolResultBlockContent content
    Accepts one of the following:
    class WebSearchToolResultError:
    ErrorCode 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<WebSearchResultBlock>
    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")
    long index
    JsonValue; type "content_block_start"constant"content_block_start"constant
    Accepts one of the following:
    CONTENT_BLOCK_START("content_block_start")
    class RawContentBlockDeltaEvent:
    RawContentBlockDelta delta
    Accepts one of the following:
    class TextDelta:
    String text
    JsonValue; type "text_delta"constant"text_delta"constant
    Accepts one of the following:
    TEXT_DELTA("text_delta")
    class InputJsonDelta:
    String partialJson
    JsonValue; type "input_json_delta"constant"input_json_delta"constant
    Accepts one of the following:
    INPUT_JSON_DELTA("input_json_delta")
    class CitationsDelta:
    Citation citation
    Accepts one of the following:
    class CitationCharLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    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 CitationsSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 ThinkingDelta:
    String thinking
    JsonValue; type "thinking_delta"constant"thinking_delta"constant
    Accepts one of the following:
    THINKING_DELTA("thinking_delta")
    class SignatureDelta:
    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 RawContentBlockStopEvent:
    long index
    JsonValue; type "content_block_stop"constant"content_block_stop"constant
    Accepts one of the following:
    CONTENT_BLOCK_STOP("content_block_stop")
    class RedactedThinkingBlock:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class RedactedThinkingBlockParam:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class SearchResultBlockParam:
    List<TextBlockParam> content
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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<CacheControlEphemeral> 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<CitationsConfigParam> citations
    Optional<Boolean> enabled
    class ServerToolUsage:
    long webSearchRequests

    The number of web search tool requests.

    minimum0
    class ServerToolUseBlock:
    String id
    Input input
    JsonValue; name "web_search"constant"web_search"constant
    Accepts one of the following:
    WEB_SEARCH("web_search")
    JsonValue; type "server_tool_use"constant"server_tool_use"constant
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    class ServerToolUseBlockParam:
    String id
    Input input
    JsonValue; name "web_search"constant"web_search"constant
    Accepts one of the following:
    WEB_SEARCH("web_search")
    JsonValue; type "server_tool_use"constant"server_tool_use"constant
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    Optional<CacheControlEphemeral> 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 SignatureDelta:
    String signature
    JsonValue; type "signature_delta"constant"signature_delta"constant
    Accepts one of the following:
    SIGNATURE_DELTA("signature_delta")
    enum StopReason:
    END_TURN("end_turn")
    MAX_TOKENS("max_tokens")
    STOP_SEQUENCE("stop_sequence")
    TOOL_USE("tool_use")
    PAUSE_TURN("pause_turn")
    REFUSAL("refusal")
    class TextBlock:
    Optional<List<TextCitation>> 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 CitationCharLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    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 CitationsSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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
    maxLength5000000
    minLength0
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class TextBlockParam:
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 TextCitation: A class that can be one of several variants.union
    class CitationCharLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    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 CitationsSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 TextCitationParam: A class that can be one of several variants.union
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 TextDelta:
    String text
    JsonValue; type "text_delta"constant"text_delta"constant
    Accepts one of the following:
    TEXT_DELTA("text_delta")
    class ThinkingBlock:
    String signature
    String thinking
    JsonValue; type "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class ThinkingBlockParam:
    String signature
    String thinking
    JsonValue; type "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class ThinkingConfigDisabled:
    JsonValue; type "disabled"constant"disabled"constant
    Accepts one of the following:
    DISABLED("disabled")
    class ThinkingConfigEnabled:
    long budgetTokens

    Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.

    Must be ≥1024 and less than max_tokens.

    See extended thinking for details.

    minimum1024
    JsonValue; type "enabled"constant"enabled"constant
    Accepts one of the following:
    ENABLED("enabled")
    class ThinkingConfigParam: A class that can be one of several variants.union

    Configuration for enabling Claude's extended thinking.

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

    See extended thinking for details.

    class ThinkingConfigEnabled:
    long budgetTokens

    Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.

    Must be ≥1024 and less than max_tokens.

    See extended thinking for details.

    minimum1024
    JsonValue; type "enabled"constant"enabled"constant
    Accepts one of the following:
    ENABLED("enabled")
    class ThinkingConfigDisabled:
    JsonValue; type "disabled"constant"disabled"constant
    Accepts one of the following:
    DISABLED("disabled")
    class ThinkingDelta:
    String thinking
    JsonValue; type "thinking_delta"constant"thinking_delta"constant
    Accepts one of the following:
    THINKING_DELTA("thinking_delta")
    class Tool:
    InputSchema inputSchema

    JSON schema for this tool's input.

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

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

    Name of the tool.

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

    maxLength128
    minLength1
    Optional<CacheControlEphemeral> 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<String> description

    Description of what this tool does.

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

    Optional<Type> type
    Accepts one of the following:
    CUSTOM("custom")
    class ToolBash20250124:
    JsonValue; name "bash"constant"bash"constant

    Name of the tool.

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

    Accepts one of the following:
    BASH("bash")
    JsonValue; type "bash_20250124"constant"bash_20250124"constant
    Accepts one of the following:
    BASH_20250124("bash_20250124")
    Optional<CacheControlEphemeral> 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 ToolChoice: A class that can be one of several variants.union

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

    class ToolChoiceAuto:

    The model will automatically decide whether to use tools.

    JsonValue; type "auto"constant"auto"constant
    Accepts one of the following:
    AUTO("auto")
    Optional<Boolean> disableParallelToolUse

    Whether to disable parallel tool use.

    Defaults to false. If set to true, the model will output at most one tool use.

    class ToolChoiceAny:

    The model will use any available tools.

    JsonValue; type "any"constant"any"constant
    Accepts one of the following:
    ANY("any")
    Optional<Boolean> disableParallelToolUse

    Whether to disable parallel tool use.

    Defaults to false. If set to true, the model will output exactly one tool use.

    class ToolChoiceTool:

    The model will use the specified tool with tool_choice.name.

    String name

    The name of the tool to use.

    JsonValue; type "tool"constant"tool"constant
    Accepts one of the following:
    TOOL("tool")
    Optional<Boolean> disableParallelToolUse

    Whether to disable parallel tool use.

    Defaults to false. If set to true, the model will output exactly one tool use.

    class ToolChoiceNone:

    The model will not be allowed to use tools.

    JsonValue; type "none"constant"none"constant
    Accepts one of the following:
    NONE("none")
    class ToolChoiceAny:

    The model will use any available tools.

    JsonValue; type "any"constant"any"constant
    Accepts one of the following:
    ANY("any")
    Optional<Boolean> disableParallelToolUse

    Whether to disable parallel tool use.

    Defaults to false. If set to true, the model will output exactly one tool use.

    class ToolChoiceAuto:

    The model will automatically decide whether to use tools.

    JsonValue; type "auto"constant"auto"constant
    Accepts one of the following:
    AUTO("auto")
    Optional<Boolean> disableParallelToolUse

    Whether to disable parallel tool use.

    Defaults to false. If set to true, the model will output at most one tool use.

    class ToolChoiceNone:

    The model will not be allowed to use tools.

    JsonValue; type "none"constant"none"constant
    Accepts one of the following:
    NONE("none")
    class ToolChoiceTool:

    The model will use the specified tool with tool_choice.name.

    String name

    The name of the tool to use.

    JsonValue; type "tool"constant"tool"constant
    Accepts one of the following:
    TOOL("tool")
    Optional<Boolean> disableParallelToolUse

    Whether to disable parallel tool use.

    Defaults to false. If set to true, the model will output exactly one tool use.

    class ToolResultBlockParam:
    String toolUseId
    JsonValue; type "tool_result"constant"tool_result"constant
    Accepts one of the following:
    TOOL_RESULT("tool_result")
    Optional<CacheControlEphemeral> 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 TextBlockParam:
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 ImageBlockParam:
    Source source
    Accepts one of the following:
    class Base64ImageSource:
    String data
    formatbyte
    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 UrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<CacheControlEphemeral> 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 SearchResultBlockParam:
    List<TextBlockParam> content
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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<CacheControlEphemeral> 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<CitationsConfigParam> citations
    Optional<Boolean> enabled
    class DocumentBlockParam:
    Source source
    Accepts one of the following:
    class Base64PdfSource:
    String data
    formatbyte
    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 PlainTextSource:
    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 ContentBlockSource:
    Content content
    Accepts one of the following:
    String
    List<ContentBlockSourceContent>
    Accepts one of the following:
    class TextBlockParam:
    String text
    minLength1
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    Optional<CacheControlEphemeral> 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<TextCitationParam>> citations
    Accepts one of the following:
    class CitationCharLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endCharIndex
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endPageNumber
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocationParam:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    maxLength255
    minLength1
    long endBlockIndex
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationWebSearchResultLocationParam:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    minLength1
    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
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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 ImageBlockParam:
    Source source
    Accepts one of the following:
    class Base64ImageSource:
    String data
    formatbyte
    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 UrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    Optional<CacheControlEphemeral> 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 UrlPdfSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    JsonValue; type "document"constant"document"constant
    Accepts one of the following:
    DOCUMENT("document")
    Optional<CacheControlEphemeral> 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<CitationsConfigParam> citations
    Optional<Boolean> enabled
    Optional<String> context
    minLength1
    Optional<String> title
    maxLength500
    minLength1
    Optional<Boolean> isError
    class ToolTextEditor20250124:
    JsonValue; name "str_replace_editor"constant"str_replace_editor"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_EDITOR("str_replace_editor")
    JsonValue; type "text_editor_20250124"constant"text_editor_20250124"constant
    Accepts one of the following:
    TEXT_EDITOR_20250124("text_editor_20250124")
    Optional<CacheControlEphemeral> 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 ToolTextEditor20250429:
    JsonValue; name "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_BASED_EDIT_TOOL("str_replace_based_edit_tool")
    JsonValue; type "text_editor_20250429"constant"text_editor_20250429"constant
    Accepts one of the following:
    TEXT_EDITOR_20250429("text_editor_20250429")
    Optional<CacheControlEphemeral> 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 ToolTextEditor20250728:
    JsonValue; name "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_BASED_EDIT_TOOL("str_replace_based_edit_tool")
    JsonValue; type "text_editor_20250728"constant"text_editor_20250728"constant
    Accepts one of the following:
    TEXT_EDITOR_20250728("text_editor_20250728")
    Optional<CacheControlEphemeral> 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<Long> maxCharacters

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

    minimum1
    class ToolUnion: A class that can be one of several variants.union
    class Tool:
    InputSchema inputSchema

    JSON schema for this tool's input.

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

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

    Name of the tool.

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

    maxLength128
    minLength1
    Optional<CacheControlEphemeral> 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<String> description

    Description of what this tool does.

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

    Optional<Type> type
    Accepts one of the following:
    CUSTOM("custom")
    class ToolBash20250124:
    JsonValue; name "bash"constant"bash"constant

    Name of the tool.

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

    Accepts one of the following:
    BASH("bash")
    JsonValue; type "bash_20250124"constant"bash_20250124"constant
    Accepts one of the following:
    BASH_20250124("bash_20250124")
    Optional<CacheControlEphemeral> 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 ToolTextEditor20250124:
    JsonValue; name "str_replace_editor"constant"str_replace_editor"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_EDITOR("str_replace_editor")
    JsonValue; type "text_editor_20250124"constant"text_editor_20250124"constant
    Accepts one of the following:
    TEXT_EDITOR_20250124("text_editor_20250124")
    Optional<CacheControlEphemeral> 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 ToolTextEditor20250429:
    JsonValue; name "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_BASED_EDIT_TOOL("str_replace_based_edit_tool")
    JsonValue; type "text_editor_20250429"constant"text_editor_20250429"constant
    Accepts one of the following:
    TEXT_EDITOR_20250429("text_editor_20250429")
    Optional<CacheControlEphemeral> 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 ToolTextEditor20250728:
    JsonValue; name "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_BASED_EDIT_TOOL("str_replace_based_edit_tool")
    JsonValue; type "text_editor_20250728"constant"text_editor_20250728"constant
    Accepts one of the following:
    TEXT_EDITOR_20250728("text_editor_20250728")
    Optional<CacheControlEphemeral> 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<Long> maxCharacters

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

    minimum1
    class WebSearchTool20250305:
    JsonValue; name "web_search"constant"web_search"constant

    Name of the tool.

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

    Accepts one of the following:
    WEB_SEARCH("web_search")
    JsonValue; type "web_search_20250305"constant"web_search_20250305"constant
    Accepts one of the following:
    WEB_SEARCH_20250305("web_search_20250305")
    Optional<List<String>> allowedDomains

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

    Optional<List<String>> blockedDomains

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

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

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

    exclusiveMinimum0
    Optional<UserLocation> userLocation

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

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

    The city of the user.

    maxLength255
    minLength1
    Optional<String> country

    The two letter ISO country code of the user.

    maxLength2
    minLength2
    Optional<String> region

    The region of the user.

    maxLength255
    minLength1
    Optional<String> timezone

    The IANA timezone of the user.

    maxLength255
    minLength1
    class ToolUseBlock:
    String id
    Input input
    String name
    minLength1
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    class ToolUseBlockParam:
    String id
    Input input
    String name
    maxLength200
    minLength1
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    Optional<CacheControlEphemeral> 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 UrlImageSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    class UrlPdfSource:
    JsonValue; type "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    String url
    class Usage:
    Optional<CacheCreation> 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<ServerToolUsage> serverToolUse

    The number of server tool requests.

    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 WebSearchResultBlock:
    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
    class WebSearchResultBlockParam:
    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 WebSearchTool20250305:
    JsonValue; name "web_search"constant"web_search"constant

    Name of the tool.

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

    Accepts one of the following:
    WEB_SEARCH("web_search")
    JsonValue; type "web_search_20250305"constant"web_search_20250305"constant
    Accepts one of the following:
    WEB_SEARCH_20250305("web_search_20250305")
    Optional<List<String>> allowedDomains

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

    Optional<List<String>> blockedDomains

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

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

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

    exclusiveMinimum0
    Optional<UserLocation> userLocation

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

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

    The city of the user.

    maxLength255
    minLength1
    Optional<String> country

    The two letter ISO country code of the user.

    maxLength2
    minLength2
    Optional<String> region

    The region of the user.

    maxLength255
    minLength1
    Optional<String> timezone

    The IANA timezone of the user.

    maxLength255
    minLength1
    class WebSearchToolRequestError:
    ErrorCode 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")
    class WebSearchToolResultBlock:
    WebSearchToolResultBlockContent content
    Accepts one of the following:
    class WebSearchToolResultError:
    ErrorCode 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<WebSearchResultBlock>
    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 WebSearchToolResultBlockContent: A class that can be one of several variants.union
    class WebSearchToolResultError:
    ErrorCode 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<WebSearchResultBlock>
    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
    class WebSearchToolResultBlockParam:
    WebSearchToolResultBlockParamContent content
    Accepts one of the following:
    List<WebSearchResultBlockParam>
    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 WebSearchToolRequestError:
    ErrorCode 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<CacheControlEphemeral> 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 WebSearchToolResultBlockParamContent: A class that can be one of several variants.union
    List<WebSearchResultBlockParam>
    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 WebSearchToolRequestError:
    ErrorCode 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")
    class WebSearchToolResultError:
    ErrorCode 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")

    MessagesBatches

    Cancel a Message Batch
    MessageBatch messages().batches().cancel(BatchCancelParamsparams = BatchCancelParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
    post/v1/messages/batches/{message_batch_id}/cancel
    Create a Message Batch
    MessageBatch messages().batches().create(BatchCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
    post/v1/messages/batches
    Delete a Message Batch
    DeletedMessageBatch messages().batches().delete(BatchDeleteParamsparams = BatchDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
    delete/v1/messages/batches/{message_batch_id}
    List Message Batches
    BatchListPage messages().batches().list(BatchListParamsparams = BatchListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
    get/v1/messages/batches
    Retrieve Message Batch results
    MessageBatchIndividualResponse messages().batches().resultsStreaming(BatchResultsParamsparams = BatchResultsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
    get/v1/messages/batches/{message_batch_id}/results
    Retrieve a Message Batch
    MessageBatch messages().batches().retrieve(BatchRetrieveParamsparams = BatchRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
    get/v1/messages/batches/{message_batch_id}
    ModelsExpand Collapse
    class DeletedMessageBatch:
    String id

    ID of the Message Batch.

    JsonValue; type "message_batch_deleted"constant"message_batch_deleted"constant

    Deleted object type.

    For Message Batches, this is always "message_batch_deleted".

    Accepts one of the following:
    MESSAGE_BATCH_DELETED("message_batch_deleted")
    class MessageBatch:
    String id

    Unique object identifier.

    The format and length of IDs may change over time.

    Optional<LocalDateTime> archivedAt

    RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.

    formatdate-time
    Optional<LocalDateTime> cancelInitiatedAt

    RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.

    formatdate-time
    LocalDateTime createdAt

    RFC 3339 datetime string representing the time at which the Message Batch was created.

    formatdate-time
    Optional<LocalDateTime> endedAt

    RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends.

    Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired.

    formatdate-time
    LocalDateTime expiresAt

    RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.

    formatdate-time
    ProcessingStatus processingStatus

    Processing status of the Message Batch.

    Accepts one of the following:
    IN_PROGRESS("in_progress")
    CANCELING("canceling")
    ENDED("ended")
    MessageBatchRequestCounts requestCounts

    Tallies requests within the Message Batch, categorized by their status.

    Requests start as processing and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch.

    long canceled

    Number of requests in the Message Batch that have been canceled.

    This is zero until processing of the entire Message Batch has ended.

    long errored

    Number of requests in the Message Batch that encountered an error.

    This is zero until processing of the entire Message Batch has ended.

    long expired

    Number of requests in the Message Batch that have expired.

    This is zero until processing of the entire Message Batch has ended.

    long processing

    Number of requests in the Message Batch that are processing.

    long succeeded

    Number of requests in the Message Batch that have completed successfully.

    This is zero until processing of the entire Message Batch has ended.

    Optional<String> resultsUrl

    URL to a .jsonl file containing the results of the Message Batch requests. Specified only once processing ends.

    Results in the file are not guaranteed to be in the same order as requests. Use the custom_id field to match results to requests.

    JsonValue; type "message_batch"constant"message_batch"constant

    Object type.

    For Message Batches, this is always "message_batch".

    Accepts one of the following:
    MESSAGE_BATCH("message_batch")
    class MessageBatchCanceledResult:
    JsonValue; type "canceled"constant"canceled"constant
    Accepts one of the following:
    CANCELED("canceled")
    class MessageBatchErroredResult:
    ErrorResponse error
    ErrorObject error
    Accepts one of the following:
    class InvalidRequestError:
    String message
    JsonValue; type "invalid_request_error"constant"invalid_request_error"constant
    Accepts one of the following:
    INVALID_REQUEST_ERROR("invalid_request_error")
    class AuthenticationError:
    String message
    JsonValue; type "authentication_error"constant"authentication_error"constant
    Accepts one of the following:
    AUTHENTICATION_ERROR("authentication_error")
    class BillingError:
    String message
    JsonValue; type "billing_error"constant"billing_error"constant
    Accepts one of the following:
    BILLING_ERROR("billing_error")
    class PermissionError:
    String message
    JsonValue; type "permission_error"constant"permission_error"constant
    Accepts one of the following:
    PERMISSION_ERROR("permission_error")
    class NotFoundError:
    String message
    JsonValue; type "not_found_error"constant"not_found_error"constant
    Accepts one of the following:
    NOT_FOUND_ERROR("not_found_error")
    class RateLimitError:
    String message
    JsonValue; type "rate_limit_error"constant"rate_limit_error"constant
    Accepts one of the following:
    RATE_LIMIT_ERROR("rate_limit_error")
    class GatewayTimeoutError:
    String message
    JsonValue; type "timeout_error"constant"timeout_error"constant
    Accepts one of the following:
    TIMEOUT_ERROR("timeout_error")
    class ApiErrorObject:
    String message
    JsonValue; type "api_error"constant"api_error"constant
    Accepts one of the following:
    API_ERROR("api_error")
    class OverloadedError:
    String message
    JsonValue; type "overloaded_error"constant"overloaded_error"constant
    Accepts one of the following:
    OVERLOADED_ERROR("overloaded_error")
    Optional<String> requestId
    JsonValue; type "error"constant"error"constant
    Accepts one of the following:
    ERROR("error")
    JsonValue; type "errored"constant"errored"constant
    Accepts one of the following:
    ERRORED("errored")
    class MessageBatchExpiredResult:
    JsonValue; type "expired"constant"expired"constant
    Accepts one of the following:
    EXPIRED("expired")
    class MessageBatchIndividualResponse:

    This is a single line in the response .jsonl file and does not represent the response as a whole.

    String customId

    Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order.

    Must be unique for each request within the Message Batch.

    MessageBatchResult result

    Processing result for this request.

    Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.

    Accepts one of the following:
    class MessageBatchSucceededResult:
    Message message
    String id

    Unique object identifier.

    The format and length of IDs may change over time.

    List<ContentBlock> 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 TextBlock:
    Optional<List<TextCitation>> 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 CitationCharLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    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 CitationsSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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
    maxLength5000000
    minLength0
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class ThinkingBlock:
    String signature
    String thinking
    JsonValue; type "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class RedactedThinkingBlock:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class ToolUseBlock:
    String id
    Input input
    String name
    minLength1
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    class ServerToolUseBlock:
    String id
    Input input
    JsonValue; name "web_search"constant"web_search"constant
    Accepts one of the following:
    WEB_SEARCH("web_search")
    JsonValue; type "server_tool_use"constant"server_tool_use"constant
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    class WebSearchToolResultBlock:
    WebSearchToolResultBlockContent content
    Accepts one of the following:
    class WebSearchToolResultError:
    ErrorCode 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<WebSearchResultBlock>
    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")
    Model model

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    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<StopReason> 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")
    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")
    Usage 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<CacheCreation> 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<ServerToolUsage> serverToolUse

    The number of server tool requests.

    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")
    JsonValue; type "succeeded"constant"succeeded"constant
    Accepts one of the following:
    SUCCEEDED("succeeded")
    class MessageBatchErroredResult:
    ErrorResponse error
    ErrorObject error
    Accepts one of the following:
    class InvalidRequestError:
    String message
    JsonValue; type "invalid_request_error"constant"invalid_request_error"constant
    Accepts one of the following:
    INVALID_REQUEST_ERROR("invalid_request_error")
    class AuthenticationError:
    String message
    JsonValue; type "authentication_error"constant"authentication_error"constant
    Accepts one of the following:
    AUTHENTICATION_ERROR("authentication_error")
    class BillingError:
    String message
    JsonValue; type "billing_error"constant"billing_error"constant
    Accepts one of the following:
    BILLING_ERROR("billing_error")
    class PermissionError:
    String message
    JsonValue; type "permission_error"constant"permission_error"constant
    Accepts one of the following:
    PERMISSION_ERROR("permission_error")
    class NotFoundError:
    String message
    JsonValue; type "not_found_error"constant"not_found_error"constant
    Accepts one of the following:
    NOT_FOUND_ERROR("not_found_error")
    class RateLimitError:
    String message
    JsonValue; type "rate_limit_error"constant"rate_limit_error"constant
    Accepts one of the following:
    RATE_LIMIT_ERROR("rate_limit_error")
    class GatewayTimeoutError:
    String message
    JsonValue; type "timeout_error"constant"timeout_error"constant
    Accepts one of the following:
    TIMEOUT_ERROR("timeout_error")
    class ApiErrorObject:
    String message
    JsonValue; type "api_error"constant"api_error"constant
    Accepts one of the following:
    API_ERROR("api_error")
    class OverloadedError:
    String message
    JsonValue; type "overloaded_error"constant"overloaded_error"constant
    Accepts one of the following:
    OVERLOADED_ERROR("overloaded_error")
    Optional<String> requestId
    JsonValue; type "error"constant"error"constant
    Accepts one of the following:
    ERROR("error")
    JsonValue; type "errored"constant"errored"constant
    Accepts one of the following:
    ERRORED("errored")
    class MessageBatchCanceledResult:
    JsonValue; type "canceled"constant"canceled"constant
    Accepts one of the following:
    CANCELED("canceled")
    class MessageBatchExpiredResult:
    JsonValue; type "expired"constant"expired"constant
    Accepts one of the following:
    EXPIRED("expired")
    class MessageBatchRequestCounts:
    long canceled

    Number of requests in the Message Batch that have been canceled.

    This is zero until processing of the entire Message Batch has ended.

    long errored

    Number of requests in the Message Batch that encountered an error.

    This is zero until processing of the entire Message Batch has ended.

    long expired

    Number of requests in the Message Batch that have expired.

    This is zero until processing of the entire Message Batch has ended.

    long processing

    Number of requests in the Message Batch that are processing.

    long succeeded

    Number of requests in the Message Batch that have completed successfully.

    This is zero until processing of the entire Message Batch has ended.

    class MessageBatchResult: A class that can be one of several variants.union

    Processing result for this request.

    Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.

    class MessageBatchSucceededResult:
    Message message
    String id

    Unique object identifier.

    The format and length of IDs may change over time.

    List<ContentBlock> 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 TextBlock:
    Optional<List<TextCitation>> 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 CitationCharLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    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 CitationsSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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
    maxLength5000000
    minLength0
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class ThinkingBlock:
    String signature
    String thinking
    JsonValue; type "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class RedactedThinkingBlock:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class ToolUseBlock:
    String id
    Input input
    String name
    minLength1
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    class ServerToolUseBlock:
    String id
    Input input
    JsonValue; name "web_search"constant"web_search"constant
    Accepts one of the following:
    WEB_SEARCH("web_search")
    JsonValue; type "server_tool_use"constant"server_tool_use"constant
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    class WebSearchToolResultBlock:
    WebSearchToolResultBlockContent content
    Accepts one of the following:
    class WebSearchToolResultError:
    ErrorCode 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<WebSearchResultBlock>
    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")
    Model model

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    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<StopReason> 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")
    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")
    Usage 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<CacheCreation> 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<ServerToolUsage> serverToolUse

    The number of server tool requests.

    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")
    JsonValue; type "succeeded"constant"succeeded"constant
    Accepts one of the following:
    SUCCEEDED("succeeded")
    class MessageBatchErroredResult:
    ErrorResponse error
    ErrorObject error
    Accepts one of the following:
    class InvalidRequestError:
    String message
    JsonValue; type "invalid_request_error"constant"invalid_request_error"constant
    Accepts one of the following:
    INVALID_REQUEST_ERROR("invalid_request_error")
    class AuthenticationError:
    String message
    JsonValue; type "authentication_error"constant"authentication_error"constant
    Accepts one of the following:
    AUTHENTICATION_ERROR("authentication_error")
    class BillingError:
    String message
    JsonValue; type "billing_error"constant"billing_error"constant
    Accepts one of the following:
    BILLING_ERROR("billing_error")
    class PermissionError:
    String message
    JsonValue; type "permission_error"constant"permission_error"constant
    Accepts one of the following:
    PERMISSION_ERROR("permission_error")
    class NotFoundError:
    String message
    JsonValue; type "not_found_error"constant"not_found_error"constant
    Accepts one of the following:
    NOT_FOUND_ERROR("not_found_error")
    class RateLimitError:
    String message
    JsonValue; type "rate_limit_error"constant"rate_limit_error"constant
    Accepts one of the following:
    RATE_LIMIT_ERROR("rate_limit_error")
    class GatewayTimeoutError:
    String message
    JsonValue; type "timeout_error"constant"timeout_error"constant
    Accepts one of the following:
    TIMEOUT_ERROR("timeout_error")
    class ApiErrorObject:
    String message
    JsonValue; type "api_error"constant"api_error"constant
    Accepts one of the following:
    API_ERROR("api_error")
    class OverloadedError:
    String message
    JsonValue; type "overloaded_error"constant"overloaded_error"constant
    Accepts one of the following:
    OVERLOADED_ERROR("overloaded_error")
    Optional<String> requestId
    JsonValue; type "error"constant"error"constant
    Accepts one of the following:
    ERROR("error")
    JsonValue; type "errored"constant"errored"constant
    Accepts one of the following:
    ERRORED("errored")
    class MessageBatchCanceledResult:
    JsonValue; type "canceled"constant"canceled"constant
    Accepts one of the following:
    CANCELED("canceled")
    class MessageBatchExpiredResult:
    JsonValue; type "expired"constant"expired"constant
    Accepts one of the following:
    EXPIRED("expired")
    class MessageBatchSucceededResult:
    Message message
    String id

    Unique object identifier.

    The format and length of IDs may change over time.

    List<ContentBlock> 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 TextBlock:
    Optional<List<TextCitation>> 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 CitationCharLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endCharIndex
    Optional<String> fileId
    long startCharIndex
    minimum0
    JsonValue; type "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class CitationPageLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endPageNumber
    Optional<String> fileId
    long startPageNumber
    minimum1
    JsonValue; type "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class CitationContentBlockLocation:
    String citedText
    long documentIndex
    minimum0
    Optional<String> documentTitle
    long endBlockIndex
    Optional<String> fileId
    long startBlockIndex
    minimum0
    JsonValue; type "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class CitationsWebSearchResultLocation:
    String citedText
    String encryptedIndex
    Optional<String> title
    maxLength512
    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 CitationsSearchResultLocation:
    String citedText
    long endBlockIndex
    long searchResultIndex
    minimum0
    String source
    long startBlockIndex
    minimum0
    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
    maxLength5000000
    minLength0
    JsonValue; type "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class ThinkingBlock:
    String signature
    String thinking
    JsonValue; type "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class RedactedThinkingBlock:
    String data
    JsonValue; type "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class ToolUseBlock:
    String id
    Input input
    String name
    minLength1
    JsonValue; type "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    class ServerToolUseBlock:
    String id
    Input input
    JsonValue; name "web_search"constant"web_search"constant
    Accepts one of the following:
    WEB_SEARCH("web_search")
    JsonValue; type "server_tool_use"constant"server_tool_use"constant
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    class WebSearchToolResultBlock:
    WebSearchToolResultBlockContent content
    Accepts one of the following:
    class WebSearchToolResultError:
    ErrorCode 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<WebSearchResultBlock>
    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")
    Model model

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    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<StopReason> 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")
    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")
    Usage 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<CacheCreation> 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<ServerToolUsage> serverToolUse

    The number of server tool requests.

    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")
    JsonValue; type "succeeded"constant"succeeded"constant
    Accepts one of the following:
    SUCCEEDED("succeeded")
    © 2025 ANTHROPIC PBC

    Products

    • Claude
    • Claude Code
    • Max plan
    • Team plan
    • Enterprise plan
    • Download app
    • Pricing
    • Log in

    Features

    • Claude and Slack
    • Claude in Excel

    Models

    • Opus
    • Sonnet
    • Haiku

    Solutions

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

    Claude Developer Platform

    • Overview
    • Developer docs
    • Pricing
    • Amazon Bedrock
    • Google Cloud’s Vertex AI
    • Console login

    Learn

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

    Company

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

    Help and security

    • Availability
    • Status
    • Support center

    Terms and policies

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

    Products

    • Claude
    • Claude Code
    • Max plan
    • Team plan
    • Enterprise plan
    • Download app
    • Pricing
    • Log in

    Features

    • Claude and Slack
    • Claude in Excel

    Models

    • Opus
    • Sonnet
    • Haiku

    Solutions

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

    Claude Developer Platform

    • Overview
    • Developer docs
    • Pricing
    • Amazon Bedrock
    • Google Cloud’s Vertex AI
    • Console login

    Learn

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

    Company

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

    Help and security

    • Availability
    • Status
    • Support center

    Terms and policies

    • Privacy policy
    • Responsible disclosure policy
    • Terms of service: Commercial
    • Terms of service: Consumer
    • Usage policy
    © 2025 ANTHROPIC PBC