Loading...
    • Developer Guide
    • API Reference
    • MCP
    • Resources
    • Release Notes
    Search...
    ⌘K

    Using the API

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

    Support & configuration

    Rate limitsService tiersVersionsIP addressesSupported regionsOpenAI SDK compatibility
    Console

    Messages

    Count tokens in a Message
    messages.count_tokens(MessageCountTokensParams**kwargs) -> MessageTokensCount
    post/v1/messages/count_tokens
    Create a Message
    messages.create(MessageCreateParams**kwargs) -> Message
    post/v1/messages
    ModelsExpand Collapse
    class Base64ImageSource: …
    data: str
    formatbyte
    media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class Base64PDFSource: …
    data: str
    formatbyte
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class CacheControlEphemeral: …
    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class CacheCreation: …
    ephemeral_1h_input_tokens: int

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

    minimum0
    ephemeral_5m_input_tokens: int

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

    minimum0
    class CitationCharLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationContentBlockLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationPageLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationsConfigParam: …
    enabled: Optional[bool]
    class CitationsDelta: …
    citation: Citation
    Accepts one of the following:
    class CitationCharLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class CitationsSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    type: Literal["citations_delta"]
    Accepts one of the following:
    "citations_delta"
    class CitationsSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class CitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    ContentBlock = ContentBlock
    Accepts one of the following:
    class TextBlock: …
    citations: Optional[List[TextCitation]]

    Citations supporting the text block.

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

    Accepts one of the following:
    class CitationCharLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class CitationsSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    maxLength5000000
    minLength0
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class ThinkingBlock: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class RedactedThinkingBlock: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class ToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str
    minLength1
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    class ServerToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: Literal["web_search"]
    Accepts one of the following:
    "web_search"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    class WebSearchToolResultBlock: …
    content: WebSearchToolResultBlockContent
    Accepts one of the following:
    class WebSearchToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"
    UnionMember1 = List[WebSearchResultBlock]
    encrypted_content: str
    page_age: Optional[str]
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    tool_use_id: str
    type: Literal["web_search_tool_result"]
    Accepts one of the following:
    "web_search_tool_result"
    ContentBlockParam = Union[TextBlockParam, ImageBlockParam, DocumentBlockParam, 7 more]

    Regular text content.

    Accepts one of the following:
    class TextBlockParam: …
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class ImageBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64ImageSource: …
    data: str
    formatbyte
    media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class URLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class DocumentBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64PDFSource: …
    data: str
    formatbyte
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class PlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class ContentBlockSource: …
    content: Union[str, List[ContentBlockSourceContent]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentContentBlockSourceContent = List[ContentBlockSourceContent]
    Accepts one of the following:
    class TextBlockParam: …
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class ImageBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64ImageSource: …
    data: str
    formatbyte
    media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class URLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Literal["content"]
    Accepts one of the following:
    "content"
    class URLPDFSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["document"]
    Accepts one of the following:
    "document"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[CitationsConfigParam]
    enabled: Optional[bool]
    context: Optional[str]
    minLength1
    title: Optional[str]
    maxLength500
    minLength1
    class SearchResultBlockParam: …
    content: List[TextBlockParam]
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    source: str
    title: str
    type: Literal["search_result"]
    Accepts one of the following:
    "search_result"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[CitationsConfigParam]
    enabled: Optional[bool]
    class ThinkingBlockParam: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class RedactedThinkingBlockParam: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class ToolUseBlockParam: …
    id: str
    input: Dict[str, object]
    name: str
    maxLength200
    minLength1
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class ToolResultBlockParam: …
    tool_use_id: str
    type: Literal["tool_result"]
    Accepts one of the following:
    "tool_result"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[Union[str, List[Content], null]]
    Accepts one of the following:
    ContentUnionMember0 = str
    Content = List[Content]
    Accepts one of the following:
    class TextBlockParam: …
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class ImageBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64ImageSource: …
    data: str
    formatbyte
    media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class URLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class SearchResultBlockParam: …
    content: List[TextBlockParam]
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    source: str
    title: str
    type: Literal["search_result"]
    Accepts one of the following:
    "search_result"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[CitationsConfigParam]
    enabled: Optional[bool]
    class DocumentBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64PDFSource: …
    data: str
    formatbyte
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class PlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class ContentBlockSource: …
    content: Union[str, List[ContentBlockSourceContent]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentContentBlockSourceContent = List[ContentBlockSourceContent]
    Accepts one of the following:
    class TextBlockParam: …
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class ImageBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64ImageSource: …
    data: str
    formatbyte
    media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class URLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Literal["content"]
    Accepts one of the following:
    "content"
    class URLPDFSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["document"]
    Accepts one of the following:
    "document"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[CitationsConfigParam]
    enabled: Optional[bool]
    context: Optional[str]
    minLength1
    title: Optional[str]
    maxLength500
    minLength1
    is_error: Optional[bool]
    class ServerToolUseBlockParam: …
    id: str
    input: Dict[str, object]
    name: Literal["web_search"]
    Accepts one of the following:
    "web_search"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class WebSearchToolResultBlockParam: …
    content: WebSearchToolResultBlockParamContent
    Accepts one of the following:
    WebSearchToolResultBlockItem = List[WebSearchResultBlockParam]
    encrypted_content: str
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    page_age: Optional[str]
    class WebSearchToolRequestError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"
    tool_use_id: str
    type: Literal["web_search_tool_result"]
    Accepts one of the following:
    "web_search_tool_result"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class ContentBlockSource: …
    content: Union[str, List[ContentBlockSourceContent]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentContentBlockSourceContent = List[ContentBlockSourceContent]
    Accepts one of the following:
    class TextBlockParam: …
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class ImageBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64ImageSource: …
    data: str
    formatbyte
    media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class URLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Literal["content"]
    Accepts one of the following:
    "content"
    ContentBlockSourceContent = ContentBlockSourceContent
    Accepts one of the following:
    class TextBlockParam: …
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class ImageBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64ImageSource: …
    data: str
    formatbyte
    media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class URLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class DocumentBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64PDFSource: …
    data: str
    formatbyte
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class PlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class ContentBlockSource: …
    content: Union[str, List[ContentBlockSourceContent]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentContentBlockSourceContent = List[ContentBlockSourceContent]
    Accepts one of the following:
    class TextBlockParam: …
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class ImageBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64ImageSource: …
    data: str
    formatbyte
    media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class URLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Literal["content"]
    Accepts one of the following:
    "content"
    class URLPDFSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["document"]
    Accepts one of the following:
    "document"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[CitationsConfigParam]
    enabled: Optional[bool]
    context: Optional[str]
    minLength1
    title: Optional[str]
    maxLength500
    minLength1
    class ImageBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64ImageSource: …
    data: str
    formatbyte
    media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class URLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class InputJSONDelta: …
    partial_json: str
    type: Literal["input_json_delta"]
    Accepts one of the following:
    "input_json_delta"
    class Message: …
    id: str

    Unique object identifier.

    The format and length of IDs may change over time.

    content: List[ContentBlock]

    Content generated by the model.

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

    Example:

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

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

    For example, if the input messages were:

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

    Then the response content might be:

    [{"type": "text", "text": "B)"}]
    Accepts one of the following:
    class TextBlock: …
    citations: Optional[List[TextCitation]]

    Citations supporting the text block.

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

    Accepts one of the following:
    class CitationCharLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class CitationsSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    maxLength5000000
    minLength0
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class ThinkingBlock: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class RedactedThinkingBlock: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class ToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str
    minLength1
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    class ServerToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: Literal["web_search"]
    Accepts one of the following:
    "web_search"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    class WebSearchToolResultBlock: …
    content: WebSearchToolResultBlockContent
    Accepts one of the following:
    class WebSearchToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"
    UnionMember1 = List[WebSearchResultBlock]
    encrypted_content: str
    page_age: Optional[str]
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    tool_use_id: str
    type: Literal["web_search_tool_result"]
    Accepts one of the following:
    "web_search_tool_result"
    model: Model

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]

    The model that will complete your prompt.

    See models for additional details and options.

    • claude-3-7-sonnet-latest - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-7-sonnet-20250219 - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • 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 - Deprecated: Will reach end-of-life on January 5th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-opus-20240229 - Deprecated: Will reach end-of-life on January 5th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-haiku-20240307 - Our previous most fast and cost-effective
    Accepts one of the following:
    "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

    UnionMember1 = str
    role: Literal["assistant"]

    Conversational role of the generated message.

    This will always be "assistant".

    Accepts one of the following:
    "assistant"
    stop_reason: Optional[StopReason]

    The reason that we stopped.

    This may be one the following values:

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

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

    Accepts one of the following:
    "end_turn"
    "max_tokens"
    "stop_sequence"
    "tool_use"
    "pause_turn"
    "refusal"
    stop_sequence: Optional[str]

    Which custom stop sequence was generated, if any.

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

    type: Literal["message"]

    Object type.

    For Messages, this is always "message".

    Accepts one of the following:
    "message"
    usage: Usage

    Billing and rate-limit usage.

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

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

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

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

    cache_creation: Optional[CacheCreation]

    Breakdown of cached tokens by TTL

    ephemeral_1h_input_tokens: int

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

    minimum0
    ephemeral_5m_input_tokens: int

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

    minimum0
    cache_creation_input_tokens: Optional[int]

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

    minimum0
    cache_read_input_tokens: Optional[int]

    The number of input tokens read from the cache.

    minimum0
    input_tokens: int

    The number of input tokens which were used.

    minimum0
    output_tokens: int

    The number of output tokens which were used.

    minimum0
    server_tool_use: Optional[ServerToolUsage]

    The number of server tool requests.

    web_search_requests: int

    The number of web search tool requests.

    minimum0
    service_tier: Optional[Literal["standard", "priority", "batch"]]

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

    Accepts one of the following:
    "standard"
    "priority"
    "batch"
    MessageCountTokensTool = MessageCountTokensTool
    Accepts one of the following:
    class Tool: …
    input_schema: 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: Literal["object"]
    Accepts one of the following:
    "object"
    properties: Optional[Dict[str, object]]
    required: Optional[List[str]]
    name: str

    Name of the tool.

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

    maxLength128
    minLength1
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    description: Optional[str]

    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[Literal["custom"]]
    Accepts one of the following:
    "custom"
    class ToolBash20250124: …
    name: Literal["bash"]

    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"
    type: Literal["bash_20250124"]
    Accepts one of the following:
    "bash_20250124"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class ToolTextEditor20250124: …
    name: Literal["str_replace_editor"]

    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"
    type: Literal["text_editor_20250124"]
    Accepts one of the following:
    "text_editor_20250124"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class ToolTextEditor20250429: …
    name: Literal["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.

    Accepts one of the following:
    "str_replace_based_edit_tool"
    type: Literal["text_editor_20250429"]
    Accepts one of the following:
    "text_editor_20250429"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class ToolTextEditor20250728: …
    name: Literal["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.

    Accepts one of the following:
    "str_replace_based_edit_tool"
    type: Literal["text_editor_20250728"]
    Accepts one of the following:
    "text_editor_20250728"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    max_characters: Optional[int]

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

    minimum1
    class WebSearchTool20250305: …
    name: Literal["web_search"]

    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"
    type: Literal["web_search_20250305"]
    Accepts one of the following:
    "web_search_20250305"
    allowed_domains: Optional[List[str]]

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

    blocked_domains: Optional[List[str]]

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

    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    max_uses: Optional[int]

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

    exclusiveMinimum0
    user_location: Optional[UserLocation]

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

    type: Literal["approximate"]
    Accepts one of the following:
    "approximate"
    city: Optional[str]

    The city of the user.

    maxLength255
    minLength1
    country: Optional[str]

    The two letter ISO country code of the user.

    maxLength2
    minLength2
    region: Optional[str]

    The region of the user.

    maxLength255
    minLength1
    timezone: Optional[str]

    The IANA timezone of the user.

    maxLength255
    minLength1
    class MessageDeltaUsage: …
    cache_creation_input_tokens: Optional[int]

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

    minimum0
    cache_read_input_tokens: Optional[int]

    The cumulative number of input tokens read from the cache.

    minimum0
    input_tokens: Optional[int]

    The cumulative number of input tokens which were used.

    minimum0
    output_tokens: int

    The cumulative number of output tokens which were used.

    server_tool_use: Optional[ServerToolUsage]

    The number of server tool requests.

    web_search_requests: int

    The number of web search tool requests.

    minimum0
    class MessageParam: …
    content: Union[str, List[Union[TextBlockParam, ImageBlockParam, DocumentBlockParam, 8 more]]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentUnionMember1 = List[Union[TextBlockParam, ImageBlockParam, DocumentBlockParam, 8 more]]
    Accepts one of the following:
    class TextBlockParam: …
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class ImageBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64ImageSource: …
    data: str
    formatbyte
    media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class URLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class DocumentBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64PDFSource: …
    data: str
    formatbyte
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class PlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class ContentBlockSource: …
    content: Union[str, List[ContentBlockSourceContent]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentContentBlockSourceContent = List[ContentBlockSourceContent]
    Accepts one of the following:
    class TextBlockParam: …
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class ImageBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64ImageSource: …
    data: str
    formatbyte
    media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class URLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Literal["content"]
    Accepts one of the following:
    "content"
    class URLPDFSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["document"]
    Accepts one of the following:
    "document"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[CitationsConfigParam]
    enabled: Optional[bool]
    context: Optional[str]
    minLength1
    title: Optional[str]
    maxLength500
    minLength1
    class SearchResultBlockParam: …
    content: List[TextBlockParam]
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    source: str
    title: str
    type: Literal["search_result"]
    Accepts one of the following:
    "search_result"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[CitationsConfigParam]
    enabled: Optional[bool]
    class ThinkingBlockParam: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class RedactedThinkingBlockParam: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class ToolUseBlockParam: …
    id: str
    input: Dict[str, object]
    name: str
    maxLength200
    minLength1
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class ToolResultBlockParam: …
    tool_use_id: str
    type: Literal["tool_result"]
    Accepts one of the following:
    "tool_result"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[Union[str, List[Content], null]]
    Accepts one of the following:
    ContentUnionMember0 = str
    Content = List[Content]
    Accepts one of the following:
    class TextBlockParam: …
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class ImageBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64ImageSource: …
    data: str
    formatbyte
    media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class URLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class SearchResultBlockParam: …
    content: List[TextBlockParam]
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    source: str
    title: str
    type: Literal["search_result"]
    Accepts one of the following:
    "search_result"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[CitationsConfigParam]
    enabled: Optional[bool]
    class DocumentBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64PDFSource: …
    data: str
    formatbyte
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class PlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class ContentBlockSource: …
    content: Union[str, List[ContentBlockSourceContent]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentContentBlockSourceContent = List[ContentBlockSourceContent]
    Accepts one of the following:
    class TextBlockParam: …
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class ImageBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64ImageSource: …
    data: str
    formatbyte
    media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class URLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Literal["content"]
    Accepts one of the following:
    "content"
    class URLPDFSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["document"]
    Accepts one of the following:
    "document"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[CitationsConfigParam]
    enabled: Optional[bool]
    context: Optional[str]
    minLength1
    title: Optional[str]
    maxLength500
    minLength1
    is_error: Optional[bool]
    class ServerToolUseBlockParam: …
    id: str
    input: Dict[str, object]
    name: Literal["web_search"]
    Accepts one of the following:
    "web_search"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class WebSearchToolResultBlockParam: …
    content: WebSearchToolResultBlockParamContent
    Accepts one of the following:
    WebSearchToolResultBlockItem = List[WebSearchResultBlockParam]
    encrypted_content: str
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    page_age: Optional[str]
    class WebSearchToolRequestError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"
    tool_use_id: str
    type: Literal["web_search_tool_result"]
    Accepts one of the following:
    "web_search_tool_result"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Literal["user", "assistant"]
    Accepts one of the following:
    "user"
    "assistant"
    class MessageTokensCount: …
    input_tokens: int

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

    class Metadata: …
    user_id: Optional[str]

    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
    Model = Union[Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more], str]

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]

    The model that will complete your prompt.

    See models for additional details and options.

    • claude-3-7-sonnet-latest - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-7-sonnet-20250219 - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • 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 - Deprecated: Will reach end-of-life on January 5th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-opus-20240229 - Deprecated: Will reach end-of-life on January 5th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-haiku-20240307 - Our previous most fast and cost-effective
    Accepts one of the following:
    "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

    UnionMember1 = str
    class PlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    RawContentBlockDelta = RawContentBlockDelta
    Accepts one of the following:
    class TextDelta: …
    text: str
    type: Literal["text_delta"]
    Accepts one of the following:
    "text_delta"
    class InputJSONDelta: …
    partial_json: str
    type: Literal["input_json_delta"]
    Accepts one of the following:
    "input_json_delta"
    class CitationsDelta: …
    citation: Citation
    Accepts one of the following:
    class CitationCharLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class CitationsSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    type: Literal["citations_delta"]
    Accepts one of the following:
    "citations_delta"
    class ThinkingDelta: …
    thinking: str
    type: Literal["thinking_delta"]
    Accepts one of the following:
    "thinking_delta"
    class SignatureDelta: …
    signature: str
    type: Literal["signature_delta"]
    Accepts one of the following:
    "signature_delta"
    class RawContentBlockDeltaEvent: …
    delta: RawContentBlockDelta
    Accepts one of the following:
    class TextDelta: …
    text: str
    type: Literal["text_delta"]
    Accepts one of the following:
    "text_delta"
    class InputJSONDelta: …
    partial_json: str
    type: Literal["input_json_delta"]
    Accepts one of the following:
    "input_json_delta"
    class CitationsDelta: …
    citation: Citation
    Accepts one of the following:
    class CitationCharLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class CitationsSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    type: Literal["citations_delta"]
    Accepts one of the following:
    "citations_delta"
    class ThinkingDelta: …
    thinking: str
    type: Literal["thinking_delta"]
    Accepts one of the following:
    "thinking_delta"
    class SignatureDelta: …
    signature: str
    type: Literal["signature_delta"]
    Accepts one of the following:
    "signature_delta"
    index: int
    type: Literal["content_block_delta"]
    Accepts one of the following:
    "content_block_delta"
    class RawContentBlockStartEvent: …
    content_block: ContentBlock
    Accepts one of the following:
    class TextBlock: …
    citations: Optional[List[TextCitation]]

    Citations supporting the text block.

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

    Accepts one of the following:
    class CitationCharLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class CitationsSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    maxLength5000000
    minLength0
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class ThinkingBlock: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class RedactedThinkingBlock: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class ToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str
    minLength1
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    class ServerToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: Literal["web_search"]
    Accepts one of the following:
    "web_search"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    class WebSearchToolResultBlock: …
    content: WebSearchToolResultBlockContent
    Accepts one of the following:
    class WebSearchToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"
    UnionMember1 = List[WebSearchResultBlock]
    encrypted_content: str
    page_age: Optional[str]
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    tool_use_id: str
    type: Literal["web_search_tool_result"]
    Accepts one of the following:
    "web_search_tool_result"
    index: int
    type: Literal["content_block_start"]
    Accepts one of the following:
    "content_block_start"
    class RawContentBlockStopEvent: …
    index: int
    type: Literal["content_block_stop"]
    Accepts one of the following:
    "content_block_stop"
    class RawMessageDeltaEvent: …
    delta: Delta
    stop_reason: Optional[StopReason]
    Accepts one of the following:
    "end_turn"
    "max_tokens"
    "stop_sequence"
    "tool_use"
    "pause_turn"
    "refusal"
    stop_sequence: Optional[str]
    type: Literal["message_delta"]
    Accepts one of the following:
    "message_delta"
    usage: MessageDeltaUsage

    Billing and rate-limit usage.

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

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

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

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

    cache_creation_input_tokens: Optional[int]

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

    minimum0
    cache_read_input_tokens: Optional[int]

    The cumulative number of input tokens read from the cache.

    minimum0
    input_tokens: Optional[int]

    The cumulative number of input tokens which were used.

    minimum0
    output_tokens: int

    The cumulative number of output tokens which were used.

    server_tool_use: Optional[ServerToolUsage]

    The number of server tool requests.

    web_search_requests: int

    The number of web search tool requests.

    minimum0
    class RawMessageStartEvent: …
    message: Message
    id: str

    Unique object identifier.

    The format and length of IDs may change over time.

    content: List[ContentBlock]

    Content generated by the model.

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

    Example:

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

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

    For example, if the input messages were:

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

    Then the response content might be:

    [{"type": "text", "text": "B)"}]
    Accepts one of the following:
    class TextBlock: …
    citations: Optional[List[TextCitation]]

    Citations supporting the text block.

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

    Accepts one of the following:
    class CitationCharLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class CitationsSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    maxLength5000000
    minLength0
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class ThinkingBlock: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class RedactedThinkingBlock: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class ToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str
    minLength1
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    class ServerToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: Literal["web_search"]
    Accepts one of the following:
    "web_search"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    class WebSearchToolResultBlock: …
    content: WebSearchToolResultBlockContent
    Accepts one of the following:
    class WebSearchToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"
    UnionMember1 = List[WebSearchResultBlock]
    encrypted_content: str
    page_age: Optional[str]
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    tool_use_id: str
    type: Literal["web_search_tool_result"]
    Accepts one of the following:
    "web_search_tool_result"
    model: Model

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]

    The model that will complete your prompt.

    See models for additional details and options.

    • claude-3-7-sonnet-latest - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-7-sonnet-20250219 - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • 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 - Deprecated: Will reach end-of-life on January 5th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-opus-20240229 - Deprecated: Will reach end-of-life on January 5th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-haiku-20240307 - Our previous most fast and cost-effective
    Accepts one of the following:
    "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

    UnionMember1 = str
    role: Literal["assistant"]

    Conversational role of the generated message.

    This will always be "assistant".

    Accepts one of the following:
    "assistant"
    stop_reason: Optional[StopReason]

    The reason that we stopped.

    This may be one the following values:

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

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

    Accepts one of the following:
    "end_turn"
    "max_tokens"
    "stop_sequence"
    "tool_use"
    "pause_turn"
    "refusal"
    stop_sequence: Optional[str]

    Which custom stop sequence was generated, if any.

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

    type: Literal["message"]

    Object type.

    For Messages, this is always "message".

    Accepts one of the following:
    "message"
    usage: Usage

    Billing and rate-limit usage.

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

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

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

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

    cache_creation: Optional[CacheCreation]

    Breakdown of cached tokens by TTL

    ephemeral_1h_input_tokens: int

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

    minimum0
    ephemeral_5m_input_tokens: int

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

    minimum0
    cache_creation_input_tokens: Optional[int]

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

    minimum0
    cache_read_input_tokens: Optional[int]

    The number of input tokens read from the cache.

    minimum0
    input_tokens: int

    The number of input tokens which were used.

    minimum0
    output_tokens: int

    The number of output tokens which were used.

    minimum0
    server_tool_use: Optional[ServerToolUsage]

    The number of server tool requests.

    web_search_requests: int

    The number of web search tool requests.

    minimum0
    service_tier: Optional[Literal["standard", "priority", "batch"]]

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

    Accepts one of the following:
    "standard"
    "priority"
    "batch"
    type: Literal["message_start"]
    Accepts one of the following:
    "message_start"
    class RawMessageStopEvent: …
    type: Literal["message_stop"]
    Accepts one of the following:
    "message_stop"
    RawMessageStreamEvent = RawMessageStreamEvent
    Accepts one of the following:
    class RawMessageStartEvent: …
    message: Message
    id: str

    Unique object identifier.

    The format and length of IDs may change over time.

    content: List[ContentBlock]

    Content generated by the model.

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

    Example:

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

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

    For example, if the input messages were:

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

    Then the response content might be:

    [{"type": "text", "text": "B)"}]
    Accepts one of the following:
    class TextBlock: …
    citations: Optional[List[TextCitation]]

    Citations supporting the text block.

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

    Accepts one of the following:
    class CitationCharLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class CitationsSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    maxLength5000000
    minLength0
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class ThinkingBlock: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class RedactedThinkingBlock: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class ToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str
    minLength1
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    class ServerToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: Literal["web_search"]
    Accepts one of the following:
    "web_search"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    class WebSearchToolResultBlock: …
    content: WebSearchToolResultBlockContent
    Accepts one of the following:
    class WebSearchToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"
    UnionMember1 = List[WebSearchResultBlock]
    encrypted_content: str
    page_age: Optional[str]
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    tool_use_id: str
    type: Literal["web_search_tool_result"]
    Accepts one of the following:
    "web_search_tool_result"
    model: Model

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]

    The model that will complete your prompt.

    See models for additional details and options.

    • claude-3-7-sonnet-latest - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-7-sonnet-20250219 - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • 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 - Deprecated: Will reach end-of-life on January 5th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-opus-20240229 - Deprecated: Will reach end-of-life on January 5th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-haiku-20240307 - Our previous most fast and cost-effective
    Accepts one of the following:
    "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

    UnionMember1 = str
    role: Literal["assistant"]

    Conversational role of the generated message.

    This will always be "assistant".

    Accepts one of the following:
    "assistant"
    stop_reason: Optional[StopReason]

    The reason that we stopped.

    This may be one the following values:

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

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

    Accepts one of the following:
    "end_turn"
    "max_tokens"
    "stop_sequence"
    "tool_use"
    "pause_turn"
    "refusal"
    stop_sequence: Optional[str]

    Which custom stop sequence was generated, if any.

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

    type: Literal["message"]

    Object type.

    For Messages, this is always "message".

    Accepts one of the following:
    "message"
    usage: Usage

    Billing and rate-limit usage.

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

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

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

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

    cache_creation: Optional[CacheCreation]

    Breakdown of cached tokens by TTL

    ephemeral_1h_input_tokens: int

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

    minimum0
    ephemeral_5m_input_tokens: int

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

    minimum0
    cache_creation_input_tokens: Optional[int]

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

    minimum0
    cache_read_input_tokens: Optional[int]

    The number of input tokens read from the cache.

    minimum0
    input_tokens: int

    The number of input tokens which were used.

    minimum0
    output_tokens: int

    The number of output tokens which were used.

    minimum0
    server_tool_use: Optional[ServerToolUsage]

    The number of server tool requests.

    web_search_requests: int

    The number of web search tool requests.

    minimum0
    service_tier: Optional[Literal["standard", "priority", "batch"]]

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

    Accepts one of the following:
    "standard"
    "priority"
    "batch"
    type: Literal["message_start"]
    Accepts one of the following:
    "message_start"
    class RawMessageDeltaEvent: …
    delta: Delta
    stop_reason: Optional[StopReason]
    Accepts one of the following:
    "end_turn"
    "max_tokens"
    "stop_sequence"
    "tool_use"
    "pause_turn"
    "refusal"
    stop_sequence: Optional[str]
    type: Literal["message_delta"]
    Accepts one of the following:
    "message_delta"
    usage: MessageDeltaUsage

    Billing and rate-limit usage.

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

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

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

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

    cache_creation_input_tokens: Optional[int]

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

    minimum0
    cache_read_input_tokens: Optional[int]

    The cumulative number of input tokens read from the cache.

    minimum0
    input_tokens: Optional[int]

    The cumulative number of input tokens which were used.

    minimum0
    output_tokens: int

    The cumulative number of output tokens which were used.

    server_tool_use: Optional[ServerToolUsage]

    The number of server tool requests.

    web_search_requests: int

    The number of web search tool requests.

    minimum0
    class RawMessageStopEvent: …
    type: Literal["message_stop"]
    Accepts one of the following:
    "message_stop"
    class RawContentBlockStartEvent: …
    content_block: ContentBlock
    Accepts one of the following:
    class TextBlock: …
    citations: Optional[List[TextCitation]]

    Citations supporting the text block.

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

    Accepts one of the following:
    class CitationCharLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class CitationsSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    maxLength5000000
    minLength0
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class ThinkingBlock: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class RedactedThinkingBlock: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class ToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str
    minLength1
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    class ServerToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: Literal["web_search"]
    Accepts one of the following:
    "web_search"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    class WebSearchToolResultBlock: …
    content: WebSearchToolResultBlockContent
    Accepts one of the following:
    class WebSearchToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"
    UnionMember1 = List[WebSearchResultBlock]
    encrypted_content: str
    page_age: Optional[str]
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    tool_use_id: str
    type: Literal["web_search_tool_result"]
    Accepts one of the following:
    "web_search_tool_result"
    index: int
    type: Literal["content_block_start"]
    Accepts one of the following:
    "content_block_start"
    class RawContentBlockDeltaEvent: …
    delta: RawContentBlockDelta
    Accepts one of the following:
    class TextDelta: …
    text: str
    type: Literal["text_delta"]
    Accepts one of the following:
    "text_delta"
    class InputJSONDelta: …
    partial_json: str
    type: Literal["input_json_delta"]
    Accepts one of the following:
    "input_json_delta"
    class CitationsDelta: …
    citation: Citation
    Accepts one of the following:
    class CitationCharLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class CitationsSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    type: Literal["citations_delta"]
    Accepts one of the following:
    "citations_delta"
    class ThinkingDelta: …
    thinking: str
    type: Literal["thinking_delta"]
    Accepts one of the following:
    "thinking_delta"
    class SignatureDelta: …
    signature: str
    type: Literal["signature_delta"]
    Accepts one of the following:
    "signature_delta"
    index: int
    type: Literal["content_block_delta"]
    Accepts one of the following:
    "content_block_delta"
    class RawContentBlockStopEvent: …
    index: int
    type: Literal["content_block_stop"]
    Accepts one of the following:
    "content_block_stop"
    class RedactedThinkingBlock: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class RedactedThinkingBlockParam: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class SearchResultBlockParam: …
    content: List[TextBlockParam]
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    source: str
    title: str
    type: Literal["search_result"]
    Accepts one of the following:
    "search_result"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[CitationsConfigParam]
    enabled: Optional[bool]
    class ServerToolUsage: …
    web_search_requests: int

    The number of web search tool requests.

    minimum0
    class ServerToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: Literal["web_search"]
    Accepts one of the following:
    "web_search"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    class ServerToolUseBlockParam: …
    id: str
    input: Dict[str, object]
    name: Literal["web_search"]
    Accepts one of the following:
    "web_search"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class SignatureDelta: …
    signature: str
    type: Literal["signature_delta"]
    Accepts one of the following:
    "signature_delta"
    StopReason = Literal["end_turn", "max_tokens", "stop_sequence", 3 more]
    Accepts one of the following:
    "end_turn"
    "max_tokens"
    "stop_sequence"
    "tool_use"
    "pause_turn"
    "refusal"
    class TextBlock: …
    citations: Optional[List[TextCitation]]

    Citations supporting the text block.

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

    Accepts one of the following:
    class CitationCharLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class CitationsSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    maxLength5000000
    minLength0
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class TextBlockParam: …
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    TextCitation = TextCitation
    Accepts one of the following:
    class CitationCharLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class CitationsSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    TextCitationParam = TextCitationParam
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class TextDelta: …
    text: str
    type: Literal["text_delta"]
    Accepts one of the following:
    "text_delta"
    class ThinkingBlock: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class ThinkingBlockParam: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class ThinkingConfigDisabled: …
    type: Literal["disabled"]
    Accepts one of the following:
    "disabled"
    class ThinkingConfigEnabled: …
    budget_tokens: int

    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: Literal["enabled"]
    Accepts one of the following:
    "enabled"
    ThinkingConfigParam = 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: …
    budget_tokens: int

    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: Literal["enabled"]
    Accepts one of the following:
    "enabled"
    class ThinkingConfigDisabled: …
    type: Literal["disabled"]
    Accepts one of the following:
    "disabled"
    class ThinkingDelta: …
    thinking: str
    type: Literal["thinking_delta"]
    Accepts one of the following:
    "thinking_delta"
    class Tool: …
    input_schema: 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: Literal["object"]
    Accepts one of the following:
    "object"
    properties: Optional[Dict[str, object]]
    required: Optional[List[str]]
    name: str

    Name of the tool.

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

    maxLength128
    minLength1
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    description: Optional[str]

    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[Literal["custom"]]
    Accepts one of the following:
    "custom"
    class ToolBash20250124: …
    name: Literal["bash"]

    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"
    type: Literal["bash_20250124"]
    Accepts one of the following:
    "bash_20250124"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    ToolChoice = 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: Literal["auto"]
    Accepts one of the following:
    "auto"
    disable_parallel_tool_use: Optional[bool]

    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: Literal["any"]
    Accepts one of the following:
    "any"
    disable_parallel_tool_use: Optional[bool]

    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: str

    The name of the tool to use.

    type: Literal["tool"]
    Accepts one of the following:
    "tool"
    disable_parallel_tool_use: Optional[bool]

    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: Literal["none"]
    Accepts one of the following:
    "none"
    class ToolChoiceAny: …

    The model will use any available tools.

    type: Literal["any"]
    Accepts one of the following:
    "any"
    disable_parallel_tool_use: Optional[bool]

    Whether to disable parallel tool use.

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

    class ToolChoiceAuto: …

    The model will automatically decide whether to use tools.

    type: Literal["auto"]
    Accepts one of the following:
    "auto"
    disable_parallel_tool_use: Optional[bool]

    Whether to disable parallel tool use.

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

    class ToolChoiceNone: …

    The model will not be allowed to use tools.

    type: Literal["none"]
    Accepts one of the following:
    "none"
    class ToolChoiceTool: …

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

    name: str

    The name of the tool to use.

    type: Literal["tool"]
    Accepts one of the following:
    "tool"
    disable_parallel_tool_use: Optional[bool]

    Whether to disable parallel tool use.

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

    class ToolResultBlockParam: …
    tool_use_id: str
    type: Literal["tool_result"]
    Accepts one of the following:
    "tool_result"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[Union[str, List[Content], null]]
    Accepts one of the following:
    ContentUnionMember0 = str
    Content = List[Content]
    Accepts one of the following:
    class TextBlockParam: …
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class ImageBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64ImageSource: …
    data: str
    formatbyte
    media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class URLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class SearchResultBlockParam: …
    content: List[TextBlockParam]
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    source: str
    title: str
    type: Literal["search_result"]
    Accepts one of the following:
    "search_result"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[CitationsConfigParam]
    enabled: Optional[bool]
    class DocumentBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64PDFSource: …
    data: str
    formatbyte
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class PlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class ContentBlockSource: …
    content: Union[str, List[ContentBlockSourceContent]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentContentBlockSourceContent = List[ContentBlockSourceContent]
    Accepts one of the following:
    class TextBlockParam: …
    text: str
    minLength1
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[List[TextCitationParam]]
    Accepts one of the following:
    class CitationCharLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_char_index: int
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_page_number: int
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    maxLength255
    minLength1
    end_block_index: int
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    minLength1
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    maxLength2048
    minLength1
    class CitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class ImageBlockParam: …
    source: Source
    Accepts one of the following:
    class Base64ImageSource: …
    data: str
    formatbyte
    media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
    Accepts one of the following:
    "image/jpeg"
    "image/png"
    "image/gif"
    "image/webp"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class URLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Literal["content"]
    Accepts one of the following:
    "content"
    class URLPDFSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    type: Literal["document"]
    Accepts one of the following:
    "document"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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: Optional[CitationsConfigParam]
    enabled: Optional[bool]
    context: Optional[str]
    minLength1
    title: Optional[str]
    maxLength500
    minLength1
    is_error: Optional[bool]
    class ToolTextEditor20250124: …
    name: Literal["str_replace_editor"]

    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"
    type: Literal["text_editor_20250124"]
    Accepts one of the following:
    "text_editor_20250124"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class ToolTextEditor20250429: …
    name: Literal["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.

    Accepts one of the following:
    "str_replace_based_edit_tool"
    type: Literal["text_editor_20250429"]
    Accepts one of the following:
    "text_editor_20250429"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class ToolTextEditor20250728: …
    name: Literal["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.

    Accepts one of the following:
    "str_replace_based_edit_tool"
    type: Literal["text_editor_20250728"]
    Accepts one of the following:
    "text_editor_20250728"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    max_characters: Optional[int]

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

    minimum1
    ToolUnion = ToolUnion
    Accepts one of the following:
    class Tool: …
    input_schema: 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: Literal["object"]
    Accepts one of the following:
    "object"
    properties: Optional[Dict[str, object]]
    required: Optional[List[str]]
    name: str

    Name of the tool.

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

    maxLength128
    minLength1
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    description: Optional[str]

    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[Literal["custom"]]
    Accepts one of the following:
    "custom"
    class ToolBash20250124: …
    name: Literal["bash"]

    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"
    type: Literal["bash_20250124"]
    Accepts one of the following:
    "bash_20250124"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class ToolTextEditor20250124: …
    name: Literal["str_replace_editor"]

    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"
    type: Literal["text_editor_20250124"]
    Accepts one of the following:
    "text_editor_20250124"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class ToolTextEditor20250429: …
    name: Literal["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.

    Accepts one of the following:
    "str_replace_based_edit_tool"
    type: Literal["text_editor_20250429"]
    Accepts one of the following:
    "text_editor_20250429"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class ToolTextEditor20250728: …
    name: Literal["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.

    Accepts one of the following:
    "str_replace_based_edit_tool"
    type: Literal["text_editor_20250728"]
    Accepts one of the following:
    "text_editor_20250728"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    max_characters: Optional[int]

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

    minimum1
    class WebSearchTool20250305: …
    name: Literal["web_search"]

    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"
    type: Literal["web_search_20250305"]
    Accepts one of the following:
    "web_search_20250305"
    allowed_domains: Optional[List[str]]

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

    blocked_domains: Optional[List[str]]

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

    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    max_uses: Optional[int]

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

    exclusiveMinimum0
    user_location: Optional[UserLocation]

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

    type: Literal["approximate"]
    Accepts one of the following:
    "approximate"
    city: Optional[str]

    The city of the user.

    maxLength255
    minLength1
    country: Optional[str]

    The two letter ISO country code of the user.

    maxLength2
    minLength2
    region: Optional[str]

    The region of the user.

    maxLength255
    minLength1
    timezone: Optional[str]

    The IANA timezone of the user.

    maxLength255
    minLength1
    class ToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str
    minLength1
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    class ToolUseBlockParam: …
    id: str
    input: Dict[str, object]
    name: str
    maxLength200
    minLength1
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    class URLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class URLPDFSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class Usage: …
    cache_creation: Optional[CacheCreation]

    Breakdown of cached tokens by TTL

    ephemeral_1h_input_tokens: int

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

    minimum0
    ephemeral_5m_input_tokens: int

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

    minimum0
    cache_creation_input_tokens: Optional[int]

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

    minimum0
    cache_read_input_tokens: Optional[int]

    The number of input tokens read from the cache.

    minimum0
    input_tokens: int

    The number of input tokens which were used.

    minimum0
    output_tokens: int

    The number of output tokens which were used.

    minimum0
    server_tool_use: Optional[ServerToolUsage]

    The number of server tool requests.

    web_search_requests: int

    The number of web search tool requests.

    minimum0
    service_tier: Optional[Literal["standard", "priority", "batch"]]

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

    Accepts one of the following:
    "standard"
    "priority"
    "batch"
    class WebSearchResultBlock: …
    encrypted_content: str
    page_age: Optional[str]
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    class WebSearchResultBlockParam: …
    encrypted_content: str
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    page_age: Optional[str]
    class WebSearchTool20250305: …
    name: Literal["web_search"]

    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"
    type: Literal["web_search_20250305"]
    Accepts one of the following:
    "web_search_20250305"
    allowed_domains: Optional[List[str]]

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

    blocked_domains: Optional[List[str]]

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

    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    max_uses: Optional[int]

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

    exclusiveMinimum0
    user_location: Optional[UserLocation]

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

    type: Literal["approximate"]
    Accepts one of the following:
    "approximate"
    city: Optional[str]

    The city of the user.

    maxLength255
    minLength1
    country: Optional[str]

    The two letter ISO country code of the user.

    maxLength2
    minLength2
    region: Optional[str]

    The region of the user.

    maxLength255
    minLength1
    timezone: Optional[str]

    The IANA timezone of the user.

    maxLength255
    minLength1
    class WebSearchToolRequestError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"
    class WebSearchToolResultBlock: …
    content: WebSearchToolResultBlockContent
    Accepts one of the following:
    class WebSearchToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"
    UnionMember1 = List[WebSearchResultBlock]
    encrypted_content: str
    page_age: Optional[str]
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    tool_use_id: str
    type: Literal["web_search_tool_result"]
    Accepts one of the following:
    "web_search_tool_result"
    WebSearchToolResultBlockContent = WebSearchToolResultBlockContent
    Accepts one of the following:
    class WebSearchToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"
    UnionMember1 = List[WebSearchResultBlock]
    encrypted_content: str
    page_age: Optional[str]
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    class WebSearchToolResultBlockParam: …
    content: WebSearchToolResultBlockParamContent
    Accepts one of the following:
    WebSearchToolResultBlockItem = List[WebSearchResultBlockParam]
    encrypted_content: str
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    page_age: Optional[str]
    class WebSearchToolRequestError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"
    tool_use_id: str
    type: Literal["web_search_tool_result"]
    Accepts one of the following:
    "web_search_tool_result"
    cache_control: Optional[CacheControlEphemeral]

    Create a cache control breakpoint at this content block.

    type: Literal["ephemeral"]
    Accepts one of the following:
    "ephemeral"
    ttl: Optional[Literal["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"
    WebSearchToolResultBlockParamContent = WebSearchToolResultBlockParamContent
    Accepts one of the following:
    WebSearchToolResultBlockItem = List[WebSearchResultBlockParam]
    encrypted_content: str
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    page_age: Optional[str]
    class WebSearchToolRequestError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"
    class WebSearchToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"

    MessagesBatches

    Cancel a Message Batch
    messages.batches.cancel(strmessage_batch_id) -> MessageBatch
    post/v1/messages/batches/{message_batch_id}/cancel
    Create a Message Batch
    messages.batches.create(BatchCreateParams**kwargs) -> MessageBatch
    post/v1/messages/batches
    Delete a Message Batch
    messages.batches.delete(strmessage_batch_id) -> DeletedMessageBatch
    delete/v1/messages/batches/{message_batch_id}
    List Message Batches
    messages.batches.list(BatchListParams**kwargs) -> SyncPage[MessageBatch]
    get/v1/messages/batches
    Retrieve Message Batch results
    messages.batches.results(strmessage_batch_id) -> MessageBatchIndividualResponse
    get/v1/messages/batches/{message_batch_id}/results
    Retrieve a Message Batch
    messages.batches.retrieve(strmessage_batch_id) -> MessageBatch
    get/v1/messages/batches/{message_batch_id}
    ModelsExpand Collapse
    class DeletedMessageBatch: …
    id: str

    ID of the Message Batch.

    type: Literal["message_batch_deleted"]

    Deleted object type.

    For Message Batches, this is always "message_batch_deleted".

    Accepts one of the following:
    "message_batch_deleted"
    class MessageBatch: …
    id: str

    Unique object identifier.

    The format and length of IDs may change over time.

    archived_at: Optional[datetime]

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

    formatdate-time
    cancel_initiated_at: Optional[datetime]

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

    formatdate-time
    created_at: datetime

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

    formatdate-time
    ended_at: Optional[datetime]

    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
    expires_at: datetime

    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
    processing_status: Literal["in_progress", "canceling", "ended"]

    Processing status of the Message Batch.

    Accepts one of the following:
    "in_progress"
    "canceling"
    "ended"
    request_counts: 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: int

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

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

    errored: int

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

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

    expired: int

    Number of requests in the Message Batch that have expired.

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

    processing: int

    Number of requests in the Message Batch that are processing.

    succeeded: int

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

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

    results_url: Optional[str]

    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: Literal["message_batch"]

    Object type.

    For Message Batches, this is always "message_batch".

    Accepts one of the following:
    "message_batch"
    class MessageBatchCanceledResult: …
    type: Literal["canceled"]
    Accepts one of the following:
    "canceled"
    class MessageBatchErroredResult: …
    error: ErrorResponse
    error: ErrorObject
    Accepts one of the following:
    class InvalidRequestError: …
    message: str
    type: Literal["invalid_request_error"]
    Accepts one of the following:
    "invalid_request_error"
    class AuthenticationError: …
    message: str
    type: Literal["authentication_error"]
    Accepts one of the following:
    "authentication_error"
    class BillingError: …
    message: str
    type: Literal["billing_error"]
    Accepts one of the following:
    "billing_error"
    class PermissionError: …
    message: str
    type: Literal["permission_error"]
    Accepts one of the following:
    "permission_error"
    class NotFoundError: …
    message: str
    type: Literal["not_found_error"]
    Accepts one of the following:
    "not_found_error"
    class RateLimitError: …
    message: str
    type: Literal["rate_limit_error"]
    Accepts one of the following:
    "rate_limit_error"
    class GatewayTimeoutError: …
    message: str
    type: Literal["timeout_error"]
    Accepts one of the following:
    "timeout_error"
    class APIErrorObject: …
    message: str
    type: Literal["api_error"]
    Accepts one of the following:
    "api_error"
    class OverloadedError: …
    message: str
    type: Literal["overloaded_error"]
    Accepts one of the following:
    "overloaded_error"
    request_id: Optional[str]
    type: Literal["error"]
    Accepts one of the following:
    "error"
    type: Literal["errored"]
    Accepts one of the following:
    "errored"
    class MessageBatchExpiredResult: …
    type: Literal["expired"]
    Accepts one of the following:
    "expired"
    class MessageBatchIndividualResponse: …

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

    custom_id: str

    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.

    result: MessageBatchResult

    Processing result for this request.

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

    Accepts one of the following:
    class MessageBatchSucceededResult: …
    message: Message
    id: str

    Unique object identifier.

    The format and length of IDs may change over time.

    content: List[ContentBlock]

    Content generated by the model.

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

    Example:

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

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

    For example, if the input messages were:

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

    Then the response content might be:

    [{"type": "text", "text": "B)"}]
    Accepts one of the following:
    class TextBlock: …
    citations: Optional[List[TextCitation]]

    Citations supporting the text block.

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

    Accepts one of the following:
    class CitationCharLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class CitationsSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    maxLength5000000
    minLength0
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class ThinkingBlock: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class RedactedThinkingBlock: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class ToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str
    minLength1
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    class ServerToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: Literal["web_search"]
    Accepts one of the following:
    "web_search"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    class WebSearchToolResultBlock: …
    content: WebSearchToolResultBlockContent
    Accepts one of the following:
    class WebSearchToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"
    UnionMember1 = List[WebSearchResultBlock]
    encrypted_content: str
    page_age: Optional[str]
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    tool_use_id: str
    type: Literal["web_search_tool_result"]
    Accepts one of the following:
    "web_search_tool_result"
    model: Model

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]

    The model that will complete your prompt.

    See models for additional details and options.

    • claude-3-7-sonnet-latest - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-7-sonnet-20250219 - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • 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 - Deprecated: Will reach end-of-life on January 5th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-opus-20240229 - Deprecated: Will reach end-of-life on January 5th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-haiku-20240307 - Our previous most fast and cost-effective
    Accepts one of the following:
    "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

    UnionMember1 = str
    role: Literal["assistant"]

    Conversational role of the generated message.

    This will always be "assistant".

    Accepts one of the following:
    "assistant"
    stop_reason: Optional[StopReason]

    The reason that we stopped.

    This may be one the following values:

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

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

    Accepts one of the following:
    "end_turn"
    "max_tokens"
    "stop_sequence"
    "tool_use"
    "pause_turn"
    "refusal"
    stop_sequence: Optional[str]

    Which custom stop sequence was generated, if any.

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

    type: Literal["message"]

    Object type.

    For Messages, this is always "message".

    Accepts one of the following:
    "message"
    usage: Usage

    Billing and rate-limit usage.

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

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

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

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

    cache_creation: Optional[CacheCreation]

    Breakdown of cached tokens by TTL

    ephemeral_1h_input_tokens: int

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

    minimum0
    ephemeral_5m_input_tokens: int

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

    minimum0
    cache_creation_input_tokens: Optional[int]

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

    minimum0
    cache_read_input_tokens: Optional[int]

    The number of input tokens read from the cache.

    minimum0
    input_tokens: int

    The number of input tokens which were used.

    minimum0
    output_tokens: int

    The number of output tokens which were used.

    minimum0
    server_tool_use: Optional[ServerToolUsage]

    The number of server tool requests.

    web_search_requests: int

    The number of web search tool requests.

    minimum0
    service_tier: Optional[Literal["standard", "priority", "batch"]]

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

    Accepts one of the following:
    "standard"
    "priority"
    "batch"
    type: Literal["succeeded"]
    Accepts one of the following:
    "succeeded"
    class MessageBatchErroredResult: …
    error: ErrorResponse
    error: ErrorObject
    Accepts one of the following:
    class InvalidRequestError: …
    message: str
    type: Literal["invalid_request_error"]
    Accepts one of the following:
    "invalid_request_error"
    class AuthenticationError: …
    message: str
    type: Literal["authentication_error"]
    Accepts one of the following:
    "authentication_error"
    class BillingError: …
    message: str
    type: Literal["billing_error"]
    Accepts one of the following:
    "billing_error"
    class PermissionError: …
    message: str
    type: Literal["permission_error"]
    Accepts one of the following:
    "permission_error"
    class NotFoundError: …
    message: str
    type: Literal["not_found_error"]
    Accepts one of the following:
    "not_found_error"
    class RateLimitError: …
    message: str
    type: Literal["rate_limit_error"]
    Accepts one of the following:
    "rate_limit_error"
    class GatewayTimeoutError: …
    message: str
    type: Literal["timeout_error"]
    Accepts one of the following:
    "timeout_error"
    class APIErrorObject: …
    message: str
    type: Literal["api_error"]
    Accepts one of the following:
    "api_error"
    class OverloadedError: …
    message: str
    type: Literal["overloaded_error"]
    Accepts one of the following:
    "overloaded_error"
    request_id: Optional[str]
    type: Literal["error"]
    Accepts one of the following:
    "error"
    type: Literal["errored"]
    Accepts one of the following:
    "errored"
    class MessageBatchCanceledResult: …
    type: Literal["canceled"]
    Accepts one of the following:
    "canceled"
    class MessageBatchExpiredResult: …
    type: Literal["expired"]
    Accepts one of the following:
    "expired"
    class MessageBatchRequestCounts: …
    canceled: int

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

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

    errored: int

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

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

    expired: int

    Number of requests in the Message Batch that have expired.

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

    processing: int

    Number of requests in the Message Batch that are processing.

    succeeded: int

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

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

    MessageBatchResult = MessageBatchResult

    Processing result for this request.

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

    Accepts one of the following:
    class MessageBatchSucceededResult: …
    message: Message
    id: str

    Unique object identifier.

    The format and length of IDs may change over time.

    content: List[ContentBlock]

    Content generated by the model.

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

    Example:

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

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

    For example, if the input messages were:

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

    Then the response content might be:

    [{"type": "text", "text": "B)"}]
    Accepts one of the following:
    class TextBlock: …
    citations: Optional[List[TextCitation]]

    Citations supporting the text block.

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

    Accepts one of the following:
    class CitationCharLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class CitationsSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    maxLength5000000
    minLength0
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class ThinkingBlock: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class RedactedThinkingBlock: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class ToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str
    minLength1
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    class ServerToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: Literal["web_search"]
    Accepts one of the following:
    "web_search"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    class WebSearchToolResultBlock: …
    content: WebSearchToolResultBlockContent
    Accepts one of the following:
    class WebSearchToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"
    UnionMember1 = List[WebSearchResultBlock]
    encrypted_content: str
    page_age: Optional[str]
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    tool_use_id: str
    type: Literal["web_search_tool_result"]
    Accepts one of the following:
    "web_search_tool_result"
    model: Model

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]

    The model that will complete your prompt.

    See models for additional details and options.

    • claude-3-7-sonnet-latest - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-7-sonnet-20250219 - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • 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 - Deprecated: Will reach end-of-life on January 5th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-opus-20240229 - Deprecated: Will reach end-of-life on January 5th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-haiku-20240307 - Our previous most fast and cost-effective
    Accepts one of the following:
    "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

    UnionMember1 = str
    role: Literal["assistant"]

    Conversational role of the generated message.

    This will always be "assistant".

    Accepts one of the following:
    "assistant"
    stop_reason: Optional[StopReason]

    The reason that we stopped.

    This may be one the following values:

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

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

    Accepts one of the following:
    "end_turn"
    "max_tokens"
    "stop_sequence"
    "tool_use"
    "pause_turn"
    "refusal"
    stop_sequence: Optional[str]

    Which custom stop sequence was generated, if any.

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

    type: Literal["message"]

    Object type.

    For Messages, this is always "message".

    Accepts one of the following:
    "message"
    usage: Usage

    Billing and rate-limit usage.

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

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

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

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

    cache_creation: Optional[CacheCreation]

    Breakdown of cached tokens by TTL

    ephemeral_1h_input_tokens: int

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

    minimum0
    ephemeral_5m_input_tokens: int

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

    minimum0
    cache_creation_input_tokens: Optional[int]

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

    minimum0
    cache_read_input_tokens: Optional[int]

    The number of input tokens read from the cache.

    minimum0
    input_tokens: int

    The number of input tokens which were used.

    minimum0
    output_tokens: int

    The number of output tokens which were used.

    minimum0
    server_tool_use: Optional[ServerToolUsage]

    The number of server tool requests.

    web_search_requests: int

    The number of web search tool requests.

    minimum0
    service_tier: Optional[Literal["standard", "priority", "batch"]]

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

    Accepts one of the following:
    "standard"
    "priority"
    "batch"
    type: Literal["succeeded"]
    Accepts one of the following:
    "succeeded"
    class MessageBatchErroredResult: …
    error: ErrorResponse
    error: ErrorObject
    Accepts one of the following:
    class InvalidRequestError: …
    message: str
    type: Literal["invalid_request_error"]
    Accepts one of the following:
    "invalid_request_error"
    class AuthenticationError: …
    message: str
    type: Literal["authentication_error"]
    Accepts one of the following:
    "authentication_error"
    class BillingError: …
    message: str
    type: Literal["billing_error"]
    Accepts one of the following:
    "billing_error"
    class PermissionError: …
    message: str
    type: Literal["permission_error"]
    Accepts one of the following:
    "permission_error"
    class NotFoundError: …
    message: str
    type: Literal["not_found_error"]
    Accepts one of the following:
    "not_found_error"
    class RateLimitError: …
    message: str
    type: Literal["rate_limit_error"]
    Accepts one of the following:
    "rate_limit_error"
    class GatewayTimeoutError: …
    message: str
    type: Literal["timeout_error"]
    Accepts one of the following:
    "timeout_error"
    class APIErrorObject: …
    message: str
    type: Literal["api_error"]
    Accepts one of the following:
    "api_error"
    class OverloadedError: …
    message: str
    type: Literal["overloaded_error"]
    Accepts one of the following:
    "overloaded_error"
    request_id: Optional[str]
    type: Literal["error"]
    Accepts one of the following:
    "error"
    type: Literal["errored"]
    Accepts one of the following:
    "errored"
    class MessageBatchCanceledResult: …
    type: Literal["canceled"]
    Accepts one of the following:
    "canceled"
    class MessageBatchExpiredResult: …
    type: Literal["expired"]
    Accepts one of the following:
    "expired"
    class MessageBatchSucceededResult: …
    message: Message
    id: str

    Unique object identifier.

    The format and length of IDs may change over time.

    content: List[ContentBlock]

    Content generated by the model.

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

    Example:

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

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

    For example, if the input messages were:

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

    Then the response content might be:

    [{"type": "text", "text": "B)"}]
    Accepts one of the following:
    class TextBlock: …
    citations: Optional[List[TextCitation]]

    Citations supporting the text block.

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

    Accepts one of the following:
    class CitationCharLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    minimum0
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class CitationPageLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    minimum1
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class CitationContentBlockLocation: …
    cited_text: str
    document_index: int
    minimum0
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    minimum0
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class CitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    maxLength512
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class CitationsSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    minimum0
    source: str
    start_block_index: int
    minimum0
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    maxLength5000000
    minLength0
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class ThinkingBlock: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class RedactedThinkingBlock: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class ToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str
    minLength1
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    class ServerToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: Literal["web_search"]
    Accepts one of the following:
    "web_search"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    class WebSearchToolResultBlock: …
    content: WebSearchToolResultBlockContent
    Accepts one of the following:
    class WebSearchToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "max_uses_exceeded"
    "too_many_requests"
    "query_too_long"
    type: Literal["web_search_tool_result_error"]
    Accepts one of the following:
    "web_search_tool_result_error"
    UnionMember1 = List[WebSearchResultBlock]
    encrypted_content: str
    page_age: Optional[str]
    title: str
    type: Literal["web_search_result"]
    Accepts one of the following:
    "web_search_result"
    url: str
    tool_use_id: str
    type: Literal["web_search_tool_result"]
    Accepts one of the following:
    "web_search_tool_result"
    model: Model

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]

    The model that will complete your prompt.

    See models for additional details and options.

    • claude-3-7-sonnet-latest - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-7-sonnet-20250219 - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • 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 - Deprecated: Will reach end-of-life on January 5th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-opus-20240229 - Deprecated: Will reach end-of-life on January 5th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
    • claude-3-haiku-20240307 - Our previous most fast and cost-effective
    Accepts one of the following:
    "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

    UnionMember1 = str
    role: Literal["assistant"]

    Conversational role of the generated message.

    This will always be "assistant".

    Accepts one of the following:
    "assistant"
    stop_reason: Optional[StopReason]

    The reason that we stopped.

    This may be one the following values:

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

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

    Accepts one of the following:
    "end_turn"
    "max_tokens"
    "stop_sequence"
    "tool_use"
    "pause_turn"
    "refusal"
    stop_sequence: Optional[str]

    Which custom stop sequence was generated, if any.

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

    type: Literal["message"]

    Object type.

    For Messages, this is always "message".

    Accepts one of the following:
    "message"
    usage: Usage

    Billing and rate-limit usage.

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

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

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

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

    cache_creation: Optional[CacheCreation]

    Breakdown of cached tokens by TTL

    ephemeral_1h_input_tokens: int

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

    minimum0
    ephemeral_5m_input_tokens: int

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

    minimum0
    cache_creation_input_tokens: Optional[int]

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

    minimum0
    cache_read_input_tokens: Optional[int]

    The number of input tokens read from the cache.

    minimum0
    input_tokens: int

    The number of input tokens which were used.

    minimum0
    output_tokens: int

    The number of output tokens which were used.

    minimum0
    server_tool_use: Optional[ServerToolUsage]

    The number of server tool requests.

    web_search_requests: int

    The number of web search tool requests.

    minimum0
    service_tier: Optional[Literal["standard", "priority", "batch"]]

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

    Accepts one of the following:
    "standard"
    "priority"
    "batch"
    type: Literal["succeeded"]
    Accepts one of the following:
    "succeeded"
    © 2025 ANTHROPIC PBC

    Products

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

    Features

    • Claude and Slack
    • Claude in Excel

    Models

    • Opus
    • Sonnet
    • Haiku

    Solutions

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

    Claude Developer Platform

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

    Learn

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

    Company

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

    Help and security

    • Availability
    • Status
    • Support center

    Terms and policies

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

    Products

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

    Features

    • Claude and Slack
    • Claude in Excel

    Models

    • Opus
    • Sonnet
    • Haiku

    Solutions

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

    Claude Developer Platform

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

    Learn

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

    Company

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

    Help and security

    • Availability
    • Status
    • Support center

    Terms and policies

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