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 Batch
    messages().batches().create(BatchCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : MessageBatch
    post/v1/messages/batches

    Send a batch of Message creation requests.

    The Message Batches API can be used to process multiple Messages API requests at once. Once a Message Batch is created, it begins processing immediately. Batches can take up to 24 hours to complete.

    Learn more about the Message Batches API in our user guide

    ParametersExpand Collapse
    params: BatchCreateParams
    requests: List<Request>

    List of requests for prompt completion. Each is an individual request to create a Message.

    customId: String

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

    Must be unique for each request within the Message Batch.

    maxLength64
    minLength1
    params: Params

    Messages API creation parameters for the individual request.

    See the Messages API reference for full documentation on available parameters.

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

    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<ContentBlockParam>
    Accepts one of the following:
    class TextBlockParam:
    text: String
    minLength1
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    cacheControl: Optional<CacheControlEphemeral>

    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<TextCitationParam>>
    Accepts one of the following:
    class CitationCharLocationParam:
    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 CitationPageLocationParam:
    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 CitationContentBlockLocationParam:
    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 CitationWebSearchResultLocationParam:
    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 CitationSearchResultLocationParam:
    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 ImageBlockParam:
    source: Source
    Accepts one of the following:
    class Base64ImageSource:
    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 UrlImageSource:
    type: JsonValue; "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    url: String
    type: JsonValue; "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    cacheControl: Optional<CacheControlEphemeral>

    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 DocumentBlockParam:
    source: Source
    Accepts one of the following:
    class Base64PdfSource:
    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 PlainTextSource:
    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 ContentBlockSource:
    content: Content
    Accepts one of the following:
    String
    List<ContentBlockSourceContent>
    Accepts one of the following:
    class TextBlockParam:
    text: String
    minLength1
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    cacheControl: Optional<CacheControlEphemeral>

    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<TextCitationParam>>
    Accepts one of the following:
    class CitationCharLocationParam:
    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 CitationPageLocationParam:
    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 CitationContentBlockLocationParam:
    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 CitationWebSearchResultLocationParam:
    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 CitationSearchResultLocationParam:
    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 ImageBlockParam:
    source: Source
    Accepts one of the following:
    class Base64ImageSource:
    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 UrlImageSource:
    type: JsonValue; "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    url: String
    type: JsonValue; "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    cacheControl: Optional<CacheControlEphemeral>

    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 UrlPdfSource:
    type: JsonValue; "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    url: String
    type: JsonValue; "document"constant"document"constant
    Accepts one of the following:
    DOCUMENT("document")
    cacheControl: Optional<CacheControlEphemeral>

    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<CitationsConfigParam>
    enabled: Optional<Boolean>
    context: Optional<String>
    minLength1
    title: Optional<String>
    maxLength500
    minLength1
    class SearchResultBlockParam:
    content: List<TextBlockParam>
    text: String
    minLength1
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    cacheControl: Optional<CacheControlEphemeral>

    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<TextCitationParam>>
    Accepts one of the following:
    class CitationCharLocationParam:
    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 CitationPageLocationParam:
    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 CitationContentBlockLocationParam:
    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 CitationWebSearchResultLocationParam:
    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 CitationSearchResultLocationParam:
    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<CacheControlEphemeral>

    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<CitationsConfigParam>
    enabled: Optional<Boolean>
    class ThinkingBlockParam:
    signature: String
    thinking: String
    type: JsonValue; "thinking"constant"thinking"constant
    Accepts one of the following:
    THINKING("thinking")
    class RedactedThinkingBlockParam:
    data: String
    type: JsonValue; "redacted_thinking"constant"redacted_thinking"constant
    Accepts one of the following:
    REDACTED_THINKING("redacted_thinking")
    class ToolUseBlockParam:
    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<CacheControlEphemeral>

    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 ToolResultBlockParam:
    toolUseId: String
    type: JsonValue; "tool_result"constant"tool_result"constant
    Accepts one of the following:
    TOOL_RESULT("tool_result")
    cacheControl: Optional<CacheControlEphemeral>

    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 TextBlockParam:
    text: String
    minLength1
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    cacheControl: Optional<CacheControlEphemeral>

    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<TextCitationParam>>
    Accepts one of the following:
    class CitationCharLocationParam:
    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 CitationPageLocationParam:
    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 CitationContentBlockLocationParam:
    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 CitationWebSearchResultLocationParam:
    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 CitationSearchResultLocationParam:
    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 ImageBlockParam:
    source: Source
    Accepts one of the following:
    class Base64ImageSource:
    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 UrlImageSource:
    type: JsonValue; "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    url: String
    type: JsonValue; "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    cacheControl: Optional<CacheControlEphemeral>

    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 SearchResultBlockParam:
    content: List<TextBlockParam>
    text: String
    minLength1
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    cacheControl: Optional<CacheControlEphemeral>

    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<TextCitationParam>>
    Accepts one of the following:
    class CitationCharLocationParam:
    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 CitationPageLocationParam:
    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 CitationContentBlockLocationParam:
    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 CitationWebSearchResultLocationParam:
    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 CitationSearchResultLocationParam:
    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<CacheControlEphemeral>

    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<CitationsConfigParam>
    enabled: Optional<Boolean>
    class DocumentBlockParam:
    source: Source
    Accepts one of the following:
    class Base64PdfSource:
    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 PlainTextSource:
    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 ContentBlockSource:
    content: Content
    Accepts one of the following:
    String
    List<ContentBlockSourceContent>
    Accepts one of the following:
    class TextBlockParam:
    text: String
    minLength1
    type: JsonValue; "text"constant"text"constant
    Accepts one of the following:
    TEXT("text")
    cacheControl: Optional<CacheControlEphemeral>

    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<TextCitationParam>>
    Accepts one of the following:
    class CitationCharLocationParam:
    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 CitationPageLocationParam:
    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 CitationContentBlockLocationParam:
    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 CitationWebSearchResultLocationParam:
    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 CitationSearchResultLocationParam:
    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 ImageBlockParam:
    source: Source
    Accepts one of the following:
    class Base64ImageSource:
    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 UrlImageSource:
    type: JsonValue; "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    url: String
    type: JsonValue; "image"constant"image"constant
    Accepts one of the following:
    IMAGE("image")
    cacheControl: Optional<CacheControlEphemeral>

    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 UrlPdfSource:
    type: JsonValue; "url"constant"url"constant
    Accepts one of the following:
    URL("url")
    url: String
    type: JsonValue; "document"constant"document"constant
    Accepts one of the following:
    DOCUMENT("document")
    cacheControl: Optional<CacheControlEphemeral>

    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<CitationsConfigParam>
    enabled: Optional<Boolean>
    context: Optional<String>
    minLength1
    title: Optional<String>
    maxLength500
    minLength1
    isError: Optional<Boolean>
    class ServerToolUseBlockParam:
    id: String
    input: Input
    name: JsonValue; "web_search"constant"web_search"constant
    Accepts one of the following:
    WEB_SEARCH("web_search")
    type: JsonValue; "server_tool_use"constant"server_tool_use"constant
    Accepts one of the following:
    SERVER_TOOL_USE("server_tool_use")
    cacheControl: Optional<CacheControlEphemeral>

    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 WebSearchToolResultBlockParam:
    content: WebSearchToolResultBlockParamContent
    Accepts one of the following:
    List<WebSearchResultBlockParam>
    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 WebSearchToolRequestError:
    errorCode: ErrorCode
    Accepts one of the following:
    INVALID_TOOL_INPUT("invalid_tool_input")
    UNAVAILABLE("unavailable")
    MAX_USES_EXCEEDED("max_uses_exceeded")
    TOO_MANY_REQUESTS("too_many_requests")
    QUERY_TOO_LONG("query_too_long")
    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<CacheControlEphemeral>

    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.

    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

    metadata: Optional<Metadata>

    An object describing metadata about the request.

    userId: Optional<String>

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

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

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

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

    stream: Optional<Boolean>

    Whether to incrementally stream the response using server-sent events.

    See streaming for details.

    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.

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

    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<TextCitationParam>>
    Accepts one of the following:
    class CitationCharLocationParam:
    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 CitationPageLocationParam:
    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 CitationContentBlockLocationParam:
    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 CitationWebSearchResultLocationParam:
    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 CitationSearchResultLocationParam:
    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<ThinkingConfigParam>

    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.

    Accepts one of the following:
    class ThinkingConfigEnabled:
    budgetTokens: Long

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

    Must be ≥1024 and less than max_tokens.

    See extended thinking for details.

    minimum1024
    type: JsonValue; "enabled"constant"enabled"constant
    Accepts one of the following:
    ENABLED("enabled")
    class ThinkingConfigDisabled:
    type: JsonValue; "disabled"constant"disabled"constant
    Accepts one of the following:
    DISABLED("disabled")
    toolChoice: Optional<ToolChoice>

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

    Accepts one of the following:
    class ToolChoiceAuto:

    The model will automatically decide whether to use tools.

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

    Whether to disable parallel tool use.

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

    class ToolChoiceAny:

    The model will use any available tools.

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

    Whether to disable parallel tool use.

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

    class ToolChoiceTool:

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

    name: String

    The name of the tool to use.

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

    Whether to disable parallel tool use.

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

    class ToolChoiceNone:

    The model will not be allowed to use tools.

    type: JsonValue; "none"constant"none"constant
    Accepts one of the following:
    NONE("none")
    tools: Optional<List<ToolUnion>>

    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.

    Accepts one of the following:
    class Tool:
    inputSchema: InputSchema

    JSON schema for this tool's input.

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

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

    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 ToolBash20250124:
    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<CacheControlEphemeral>

    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 ToolTextEditor20250124:
    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<CacheControlEphemeral>

    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 ToolTextEditor20250429:
    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<CacheControlEphemeral>

    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 ToolTextEditor20250728:
    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<CacheControlEphemeral>

    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 WebSearchTool20250305:
    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<CacheControlEphemeral>

    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
    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 MessageBatch:
    id: String

    Unique object identifier.

    The format and length of IDs may change over time.

    archivedAt: Optional<LocalDateTime>

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

    formatdate-time
    cancelInitiatedAt: Optional<LocalDateTime>

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

    formatdate-time
    createdAt: LocalDateTime

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

    formatdate-time
    endedAt: Optional<LocalDateTime>

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

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

    formatdate-time
    expiresAt: LocalDateTime

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

    formatdate-time
    processingStatus: ProcessingStatus

    Processing status of the Message Batch.

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

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

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

    canceled: Long

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

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

    errored: Long

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

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

    expired: Long

    Number of requests in the Message Batch that have expired.

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

    processing: Long

    Number of requests in the Message Batch that are processing.

    succeeded: Long

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

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

    resultsUrl: Optional<String>

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

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

    type: JsonValue; "message_batch"constant"message_batch"constant

    Object type.

    For Message Batches, this is always "message_batch".

    Accepts one of the following:
    MESSAGE_BATCH("message_batch")
    Create a Message Batch
    Kotlin
    package com.anthropic.example
    
    import com.anthropic.client.AnthropicClient
    import com.anthropic.client.okhttp.AnthropicOkHttpClient
    import com.anthropic.models.messages.Model
    import com.anthropic.models.messages.batches.BatchCreateParams
    import com.anthropic.models.messages.batches.MessageBatch
    
    fun main() {
        val client: AnthropicClient = AnthropicOkHttpClient.fromEnv()
    
        val params: BatchCreateParams = BatchCreateParams.builder()
            .addRequest(BatchCreateParams.Request.builder()
                .customId("my-custom-id-1")
                .params(BatchCreateParams.Request.Params.builder()
                    .maxTokens(1024L)
                    .addUserMessage("Hello, world")
                    .model(Model.CLAUDE_3_7_SONNET_LATEST)
                    .build())
                .build())
            .build()
        val messageBatch: MessageBatch = client.messages().batches().create(params)
    }
    {
      "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
      "archived_at": "2024-08-20T18:37:24.100435Z",
      "cancel_initiated_at": "2024-08-20T18:37:24.100435Z",
      "created_at": "2024-08-20T18:37:24.100435Z",
      "ended_at": "2024-08-20T18:37:24.100435Z",
      "expires_at": "2024-08-20T18:37:24.100435Z",
      "processing_status": "in_progress",
      "request_counts": {
        "canceled": 10,
        "errored": 30,
        "expired": 10,
        "processing": 100,
        "succeeded": 50
      },
      "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",
      "type": "message_batch"
    }
    Returns Examples
    {
      "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
      "archived_at": "2024-08-20T18:37:24.100435Z",
      "cancel_initiated_at": "2024-08-20T18:37:24.100435Z",
      "created_at": "2024-08-20T18:37:24.100435Z",
      "ended_at": "2024-08-20T18:37:24.100435Z",
      "expires_at": "2024-08-20T18:37:24.100435Z",
      "processing_status": "in_progress",
      "request_counts": {
        "canceled": 10,
        "errored": 30,
        "expired": 10,
        "processing": 100,
        "succeeded": 50
      },
      "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",
      "type": "message_batch"
    }
    © 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