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
    Create a Message
    beta().messages().create(MessageCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : BetaMessage
    post/v1/messages?beta=true

    Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation.

    The Messages API can be used for either single queries or stateless multi-turn conversations.

    Learn more about the Messages API in our user guide

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

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

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

    The maximum number of tokens to generate before stopping.

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

    Different models have different maximum values for this parameter. See models for details.

    minimum1
    messages: List<BetaMessageParam>

    Input messages.

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

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

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

    Example with a single user message:

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

    Example with multiple conversational turns:

    [
      {"role": "user", "content": "Hello there."},
      {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"},
      {"role": "user", "content": "Can you explain LLMs in plain English?"},
    ]
    

    Example with a partially-filled response from Claude:

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

    Each input message content may be either a single string or an array of content blocks, where each block has a specific type. Using a string for content is shorthand for an array of one content block of type "text". The following input messages are equivalent:

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

    See input examples.

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

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

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Fetched content URL

    retrievedAt: Optional<String>

    ISO 8601 timestamp when the content was retrieved

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    The name of the MCP server

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    The model that will complete your prompt.

    See models for additional details and options.

    container: Optional<Container>

    Container identifier for reuse across requests.

    class BetaContainerParams:

    Container parameters with skills to be loaded.

    id: Optional<String>

    Container id

    skills: Optional<List<BetaSkillParams>>

    List of skills to load in the container

    skillId: String

    Skill ID

    maxLength64
    minLength1
    type: Type

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

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

    Skill version or 'latest' for most recent version

    maxLength64
    minLength1
    String
    contextManagement: Optional<BetaContextManagementConfig>

    Context management configuration.

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

    mcpServers: Optional<List<BetaRequestMcpServerUrlDefinition>>

    MCP servers to be utilized in this request

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

    An object describing metadata about the request.

    serviceTier: Optional<ServiceTier>

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

    Anthropic offers different levels of service for your API requests. See service-tiers for details.

    AUTO("auto")
    STANDARD_ONLY("standard_only")
    stopSequences: Optional<List<String>>

    Custom text sequences that will cause the model to stop generating.

    Our models will normally stop when they have naturally completed their turn, which will result in a response stop_reason of "end_turn".

    If you want the model to stop generating when it encounters custom strings of text, you can use the stop_sequences parameter. If the model encounters one of the custom sequences, the response stop_reason value will be "stop_sequence" and the response stop_sequence value will contain the matched stop sequence.

    system: Optional<System>

    System prompt.

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

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Amount of randomness injected into the response.

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

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

    maximum1
    minimum0
    thinking: Optional<BetaThinkingConfigParam>

    Configuration for enabling Claude's extended thinking.

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

    See extended thinking for details.

    toolChoice: Optional<BetaToolChoice>

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

    tools: Optional<List<BetaToolUnion>>

    Definitions of tools that the model may use.

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

    There are two types of tools: client tools and server tools. The behavior described below applies to client tools. For server tools, see their individual documentation as each has its own behavior (e.g., the web search tool).

    Each tool definition includes:

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

    For example, if you defined tools as:

    [
      {
        "name": "get_stock_price",
        "description": "Get the current stock price for a given ticker symbol.",
        "input_schema": {
          "type": "object",
          "properties": {
            "ticker": {
              "type": "string",
              "description": "The stock ticker symbol, e.g. AAPL for Apple Inc."
            }
          },
          "required": ["ticker"]
        }
      }
    ]
    

    And then asked the model "What's the S&P 500 at today?", the model might produce tool_use content blocks in the response like this:

    [
      {
        "type": "tool_use",
        "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
        "name": "get_stock_price",
        "input": { "ticker": "^GSPC" }
      }
    ]
    

    You might then run your get_stock_price tool with {"ticker": "^GSPC"} as an input, and return the following back to the model in a subsequent user message:

    [
      {
        "type": "tool_result",
        "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
        "content": "259.75 USD"
      }
    ]
    

    Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.

    See our guide for more details.

    class BetaTool:
    inputSchema: InputSchema

    JSON schema for this tool's input.

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

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

    Name of the tool.

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

    maxLength128
    minLength1
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    Description of what this tool does.

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

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

    Name of the tool.

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

    Accepts one of the following:
    BASH("bash")
    type: JsonValue; "bash_20241022"constant"bash_20241022"constant
    Accepts one of the following:
    BASH_20241022("bash_20241022")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaToolBash20250124:
    name: JsonValue; "bash"constant"bash"constant

    Name of the tool.

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

    Accepts one of the following:
    BASH("bash")
    type: JsonValue; "bash_20250124"constant"bash_20250124"constant
    Accepts one of the following:
    BASH_20250124("bash_20250124")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaCodeExecutionTool20250522:
    name: JsonValue; "code_execution"constant"code_execution"constant

    Name of the tool.

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

    Accepts one of the following:
    CODE_EXECUTION("code_execution")
    type: JsonValue; "code_execution_20250522"constant"code_execution_20250522"constant
    Accepts one of the following:
    CODE_EXECUTION_20250522("code_execution_20250522")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaCodeExecutionTool20250825:
    name: JsonValue; "code_execution"constant"code_execution"constant

    Name of the tool.

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

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

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    The height of the display in pixels.

    minimum1
    displayWidthPx: Long

    The width of the display in pixels.

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

    Name of the tool.

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

    Accepts one of the following:
    COMPUTER("computer")
    type: JsonValue; "computer_20241022"constant"computer_20241022"constant
    Accepts one of the following:
    COMPUTER_20241022("computer_20241022")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

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

    Name of the tool.

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

    Accepts one of the following:
    MEMORY("memory")
    type: JsonValue; "memory_20250818"constant"memory_20250818"constant
    Accepts one of the following:
    MEMORY_20250818("memory_20250818")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

    The height of the display in pixels.

    minimum1
    displayWidthPx: Long

    The width of the display in pixels.

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

    Name of the tool.

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

    Accepts one of the following:
    COMPUTER("computer")
    type: JsonValue; "computer_20250124"constant"computer_20250124"constant
    Accepts one of the following:
    COMPUTER_20250124("computer_20250124")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    minimum0
    class BetaToolTextEditor20241022:
    name: JsonValue; "str_replace_editor"constant"str_replace_editor"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_EDITOR("str_replace_editor")
    type: JsonValue; "text_editor_20241022"constant"text_editor_20241022"constant
    Accepts one of the following:
    TEXT_EDITOR_20241022("text_editor_20241022")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaToolTextEditor20250124:
    name: JsonValue; "str_replace_editor"constant"str_replace_editor"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_EDITOR("str_replace_editor")
    type: JsonValue; "text_editor_20250124"constant"text_editor_20250124"constant
    Accepts one of the following:
    TEXT_EDITOR_20250124("text_editor_20250124")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaToolTextEditor20250429:
    name: JsonValue; "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_BASED_EDIT_TOOL("str_replace_based_edit_tool")
    type: JsonValue; "text_editor_20250429"constant"text_editor_20250429"constant
    Accepts one of the following:
    TEXT_EDITOR_20250429("text_editor_20250429")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    TTL_5M("5m")
    TTL_1H("1h")
    class BetaToolTextEditor20250728:
    name: JsonValue; "str_replace_based_edit_tool"constant"str_replace_based_edit_tool"constant

    Name of the tool.

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

    Accepts one of the following:
    STR_REPLACE_BASED_EDIT_TOOL("str_replace_based_edit_tool")
    type: JsonValue; "text_editor_20250728"constant"text_editor_20250728"constant
    Accepts one of the following:
    TEXT_EDITOR_20250728("text_editor_20250728")
    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

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

    Name of the tool.

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

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

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

    blockedDomains: Optional<List<String>>

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

    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    exclusiveMinimum0
    userLocation: Optional<UserLocation>

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

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

    The city of the user.

    maxLength255
    minLength1
    country: Optional<String>

    The two letter ISO country code of the user.

    maxLength2
    minLength2
    region: Optional<String>

    The region of the user.

    maxLength255
    minLength1
    timezone: Optional<String>

    The IANA timezone of the user.

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

    Name of the tool.

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

    Accepts one of the following:
    WEB_FETCH("web_fetch")
    type: JsonValue; "web_fetch_20250910"constant"web_fetch_20250910"constant
    Accepts one of the following:
    WEB_FETCH_20250910("web_fetch_20250910")
    allowedDomains: Optional<List<String>>

    List of domains to allow fetching from

    blockedDomains: Optional<List<String>>

    List of domains to block fetching from

    cacheControl: Optional<BetaCacheControlEphemeral>

    Create a cache control breakpoint at this content block.

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

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

    This may be one the following values:

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

    Defaults to 5m.

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

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

    enabled: Optional<Boolean>
    maxContentTokens: Optional<Long>

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

    exclusiveMinimum0
    maxUses: Optional<Long>

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

    exclusiveMinimum0
    topK: Optional<Long>

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

    Used to remove "long tail" low probability responses. Learn more technical details here.

    Recommended for advanced use cases only. You usually only need to use temperature.

    minimum0
    topP: Optional<Double>

    Use nucleus sampling.

    In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by top_p. You should either alter temperature or top_p, but not both.

    Recommended for advanced use cases only. You usually only need to use temperature.

    maximum1
    minimum0
    ReturnsExpand Collapse
    class BetaMessage:
    id: String

    Unique object identifier.

    The format and length of IDs may change over time.

    container: Optional<BetaContainer>

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

    id: String

    Identifier for the container used in this request

    expiresAt: LocalDateTime

    The time at which the container will expire.

    formatdate-time
    skills: Optional<List<BetaSkill>>

    Skills loaded in the container

    skillId: String

    Skill ID

    maxLength64
    minLength1
    type: Type

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

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

    Skill version or 'latest' for most recent version

    maxLength64
    minLength1
    content: List<BetaContentBlock>

    Content generated by the model.

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

    Example:

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

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

    For example, if the input messages were:

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

    Then the response content might be:

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

    Citations supporting the text block.

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

    Accepts one of the following:
    class BetaCitationCharLocation:
    citedText: String
    documentIndex: Long
    minimum0
    documentTitle: Optional<String>
    endCharIndex: Long
    fileId: Optional<String>
    startCharIndex: Long
    minimum0
    type: JsonValue; "char_location"constant"char_location"constant
    Accepts one of the following:
    CHAR_LOCATION("char_location")
    class BetaCitationPageLocation:
    citedText: String
    documentIndex: Long
    minimum0
    documentTitle: Optional<String>
    endPageNumber: Long
    fileId: Optional<String>
    startPageNumber: Long
    minimum1
    type: JsonValue; "page_location"constant"page_location"constant
    Accepts one of the following:
    PAGE_LOCATION("page_location")
    class BetaCitationContentBlockLocation:
    citedText: String
    documentIndex: Long
    minimum0
    documentTitle: Optional<String>
    endBlockIndex: Long
    fileId: Optional<String>
    startBlockIndex: Long
    minimum0
    type: JsonValue; "content_block_location"constant"content_block_location"constant
    Accepts one of the following:
    CONTENT_BLOCK_LOCATION("content_block_location")
    class BetaCitationsWebSearchResultLocation:
    citedText: String
    encryptedIndex: String
    title: Optional<String>
    maxLength512
    type: JsonValue; "web_search_result_location"constant"web_search_result_location"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT_LOCATION("web_search_result_location")
    url: String
    class BetaCitationSearchResultLocation:
    citedText: String
    endBlockIndex: Long
    searchResultIndex: Long
    minimum0
    source: String
    startBlockIndex: Long
    minimum0
    title: Optional<String>
    type: JsonValue; "search_result_location"constant"search_result_location"constant
    Accepts one of the following:
    SEARCH_RESULT_LOCATION("search_result_location")
    text: String
    maxLength5000000
    minLength0
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    class BetaThinkingBlock:
    signature: String
    thinking: String
    type: JsonValue; "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class BetaRedactedThinkingBlock:
    data: String
    type: JsonValue; "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class BetaToolUseBlock:
    id: String
    input: Input
    name: String
    minLength1
    type: JsonValue; "tool_use"constant"tool_use"constant
    Accepts one of the following:
    TOOL_USE("tool_use")
    class BetaServerToolUseBlock:
    id: String
    input: Input
    name: Name
    Accepts one of the following:
    WEB_SEARCH("web_search")
    WEB_FETCH("web_fetch")
    CODE_EXECUTION("code_execution")
    BASH_CODE_EXECUTION("bash_code_execution")
    TEXT_EDITOR_CODE_EXECUTION("text_editor_code_execution")
    type: JsonValue; "server_tool_use"constant"server_tool_use"constant
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    class BetaWebSearchToolResultBlock:
    content: BetaWebSearchToolResultBlockContent
    Accepts one of the following:
    class BetaWebSearchToolResultError:
    errorCode: BetaWebSearchToolResultErrorCode
    Accepts one of the following:
    INVALID_TOOL_INPUT("invalid_tool_input")
    UNAVAILABLE("unavailable")
    MAX_USES_EXCEEDED("max_uses_exceeded")
    TOO_MANY_REQUESTS("too_many_requests")
    QUERY_TOO_LONG("query_too_long")
    type: JsonValue; "web_search_tool_result_error"constant"web_search_tool_result_error"constant
    Accepts one of the following:
    WEB_SEARCH_TOOL_RESULT_ERROR("web_search_tool_result_error")
    List<BetaWebSearchResultBlock>
    encryptedContent: String
    pageAge: Optional<String>
    title: String
    type: JsonValue; "web_search_result"constant"web_search_result"constant
    Accepts one of the following:
    WEB_SEARCH_RESULT("web_search_result")
    url: String
    toolUseId: String
    type: JsonValue; "web_search_tool_result"constant"web_search_tool_result"constant
    Accepts one of the following:
    WEB_SEARCH_TOOL_RESULT("web_search_tool_result")
    class BetaWebFetchToolResultBlock:
    content: Content
    Accepts one of the following:
    class BetaWebFetchToolResultErrorBlock:
    errorCode: BetaWebFetchToolResultErrorCode
    Accepts one of the following:
    INVALID_TOOL_INPUT("invalid_tool_input")
    URL_TOO_LONG("url_too_long")
    URL_NOT_ALLOWED("url_not_allowed")
    URL_NOT_ACCESSIBLE("url_not_accessible")
    UNSUPPORTED_CONTENT_TYPE("unsupported_content_type")
    TOO_MANY_REQUESTS("too_many_requests")
    MAX_USES_EXCEEDED("max_uses_exceeded")
    UNAVAILABLE("unavailable")
    type: JsonValue; "web_fetch_tool_result_error"constant"web_fetch_tool_result_error"constant
    Accepts one of the following:
    WEB_FETCH_TOOL_RESULT_ERROR("web_fetch_tool_result_error")
    class BetaWebFetchBlock:
    content: BetaDocumentBlock
    citations: Optional<BetaCitationConfig>

    Citation configuration for the document

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

    The title of the document

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

    ISO 8601 timestamp when the content was retrieved

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

    Fetched content URL

    toolUseId: String
    type: JsonValue; "web_fetch_tool_result"constant"web_fetch_tool_result"constant
    Accepts one of the following:
    WEB_FETCH_TOOL_RESULT("web_fetch_tool_result")
    class BetaCodeExecutionToolResultBlock:
    content: BetaCodeExecutionToolResultBlockContent
    Accepts one of the following:
    class BetaCodeExecutionToolResultError:
    errorCode: BetaCodeExecutionToolResultErrorCode
    Accepts one of the following:
    INVALID_TOOL_INPUT("invalid_tool_input")
    UNAVAILABLE("unavailable")
    TOO_MANY_REQUESTS("too_many_requests")
    EXECUTION_TIME_EXCEEDED("execution_time_exceeded")
    type: JsonValue; "code_execution_tool_result_error"constant"code_execution_tool_result_error"constant
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT_ERROR("code_execution_tool_result_error")
    class BetaCodeExecutionResultBlock:
    content: List<BetaCodeExecutionOutputBlock>
    fileId: String
    type: JsonValue; "code_execution_output"constant"code_execution_output"constant
    Accepts one of the following:
    CODE_EXECUTION_OUTPUT("code_execution_output")
    returnCode: Long
    stderr: String
    stdout: String
    type: JsonValue; "code_execution_result"constant"code_execution_result"constant
    Accepts one of the following:
    CODE_EXECUTION_RESULT("code_execution_result")
    toolUseId: String
    type: JsonValue; "code_execution_tool_result"constant"code_execution_tool_result"constant
    Accepts one of the following:
    CODE_EXECUTION_TOOL_RESULT("code_execution_tool_result")
    class BetaBashCodeExecutionToolResultBlock:
    content: Content
    Accepts one of the following:
    class BetaBashCodeExecutionToolResultError:
    errorCode: ErrorCode
    Accepts one of the following:
    INVALID_TOOL_INPUT("invalid_tool_input")
    UNAVAILABLE("unavailable")
    TOO_MANY_REQUESTS("too_many_requests")
    EXECUTION_TIME_EXCEEDED("execution_time_exceeded")
    OUTPUT_FILE_TOO_LARGE("output_file_too_large")
    type: JsonValue; "bash_code_execution_tool_result_error"constant"bash_code_execution_tool_result_error"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_TOOL_RESULT_ERROR("bash_code_execution_tool_result_error")
    class BetaBashCodeExecutionResultBlock:
    content: List<BetaBashCodeExecutionOutputBlock>
    fileId: String
    type: JsonValue; "bash_code_execution_output"constant"bash_code_execution_output"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_OUTPUT("bash_code_execution_output")
    returnCode: Long
    stderr: String
    stdout: String
    type: JsonValue; "bash_code_execution_result"constant"bash_code_execution_result"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_RESULT("bash_code_execution_result")
    toolUseId: String
    type: JsonValue; "bash_code_execution_tool_result"constant"bash_code_execution_tool_result"constant
    Accepts one of the following:
    BASH_CODE_EXECUTION_TOOL_RESULT("bash_code_execution_tool_result")
    class BetaTextEditorCodeExecutionToolResultBlock:
    content: Content
    Accepts one of the following:
    class BetaTextEditorCodeExecutionToolResultError:
    errorCode: ErrorCode
    Accepts one of the following:
    INVALID_TOOL_INPUT("invalid_tool_input")
    UNAVAILABLE("unavailable")
    TOO_MANY_REQUESTS("too_many_requests")
    EXECUTION_TIME_EXCEEDED("execution_time_exceeded")
    FILE_NOT_FOUND("file_not_found")
    errorMessage: Optional<String>
    type: JsonValue; "text_editor_code_execution_tool_result_error"constant"text_editor_code_execution_tool_result_error"constant
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT_ERROR("text_editor_code_execution_tool_result_error")
    class BetaTextEditorCodeExecutionViewResultBlock:
    content: String
    fileType: FileType
    Accepts one of the following:
    TEXT("text")
    IMAGE("image")
    PDF("pdf")
    numLines: Optional<Long>
    startLine: Optional<Long>
    totalLines: Optional<Long>
    type: JsonValue; "text_editor_code_execution_view_result"constant"text_editor_code_execution_view_result"constant
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_VIEW_RESULT("text_editor_code_execution_view_result")
    class BetaTextEditorCodeExecutionCreateResultBlock:
    isFileUpdate: Boolean
    type: JsonValue; "text_editor_code_execution_create_result"constant"text_editor_code_execution_create_result"constant
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_CREATE_RESULT("text_editor_code_execution_create_result")
    class BetaTextEditorCodeExecutionStrReplaceResultBlock:
    lines: Optional<List<String>>
    newLines: Optional<Long>
    newStart: Optional<Long>
    oldLines: Optional<Long>
    oldStart: Optional<Long>
    type: JsonValue; "text_editor_code_execution_str_replace_result"constant"text_editor_code_execution_str_replace_result"constant
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_STR_REPLACE_RESULT("text_editor_code_execution_str_replace_result")
    toolUseId: String
    type: JsonValue; "text_editor_code_execution_tool_result"constant"text_editor_code_execution_tool_result"constant
    Accepts one of the following:
    TEXT_EDITOR_CODE_EXECUTION_TOOL_RESULT("text_editor_code_execution_tool_result")
    class BetaMcpToolUseBlock:
    id: String
    input: Input
    name: String

    The name of the MCP tool

    serverName: String

    The name of the MCP server

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

    Citations supporting the text block.

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

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

    Response model for a file uploaded to the container.

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

    Context management response.

    Information about context management strategies applied during the request.

    appliedEdits: List<AppliedEdit>

    List of context management edits that were applied.

    Accepts one of the following:
    class BetaClearToolUses20250919EditResponse:
    clearedInputTokens: Long

    Number of input tokens cleared by this edit.

    minimum0
    clearedToolUses: Long

    Number of tool uses that were cleared.

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

    The type of context management edit applied.

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

    Number of input tokens cleared by this edit.

    minimum0
    clearedThinkingTurns: Long

    Number of thinking turns that were cleared.

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

    The type of context management edit applied.

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

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    CLAUDE_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

    role: JsonValue; "assistant"constant"assistant"constant

    Conversational role of the generated message.

    This will always be "assistant".

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

    The reason that we stopped.

    This may be one the following values:

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

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

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

    Which custom stop sequence was generated, if any.

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

    type: JsonValue; "message"constant"message"constant

    Object type.

    For Messages, this is always "message".

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

    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.

    cacheCreation: Optional<BetaCacheCreation>

    Breakdown of cached tokens by TTL

    ephemeral1hInputTokens: Long

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

    minimum0
    ephemeral5mInputTokens: Long

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

    minimum0
    cacheCreationInputTokens: Optional<Long>

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

    minimum0
    cacheReadInputTokens: Optional<Long>

    The number of input tokens read from the cache.

    minimum0
    inputTokens: Long

    The number of input tokens which were used.

    minimum0
    outputTokens: Long

    The number of output tokens which were used.

    minimum0
    serverToolUse: Optional<BetaServerToolUsage>

    The number of server tool requests.

    webFetchRequests: Long

    The number of web fetch tool requests.

    minimum0
    webSearchRequests: Long

    The number of web search tool requests.

    minimum0
    serviceTier: Optional<ServiceTier>

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

    Accepts one of the following:
    STANDARD("standard")
    PRIORITY("priority")
    BATCH("batch")
    Create a Message
    Kotlin
    package com.anthropic.example
    
    import com.anthropic.client.AnthropicClient
    import com.anthropic.client.okhttp.AnthropicOkHttpClient
    import com.anthropic.models.beta.messages.BetaMessage
    import com.anthropic.models.beta.messages.MessageCreateParams
    import com.anthropic.models.messages.Model
    
    fun main() {
        val client: AnthropicClient = AnthropicOkHttpClient.fromEnv()
    
        val params: MessageCreateParams = MessageCreateParams.builder()
            .maxTokens(1024L)
            .addUserMessage("Hello, world")
            .model(Model.CLAUDE_3_7_SONNET_LATEST)
            .build()
        val betaMessage: BetaMessage = client.beta().messages().create(params)
    }
    {
      "id": "msg_013Zva2CMHLNnXjNJJKqJ2EF",
      "container": {
        "id": "id",
        "expires_at": "2019-12-27T18:11:19.117Z",
        "skills": [
          {
            "skill_id": "x",
            "type": "anthropic",
            "version": "x"
          }
        ]
      },
      "content": [
        {
          "citations": [
            {
              "cited_text": "cited_text",
              "document_index": 0,
              "document_title": "document_title",
              "end_char_index": 0,
              "file_id": "file_id",
              "start_char_index": 0,
              "type": "char_location"
            }
          ],
          "text": "Hi! My name is Claude.",
          "type": "text"
        }
      ],
      "context_management": {
        "applied_edits": [
          {
            "cleared_input_tokens": 0,
            "cleared_tool_uses": 0,
            "type": "clear_tool_uses_20250919"
          }
        ]
      },
      "model": "claude-sonnet-4-5-20250929",
      "role": "assistant",
      "stop_reason": "end_turn",
      "stop_sequence": null,
      "type": "message",
      "usage": {
        "cache_creation": {
          "ephemeral_1h_input_tokens": 0,
          "ephemeral_5m_input_tokens": 0
        },
        "cache_creation_input_tokens": 2051,
        "cache_read_input_tokens": 2051,
        "input_tokens": 2095,
        "output_tokens": 503,
        "server_tool_use": {
          "web_fetch_requests": 2,
          "web_search_requests": 0
        },
        "service_tier": "standard"
      }
    }
    Returns Examples
    {
      "id": "msg_013Zva2CMHLNnXjNJJKqJ2EF",
      "container": {
        "id": "id",
        "expires_at": "2019-12-27T18:11:19.117Z",
        "skills": [
          {
            "skill_id": "x",
            "type": "anthropic",
            "version": "x"
          }
        ]
      },
      "content": [
        {
          "citations": [
            {
              "cited_text": "cited_text",
              "document_index": 0,
              "document_title": "document_title",
              "end_char_index": 0,
              "file_id": "file_id",
              "start_char_index": 0,
              "type": "char_location"
            }
          ],
          "text": "Hi! My name is Claude.",
          "type": "text"
        }
      ],
      "context_management": {
        "applied_edits": [
          {
            "cleared_input_tokens": 0,
            "cleared_tool_uses": 0,
            "type": "clear_tool_uses_20250919"
          }
        ]
      },
      "model": "claude-sonnet-4-5-20250929",
      "role": "assistant",
      "stop_reason": "end_turn",
      "stop_sequence": null,
      "type": "message",
      "usage": {
        "cache_creation": {
          "ephemeral_1h_input_tokens": 0,
          "ephemeral_5m_input_tokens": 0
        },
        "cache_creation_input_tokens": 2051,
        "cache_read_input_tokens": 2051,
        "input_tokens": 2095,
        "output_tokens": 503,
        "server_tool_use": {
          "web_fetch_requests": 2,
          "web_search_requests": 0
        },
        "service_tier": "standard"
      }
    }
    © 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