Loading...
    • Developer Guide
    • API Reference
    • MCP
    • Resources
    • Release Notes
    Search...
    ⌘K
    Using the API
    API overviewBeta headersErrors
    Messages
    Create a Message
    Count tokens in a Message
    Models
    List Models
    Get a Model
    Beta
    Admin
    Completions
    Create a Text Completion
    Support & configuration
    Rate limitsService tiersVersionsIP addressesSupported regionsOpenAI SDK compatibility
    Console
    Log in

    Count tokens in a Message

    client.messages.countTokens(MessageCountTokensParams { messages, model, cache_control, 5 more } body, RequestOptionsoptions?): MessageTokensCount { input_tokens }
    POST/v1/messages/count_tokens

    Count the number of tokens in a Message.

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

    Learn more about token counting in our user guide

    ParametersExpand Collapse
    body: MessageCountTokensParams { messages, model, cache_control, 5 more }
    messages: Array<MessageParam { content, role } >

    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: string | Array<ContentBlockParam>
    Accepts one of the following:
    string
    Array<ContentBlockParam>
    TextBlockParam { text, type, cache_control, citations }
    text: string
    type: "text"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    citations?: Array<TextCitationParam> | null
    Accepts one of the following:
    CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_char_index: number
    start_char_index: number
    type: "char_location"
    CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_page_number: number
    start_page_number: number
    type: "page_location"
    CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_block_index: number
    start_block_index: number
    type: "content_block_location"
    CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
    cited_text: string
    encrypted_index: string
    title: string | null
    type: "web_search_result_location"
    url: string
    CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
    cited_text: string
    end_block_index: number
    search_result_index: number
    source: string
    start_block_index: number
    title: string | null
    type: "search_result_location"
    ImageBlockParam { source, type, cache_control }
    source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }
    Accepts one of the following:
    Base64ImageSource { data, media_type, type }
    data: string
    media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: "base64"
    URLImageSource { type, url }
    type: "url"
    url: string
    type: "image"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    DocumentBlockParam { source, type, cache_control, 3 more }
    source: Base64PDFSource { data, media_type, type } | PlainTextSource { data, media_type, type } | ContentBlockSource { content, type } | URLPDFSource { type, url }
    Accepts one of the following:
    Base64PDFSource { data, media_type, type }
    data: string
    media_type: "application/pdf"
    type: "base64"
    PlainTextSource { data, media_type, type }
    data: string
    media_type: "text/plain"
    type: "text"
    ContentBlockSource { content, type }
    content: string | Array<ContentBlockSourceContent>
    Accepts one of the following:
    string
    Array<ContentBlockSourceContent>
    TextBlockParam { text, type, cache_control, citations }
    text: string
    type: "text"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    citations?: Array<TextCitationParam> | null
    Accepts one of the following:
    CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_char_index: number
    start_char_index: number
    type: "char_location"
    CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_page_number: number
    start_page_number: number
    type: "page_location"
    CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_block_index: number
    start_block_index: number
    type: "content_block_location"
    CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
    cited_text: string
    encrypted_index: string
    title: string | null
    type: "web_search_result_location"
    url: string
    CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
    cited_text: string
    end_block_index: number
    search_result_index: number
    source: string
    start_block_index: number
    title: string | null
    type: "search_result_location"
    ImageBlockParam { source, type, cache_control }
    source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }
    Accepts one of the following:
    Base64ImageSource { data, media_type, type }
    data: string
    media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: "base64"
    URLImageSource { type, url }
    type: "url"
    url: string
    type: "image"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    type: "content"
    URLPDFSource { type, url }
    type: "url"
    url: string
    type: "document"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    citations?: CitationsConfigParam { enabled } | null
    enabled?: boolean
    context?: string | null
    title?: string | null
    SearchResultBlockParam { content, source, title, 3 more }
    content: Array<TextBlockParam { text, type, cache_control, citations } >
    text: string
    type: "text"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    citations?: Array<TextCitationParam> | null
    Accepts one of the following:
    CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_char_index: number
    start_char_index: number
    type: "char_location"
    CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_page_number: number
    start_page_number: number
    type: "page_location"
    CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_block_index: number
    start_block_index: number
    type: "content_block_location"
    CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
    cited_text: string
    encrypted_index: string
    title: string | null
    type: "web_search_result_location"
    url: string
    CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
    cited_text: string
    end_block_index: number
    search_result_index: number
    source: string
    start_block_index: number
    title: string | null
    type: "search_result_location"
    source: string
    title: string
    type: "search_result"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    citations?: CitationsConfigParam { enabled }
    enabled?: boolean
    ThinkingBlockParam { signature, thinking, type }
    signature: string
    thinking: string
    type: "thinking"
    RedactedThinkingBlockParam { data, type }
    data: string
    type: "redacted_thinking"
    ToolUseBlockParam { id, input, name, 3 more }
    id: string
    input: Record<string, unknown>
    name: string
    type: "tool_use"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    caller?: DirectCaller { type } | ServerToolCaller { tool_id, type } | ServerToolCaller20260120 { tool_id, type }

    Tool invocation directly from the model.

    Accepts one of the following:
    DirectCaller { type }

    Tool invocation directly from the model.

    type: "direct"
    ServerToolCaller { tool_id, type }

    Tool invocation generated by a server-side tool.

    tool_id: string
    type: "code_execution_20250825"
    ServerToolCaller20260120 { tool_id, type }
    tool_id: string
    type: "code_execution_20260120"
    ToolResultBlockParam { tool_use_id, type, cache_control, 2 more }
    tool_use_id: string
    type: "tool_result"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    content?: string | Array<TextBlockParam { text, type, cache_control, citations } | ImageBlockParam { source, type, cache_control } | SearchResultBlockParam { content, source, title, 3 more } | 2 more>
    Accepts one of the following:
    string
    Array<TextBlockParam { text, type, cache_control, citations } | ImageBlockParam { source, type, cache_control } | SearchResultBlockParam { content, source, title, 3 more } | 2 more>
    TextBlockParam { text, type, cache_control, citations }
    text: string
    type: "text"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    citations?: Array<TextCitationParam> | null
    Accepts one of the following:
    CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_char_index: number
    start_char_index: number
    type: "char_location"
    CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_page_number: number
    start_page_number: number
    type: "page_location"
    CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_block_index: number
    start_block_index: number
    type: "content_block_location"
    CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
    cited_text: string
    encrypted_index: string
    title: string | null
    type: "web_search_result_location"
    url: string
    CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
    cited_text: string
    end_block_index: number
    search_result_index: number
    source: string
    start_block_index: number
    title: string | null
    type: "search_result_location"
    ImageBlockParam { source, type, cache_control }
    source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }
    Accepts one of the following:
    Base64ImageSource { data, media_type, type }
    data: string
    media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: "base64"
    URLImageSource { type, url }
    type: "url"
    url: string
    type: "image"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    SearchResultBlockParam { content, source, title, 3 more }
    content: Array<TextBlockParam { text, type, cache_control, citations } >
    text: string
    type: "text"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    citations?: Array<TextCitationParam> | null
    Accepts one of the following:
    CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_char_index: number
    start_char_index: number
    type: "char_location"
    CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_page_number: number
    start_page_number: number
    type: "page_location"
    CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_block_index: number
    start_block_index: number
    type: "content_block_location"
    CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
    cited_text: string
    encrypted_index: string
    title: string | null
    type: "web_search_result_location"
    url: string
    CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
    cited_text: string
    end_block_index: number
    search_result_index: number
    source: string
    start_block_index: number
    title: string | null
    type: "search_result_location"
    source: string
    title: string
    type: "search_result"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    citations?: CitationsConfigParam { enabled }
    enabled?: boolean
    DocumentBlockParam { source, type, cache_control, 3 more }
    source: Base64PDFSource { data, media_type, type } | PlainTextSource { data, media_type, type } | ContentBlockSource { content, type } | URLPDFSource { type, url }
    Accepts one of the following:
    Base64PDFSource { data, media_type, type }
    data: string
    media_type: "application/pdf"
    type: "base64"
    PlainTextSource { data, media_type, type }
    data: string
    media_type: "text/plain"
    type: "text"
    ContentBlockSource { content, type }
    content: string | Array<ContentBlockSourceContent>
    Accepts one of the following:
    string
    Array<ContentBlockSourceContent>
    TextBlockParam { text, type, cache_control, citations }
    text: string
    type: "text"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    citations?: Array<TextCitationParam> | null
    Accepts one of the following:
    CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_char_index: number
    start_char_index: number
    type: "char_location"
    CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_page_number: number
    start_page_number: number
    type: "page_location"
    CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_block_index: number
    start_block_index: number
    type: "content_block_location"
    CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
    cited_text: string
    encrypted_index: string
    title: string | null
    type: "web_search_result_location"
    url: string
    CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
    cited_text: string
    end_block_index: number
    search_result_index: number
    source: string
    start_block_index: number
    title: string | null
    type: "search_result_location"
    ImageBlockParam { source, type, cache_control }
    source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }
    Accepts one of the following:
    Base64ImageSource { data, media_type, type }
    data: string
    media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: "base64"
    URLImageSource { type, url }
    type: "url"
    url: string
    type: "image"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    type: "content"
    URLPDFSource { type, url }
    type: "url"
    url: string
    type: "document"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    citations?: CitationsConfigParam { enabled } | null
    enabled?: boolean
    context?: string | null
    title?: string | null
    ToolReferenceBlockParam { tool_name, type, cache_control }

    Tool reference block that can be included in tool_result content.

    tool_name: string
    type: "tool_reference"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    is_error?: boolean
    ServerToolUseBlockParam { id, input, name, 3 more }
    id: string
    input: Record<string, unknown>
    name: "web_search" | "web_fetch" | "code_execution" | 4 more
    Accepts one of the following:
    "web_search"
    "web_fetch"
    "code_execution"
    "bash_code_execution"
    "text_editor_code_execution"
    "tool_search_tool_regex"
    "tool_search_tool_bm25"
    type: "server_tool_use"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    caller?: DirectCaller { type } | ServerToolCaller { tool_id, type } | ServerToolCaller20260120 { tool_id, type }

    Tool invocation directly from the model.

    Accepts one of the following:
    DirectCaller { type }

    Tool invocation directly from the model.

    type: "direct"
    ServerToolCaller { tool_id, type }

    Tool invocation generated by a server-side tool.

    tool_id: string
    type: "code_execution_20250825"
    ServerToolCaller20260120 { tool_id, type }
    tool_id: string
    type: "code_execution_20260120"
    WebSearchToolResultBlockParam { content, tool_use_id, type, 2 more }
    content: WebSearchToolResultBlockParamContent
    Accepts one of the following:
    Array<WebSearchResultBlockParam { encrypted_content, title, type, 2 more } >
    encrypted_content: string
    title: string
    type: "web_search_result"
    url: string
    page_age?: string | null
    WebSearchToolRequestError { error_code, type }
    error_code: WebSearchToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    "request_too_large"
    type: "web_search_tool_result_error"
    tool_use_id: string
    type: "web_search_tool_result"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    caller?: DirectCaller { type } | ServerToolCaller { tool_id, type } | ServerToolCaller20260120 { tool_id, type }

    Tool invocation directly from the model.

    Accepts one of the following:
    DirectCaller { type }

    Tool invocation directly from the model.

    type: "direct"
    ServerToolCaller { tool_id, type }

    Tool invocation generated by a server-side tool.

    tool_id: string
    type: "code_execution_20250825"
    ServerToolCaller20260120 { tool_id, type }
    tool_id: string
    type: "code_execution_20260120"
    WebFetchToolResultBlockParam { content, tool_use_id, type, 2 more }
    content: WebFetchToolResultErrorBlockParam { error_code, type } | WebFetchBlockParam { content, type, url, retrieved_at }
    Accepts one of the following:
    WebFetchToolResultErrorBlockParam { error_code, type }
    error_code: WebFetchToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "url_too_long"
    "url_not_allowed"
    "url_not_accessible"
    "unsupported_content_type"
    "too_many_requests"
    "max_uses_exceeded"
    "unavailable"
    type: "web_fetch_tool_result_error"
    WebFetchBlockParam { content, type, url, retrieved_at }
    content: DocumentBlockParam { source, type, cache_control, 3 more }
    source: Base64PDFSource { data, media_type, type } | PlainTextSource { data, media_type, type } | ContentBlockSource { content, type } | URLPDFSource { type, url }
    Accepts one of the following:
    Base64PDFSource { data, media_type, type }
    data: string
    media_type: "application/pdf"
    type: "base64"
    PlainTextSource { data, media_type, type }
    data: string
    media_type: "text/plain"
    type: "text"
    ContentBlockSource { content, type }
    content: string | Array<ContentBlockSourceContent>
    Accepts one of the following:
    string
    Array<ContentBlockSourceContent>
    TextBlockParam { text, type, cache_control, citations }
    text: string
    type: "text"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    citations?: Array<TextCitationParam> | null
    Accepts one of the following:
    CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_char_index: number
    start_char_index: number
    type: "char_location"
    CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_page_number: number
    start_page_number: number
    type: "page_location"
    CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_block_index: number
    start_block_index: number
    type: "content_block_location"
    CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
    cited_text: string
    encrypted_index: string
    title: string | null
    type: "web_search_result_location"
    url: string
    CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
    cited_text: string
    end_block_index: number
    search_result_index: number
    source: string
    start_block_index: number
    title: string | null
    type: "search_result_location"
    ImageBlockParam { source, type, cache_control }
    source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }
    Accepts one of the following:
    Base64ImageSource { data, media_type, type }
    data: string
    media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: "base64"
    URLImageSource { type, url }
    type: "url"
    url: string
    type: "image"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    type: "content"
    URLPDFSource { type, url }
    type: "url"
    url: string
    type: "document"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    citations?: CitationsConfigParam { enabled } | null
    enabled?: boolean
    context?: string | null
    title?: string | null
    type: "web_fetch_result"
    url: string

    Fetched content URL

    retrieved_at?: string | null

    ISO 8601 timestamp when the content was retrieved

    tool_use_id: string
    type: "web_fetch_tool_result"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    caller?: DirectCaller { type } | ServerToolCaller { tool_id, type } | ServerToolCaller20260120 { tool_id, type }

    Tool invocation directly from the model.

    Accepts one of the following:
    DirectCaller { type }

    Tool invocation directly from the model.

    type: "direct"
    ServerToolCaller { tool_id, type }

    Tool invocation generated by a server-side tool.

    tool_id: string
    type: "code_execution_20250825"
    ServerToolCaller20260120 { tool_id, type }
    tool_id: string
    type: "code_execution_20260120"
    CodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
    content: CodeExecutionToolResultBlockParamContent

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

    Accepts one of the following:
    CodeExecutionToolResultErrorParam { error_code, type }
    error_code: CodeExecutionToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    type: "code_execution_tool_result_error"
    CodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
    content: Array<CodeExecutionOutputBlockParam { file_id, type } >
    file_id: string
    type: "code_execution_output"
    return_code: number
    stderr: string
    stdout: string
    type: "code_execution_result"
    EncryptedCodeExecutionResultBlockParam { content, encrypted_stdout, return_code, 2 more }

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

    content: Array<CodeExecutionOutputBlockParam { file_id, type } >
    file_id: string
    type: "code_execution_output"
    encrypted_stdout: string
    return_code: number
    stderr: string
    type: "encrypted_code_execution_result"
    tool_use_id: string
    type: "code_execution_tool_result"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    BashCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
    content: BashCodeExecutionToolResultErrorParam { error_code, type } | BashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
    Accepts one of the following:
    BashCodeExecutionToolResultErrorParam { error_code, type }
    error_code: BashCodeExecutionToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    "output_file_too_large"
    type: "bash_code_execution_tool_result_error"
    BashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
    content: Array<BashCodeExecutionOutputBlockParam { file_id, type } >
    file_id: string
    type: "bash_code_execution_output"
    return_code: number
    stderr: string
    stdout: string
    type: "bash_code_execution_result"
    tool_use_id: string
    type: "bash_code_execution_tool_result"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    TextEditorCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
    content: TextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message } | TextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more } | TextEditorCodeExecutionCreateResultBlockParam { is_file_update, type } | TextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
    Accepts one of the following:
    TextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message }
    error_code: TextEditorCodeExecutionToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    "file_not_found"
    type: "text_editor_code_execution_tool_result_error"
    error_message?: string | null
    TextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more }
    content: string
    file_type: "text" | "image" | "pdf"
    Accepts one of the following:
    "text"
    "image"
    "pdf"
    type: "text_editor_code_execution_view_result"
    num_lines?: number | null
    start_line?: number | null
    total_lines?: number | null
    TextEditorCodeExecutionCreateResultBlockParam { is_file_update, type }
    is_file_update: boolean
    type: "text_editor_code_execution_create_result"
    TextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
    type: "text_editor_code_execution_str_replace_result"
    lines?: Array<string> | null
    new_lines?: number | null
    new_start?: number | null
    old_lines?: number | null
    old_start?: number | null
    tool_use_id: string
    type: "text_editor_code_execution_tool_result"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    ToolSearchToolResultBlockParam { content, tool_use_id, type, cache_control }
    content: ToolSearchToolResultErrorParam { error_code, type } | ToolSearchToolSearchResultBlockParam { tool_references, type }
    Accepts one of the following:
    ToolSearchToolResultErrorParam { error_code, type }
    error_code: ToolSearchToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    type: "tool_search_tool_result_error"
    ToolSearchToolSearchResultBlockParam { tool_references, type }
    tool_references: Array<ToolReferenceBlockParam { tool_name, type, cache_control } >
    tool_name: string
    type: "tool_reference"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    type: "tool_search_tool_search_result"
    tool_use_id: string
    type: "tool_search_tool_result"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    ContainerUploadBlockParam { file_id, type, cache_control }

    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.

    file_id: string
    type: "container_upload"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    role: "user" | "assistant"
    Accepts one of the following:
    "user"
    "assistant"
    model: Model

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    "claude-opus-4-6" | "claude-sonnet-4-6" | "claude-opus-4-5-20251101" | 19 more
    "claude-opus-4-6"

    Most intelligent model for building agents and coding

    "claude-sonnet-4-6"

    Frontier intelligence at scale — built for coding, agents, and enterprise workflows

    "claude-opus-4-5-20251101"

    Premium model combining maximum intelligence with practical performance

    "claude-opus-4-5"

    Premium model combining maximum intelligence with practical performance

    "claude-3-7-sonnet-latest"

    High-performance model with early extended thinking

    "claude-3-7-sonnet-20250219"

    High-performance model with early extended thinking

    "claude-3-5-haiku-latest"

    Fastest and most compact model for near-instant responsiveness

    "claude-3-5-haiku-20241022"

    Our fastest model

    "claude-haiku-4-5"

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

    "claude-haiku-4-5-20251001"

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

    "claude-sonnet-4-20250514"

    High-performance model with extended thinking

    "claude-sonnet-4-0"

    High-performance model with extended thinking

    "claude-4-sonnet-20250514"

    High-performance model with extended thinking

    "claude-sonnet-4-5"

    Our best model for real-world agents and coding

    "claude-sonnet-4-5-20250929"

    Our best model for real-world agents and coding

    "claude-opus-4-0"

    Our most capable model

    "claude-opus-4-20250514"

    Our most capable model

    "claude-4-opus-20250514"

    Our most capable model

    "claude-opus-4-1-20250805"

    Our most capable model

    "claude-3-opus-latest"

    Excels at writing and complex tasks

    "claude-3-opus-20240229"

    Excels at writing and complex tasks

    "claude-3-haiku-20240307"

    Our previous most fast and cost-effective

    (string & {})
    cache_control?: CacheControlEphemeral { type, ttl } | null

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

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    output_config?: OutputConfig { effort, format }

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

    effort?: "low" | "medium" | "high" | "max" | null

    All possible effort levels.

    Accepts one of the following:
    "low"
    "medium"
    "high"
    "max"
    format?: JSONOutputFormat { schema, type } | null

    A schema to specify Claude's output format in responses. See structured outputs

    schema: Record<string, unknown>

    The JSON schema of the format

    type: "json_schema"
    system?: string | Array<TextBlockParam { text, type, cache_control, citations } >

    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
    Array<TextBlockParam { text, type, cache_control, citations } >
    text: string
    type: "text"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    citations?: Array<TextCitationParam> | null
    Accepts one of the following:
    CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_char_index: number
    start_char_index: number
    type: "char_location"
    CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_page_number: number
    start_page_number: number
    type: "page_location"
    CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
    cited_text: string
    document_index: number
    document_title: string | null
    end_block_index: number
    start_block_index: number
    type: "content_block_location"
    CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
    cited_text: string
    encrypted_index: string
    title: string | null
    type: "web_search_result_location"
    url: string
    CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
    cited_text: string
    end_block_index: number
    search_result_index: number
    source: string
    start_block_index: number
    title: string | null
    type: "search_result_location"
    thinking?: 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:
    ThinkingConfigEnabled { budget_tokens, type }
    budget_tokens: number

    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: "enabled"
    ThinkingConfigDisabled { type }
    type: "disabled"
    ThinkingConfigAdaptive { type }
    type: "adaptive"
    tool_choice?: 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:
    ToolChoiceAuto { type, disable_parallel_tool_use }

    The model will automatically decide whether to use tools.

    type: "auto"
    disable_parallel_tool_use?: boolean

    Whether to disable parallel tool use.

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

    ToolChoiceAny { type, disable_parallel_tool_use }

    The model will use any available tools.

    type: "any"
    disable_parallel_tool_use?: boolean

    Whether to disable parallel tool use.

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

    ToolChoiceTool { name, type, disable_parallel_tool_use }

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

    name: string

    The name of the tool to use.

    type: "tool"
    disable_parallel_tool_use?: boolean

    Whether to disable parallel tool use.

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

    ToolChoiceNone { type }

    The model will not be allowed to use tools.

    type: "none"
    tools?: Array<MessageCountTokensTool>

    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:
    Tool { input_schema, name, allowed_callers, 7 more }
    input_schema: InputSchema { type, properties, required }

    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: "object"
    properties?: Record<string, unknown> | null
    required?: Array<string> | null
    name: string

    Name of the tool.

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

    maxLength128
    minLength1
    allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    "code_execution_20260120"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    defer_loading?: boolean

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

    description?: 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.

    eager_input_streaming?: boolean | null

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

    input_examples?: Array<Record<string, unknown>>
    strict?: boolean

    When true, guarantees schema validation on tool names and inputs

    type?: "custom" | null
    ToolBash20250124 { name, type, allowed_callers, 4 more }
    name: "bash"

    Name of the tool.

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

    type: "bash_20250124"
    allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    "code_execution_20260120"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    defer_loading?: boolean

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

    input_examples?: Array<Record<string, unknown>>
    strict?: boolean

    When true, guarantees schema validation on tool names and inputs

    CodeExecutionTool20250522 { name, type, allowed_callers, 3 more }
    name: "code_execution"

    Name of the tool.

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

    type: "code_execution_20250522"
    allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    "code_execution_20260120"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    defer_loading?: boolean

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

    strict?: boolean

    When true, guarantees schema validation on tool names and inputs

    CodeExecutionTool20250825 { name, type, allowed_callers, 3 more }
    name: "code_execution"

    Name of the tool.

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

    type: "code_execution_20250825"
    allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    "code_execution_20260120"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    defer_loading?: boolean

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

    strict?: boolean

    When true, guarantees schema validation on tool names and inputs

    CodeExecutionTool20260120 { name, type, allowed_callers, 3 more }

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

    name: "code_execution"

    Name of the tool.

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

    type: "code_execution_20260120"
    allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    "code_execution_20260120"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    defer_loading?: boolean

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

    strict?: boolean

    When true, guarantees schema validation on tool names and inputs

    MemoryTool20250818 { name, type, allowed_callers, 4 more }
    name: "memory"

    Name of the tool.

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

    type: "memory_20250818"
    allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    "code_execution_20260120"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    defer_loading?: boolean

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

    input_examples?: Array<Record<string, unknown>>
    strict?: boolean

    When true, guarantees schema validation on tool names and inputs

    ToolTextEditor20250124 { name, type, allowed_callers, 4 more }
    name: "str_replace_editor"

    Name of the tool.

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

    type: "text_editor_20250124"
    allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    "code_execution_20260120"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    defer_loading?: boolean

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

    input_examples?: Array<Record<string, unknown>>
    strict?: boolean

    When true, guarantees schema validation on tool names and inputs

    ToolTextEditor20250429 { name, type, allowed_callers, 4 more }
    name: "str_replace_based_edit_tool"

    Name of the tool.

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

    type: "text_editor_20250429"
    allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    "code_execution_20260120"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    defer_loading?: boolean

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

    input_examples?: Array<Record<string, unknown>>
    strict?: boolean

    When true, guarantees schema validation on tool names and inputs

    ToolTextEditor20250728 { name, type, allowed_callers, 5 more }
    name: "str_replace_based_edit_tool"

    Name of the tool.

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

    type: "text_editor_20250728"
    allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    "code_execution_20260120"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    defer_loading?: boolean

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

    input_examples?: Array<Record<string, unknown>>
    max_characters?: number | null

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

    strict?: boolean

    When true, guarantees schema validation on tool names and inputs

    WebSearchTool20250305 { name, type, allowed_callers, 7 more }
    name: "web_search"

    Name of the tool.

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

    type: "web_search_20250305"
    allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    "code_execution_20260120"
    allowed_domains?: Array<string> | null

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

    blocked_domains?: Array<string> | null

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

    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    defer_loading?: boolean

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

    max_uses?: number | null

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

    strict?: boolean

    When true, guarantees schema validation on tool names and inputs

    user_location?: UserLocation { type, city, country, 2 more } | null

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

    type: "approximate"
    city?: string | null

    The city of the user.

    country?: string | null

    The two letter ISO country code of the user.

    region?: string | null

    The region of the user.

    timezone?: string | null

    The IANA timezone of the user.

    WebFetchTool20250910 { name, type, allowed_callers, 8 more }
    name: "web_fetch"

    Name of the tool.

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

    type: "web_fetch_20250910"
    allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    "code_execution_20260120"
    allowed_domains?: Array<string> | null

    List of domains to allow fetching from

    blocked_domains?: Array<string> | null

    List of domains to block fetching from

    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    citations?: CitationsConfigParam { enabled } | null

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

    enabled?: boolean
    defer_loading?: boolean

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

    max_content_tokens?: number | null

    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.

    max_uses?: number | null

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

    strict?: boolean

    When true, guarantees schema validation on tool names and inputs

    WebSearchTool20260209 { name, type, allowed_callers, 7 more }
    name: "web_search"

    Name of the tool.

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

    type: "web_search_20260209"
    allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    "code_execution_20260120"
    allowed_domains?: Array<string> | null

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

    blocked_domains?: Array<string> | null

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

    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    defer_loading?: boolean

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

    max_uses?: number | null

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

    strict?: boolean

    When true, guarantees schema validation on tool names and inputs

    user_location?: UserLocation { type, city, country, 2 more } | null

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

    type: "approximate"
    city?: string | null

    The city of the user.

    country?: string | null

    The two letter ISO country code of the user.

    region?: string | null

    The region of the user.

    timezone?: string | null

    The IANA timezone of the user.

    WebFetchTool20260209 { name, type, allowed_callers, 8 more }
    name: "web_fetch"

    Name of the tool.

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

    type: "web_fetch_20260209"
    allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    "code_execution_20260120"
    allowed_domains?: Array<string> | null

    List of domains to allow fetching from

    blocked_domains?: Array<string> | null

    List of domains to block fetching from

    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    citations?: CitationsConfigParam { enabled } | null

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

    enabled?: boolean
    defer_loading?: boolean

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

    max_content_tokens?: number | null

    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.

    max_uses?: number | null

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

    strict?: boolean

    When true, guarantees schema validation on tool names and inputs

    ToolSearchToolBm25_20251119 { name, type, allowed_callers, 3 more }
    name: "tool_search_tool_bm25"

    Name of the tool.

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

    type: "tool_search_tool_bm25_20251119" | "tool_search_tool_bm25"
    Accepts one of the following:
    "tool_search_tool_bm25_20251119"
    "tool_search_tool_bm25"
    allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    "code_execution_20260120"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    defer_loading?: boolean

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

    strict?: boolean

    When true, guarantees schema validation on tool names and inputs

    ToolSearchToolRegex20251119 { name, type, allowed_callers, 3 more }
    name: "tool_search_tool_regex"

    Name of the tool.

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

    type: "tool_search_tool_regex_20251119" | "tool_search_tool_regex"
    Accepts one of the following:
    "tool_search_tool_regex_20251119"
    "tool_search_tool_regex"
    allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    "code_execution_20260120"
    cache_control?: CacheControlEphemeral { type, ttl } | null

    Create a cache control breakpoint at this content block.

    type: "ephemeral"
    ttl?: "5m" | "1h"

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

    This may be one the following values:

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

    Defaults to 5m.

    Accepts one of the following:
    "5m"
    "1h"
    defer_loading?: boolean

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

    strict?: boolean

    When true, guarantees schema validation on tool names and inputs

    ReturnsExpand Collapse
    MessageTokensCount { input_tokens }
    input_tokens: number

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

    Count tokens in a Message
    import Anthropic from '@anthropic-ai/sdk';
    
    const client = new Anthropic({
      apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted
    });
    
    const messageTokensCount = await client.messages.countTokens({
      messages: [{ content: 'string', role: 'user' }],
      model: 'claude-opus-4-6',
    });
    
    console.log(messageTokensCount.input_tokens);
    Response 200
    {
      "input_tokens": 2095
    }
    Returns Examples
    Response 200
    {
      "input_tokens": 2095
    }

    Solutions

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

    Partners

    • Amazon Bedrock
    • Google Cloud's Vertex AI

    Learn

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

    Company

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

    Learn

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

    Help and security

    • Availability
    • Status
    • Support
    • Discord

    Terms and policies

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