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
    Models
    List Models
    Get a Model
    Beta
    Create a Message
    Count tokens in a Message
    Admin
    Completions
    Create a Text Completion
    Support & configuration
    Rate limitsService tiersVersionsIP addressesSupported regionsOpenAI SDK compatibility
    Console
    Log in

    Messages

    Create a Message
    beta.messages.create(MessageCreateParams**kwargs) -> BetaMessage
    post/v1/messages
    Count tokens in a Message
    beta.messages.count_tokens(MessageCountTokensParams**kwargs) -> BetaMessageTokensCount
    post/v1/messages/count_tokens
    ModelsExpand Collapse
    class BetaAllThinkingTurns: …
    type: Literal["all"]
    Accepts one of the following:
    "all"
    class BetaBase64ImageSource: …
    data: str
    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 BetaBase64PDFSource: …
    data: str
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class BetaBashCodeExecutionOutputBlock: …
    file_id: str
    type: Literal["bash_code_execution_output"]
    Accepts one of the following:
    "bash_code_execution_output"
    class BetaBashCodeExecutionOutputBlockParam: …
    file_id: str
    type: Literal["bash_code_execution_output"]
    Accepts one of the following:
    "bash_code_execution_output"
    class BetaBashCodeExecutionResultBlock: …
    content: List[BetaBashCodeExecutionOutputBlock]
    file_id: str
    type: Literal["bash_code_execution_output"]
    Accepts one of the following:
    "bash_code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["bash_code_execution_result"]
    Accepts one of the following:
    "bash_code_execution_result"
    class BetaBashCodeExecutionResultBlockParam: …
    content: List[BetaBashCodeExecutionOutputBlockParam]
    file_id: str
    type: Literal["bash_code_execution_output"]
    Accepts one of the following:
    "bash_code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["bash_code_execution_result"]
    Accepts one of the following:
    "bash_code_execution_result"
    class BetaBashCodeExecutionToolResultBlock: …
    content: Content
    Accepts one of the following:
    class BetaBashCodeExecutionToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    "output_file_too_large"
    type: Literal["bash_code_execution_tool_result_error"]
    Accepts one of the following:
    "bash_code_execution_tool_result_error"
    class BetaBashCodeExecutionResultBlock: …
    content: List[BetaBashCodeExecutionOutputBlock]
    file_id: str
    type: Literal["bash_code_execution_output"]
    Accepts one of the following:
    "bash_code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["bash_code_execution_result"]
    Accepts one of the following:
    "bash_code_execution_result"
    tool_use_id: str
    type: Literal["bash_code_execution_tool_result"]
    Accepts one of the following:
    "bash_code_execution_tool_result"
    class BetaBashCodeExecutionToolResultBlockParam: …
    content: Content
    Accepts one of the following:
    class BetaBashCodeExecutionToolResultErrorParam: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    "output_file_too_large"
    type: Literal["bash_code_execution_tool_result_error"]
    Accepts one of the following:
    "bash_code_execution_tool_result_error"
    class BetaBashCodeExecutionResultBlockParam: …
    content: List[BetaBashCodeExecutionOutputBlockParam]
    file_id: str
    type: Literal["bash_code_execution_output"]
    Accepts one of the following:
    "bash_code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["bash_code_execution_result"]
    Accepts one of the following:
    "bash_code_execution_result"
    tool_use_id: str
    type: Literal["bash_code_execution_tool_result"]
    Accepts one of the following:
    "bash_code_execution_tool_result"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaBashCodeExecutionToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    "output_file_too_large"
    type: Literal["bash_code_execution_tool_result_error"]
    Accepts one of the following:
    "bash_code_execution_tool_result_error"
    class BetaBashCodeExecutionToolResultErrorParam: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    "output_file_too_large"
    type: Literal["bash_code_execution_tool_result_error"]
    Accepts one of the following:
    "bash_code_execution_tool_result_error"
    class BetaCacheControlEphemeral: …
    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 BetaCacheCreation: …
    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 BetaCitationCharLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationConfig: …
    enabled: bool
    class BetaCitationContentBlockLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationPageLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationsConfigParam: …
    enabled: Optional[bool]
    class BetaCitationsDelta: …
    citation: Citation
    Accepts one of the following:
    class BetaCitationCharLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    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 BetaCitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaClearThinking20251015Edit: …
    type: Literal["clear_thinking_20251015"]
    Accepts one of the following:
    "clear_thinking_20251015"
    keep: Optional[Keep]

    Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.

    Accepts one of the following:
    class BetaThinkingTurns: …
    type: Literal["thinking_turns"]
    Accepts one of the following:
    "thinking_turns"
    value: int
    class BetaAllThinkingTurns: …
    type: Literal["all"]
    Accepts one of the following:
    "all"
    KeepUnionMember2 = Literal["all"]
    Accepts one of the following:
    "all"
    class BetaClearThinking20251015EditResponse: …
    cleared_input_tokens: int

    Number of input tokens cleared by this edit.

    minimum0
    cleared_thinking_turns: int

    Number of thinking turns that were cleared.

    minimum0
    type: Literal["clear_thinking_20251015"]

    The type of context management edit applied.

    Accepts one of the following:
    "clear_thinking_20251015"
    class BetaClearToolUses20250919Edit: …
    type: Literal["clear_tool_uses_20250919"]
    Accepts one of the following:
    "clear_tool_uses_20250919"
    clear_at_least: Optional[BetaInputTokensClearAtLeast]

    Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.

    type: Literal["input_tokens"]
    Accepts one of the following:
    "input_tokens"
    value: int
    clear_tool_inputs: Optional[Union[bool, List[str], null]]

    Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)

    Accepts one of the following:
    ClearToolInputsUnionMember0 = bool
    ClearToolInputsUnionMember1 = List[str]
    exclude_tools: Optional[List[str]]

    Tool names whose uses are preserved from clearing

    keep: Optional[BetaToolUsesKeep]

    Number of tool uses to retain in the conversation

    type: Literal["tool_uses"]
    Accepts one of the following:
    "tool_uses"
    value: int
    trigger: Optional[Trigger]

    Condition that triggers the context management strategy

    Accepts one of the following:
    class BetaInputTokensTrigger: …
    type: Literal["input_tokens"]
    Accepts one of the following:
    "input_tokens"
    value: int
    class BetaToolUsesTrigger: …
    type: Literal["tool_uses"]
    Accepts one of the following:
    "tool_uses"
    value: int
    class BetaClearToolUses20250919EditResponse: …
    cleared_input_tokens: int

    Number of input tokens cleared by this edit.

    minimum0
    cleared_tool_uses: int

    Number of tool uses that were cleared.

    minimum0
    type: Literal["clear_tool_uses_20250919"]

    The type of context management edit applied.

    Accepts one of the following:
    "clear_tool_uses_20250919"
    class BetaCodeExecutionOutputBlock: …
    file_id: str
    type: Literal["code_execution_output"]
    Accepts one of the following:
    "code_execution_output"
    class BetaCodeExecutionOutputBlockParam: …
    file_id: str
    type: Literal["code_execution_output"]
    Accepts one of the following:
    "code_execution_output"
    class BetaCodeExecutionResultBlock: …
    content: List[BetaCodeExecutionOutputBlock]
    file_id: str
    type: Literal["code_execution_output"]
    Accepts one of the following:
    "code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["code_execution_result"]
    Accepts one of the following:
    "code_execution_result"
    class BetaCodeExecutionResultBlockParam: …
    content: List[BetaCodeExecutionOutputBlockParam]
    file_id: str
    type: Literal["code_execution_output"]
    Accepts one of the following:
    "code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["code_execution_result"]
    Accepts one of the following:
    "code_execution_result"
    class BetaCodeExecutionTool20250522: …
    name: Literal["code_execution"]

    Name of the tool.

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

    Accepts one of the following:
    "code_execution"
    type: Literal["code_execution_20250522"]
    Accepts one of the following:
    "code_execution_20250522"
    allowed_callers: Optional[List[Literal["direct", "code_execution_20250825"]]]
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    cache_control: Optional[BetaCacheControlEphemeral]

    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"
    defer_loading: Optional[bool]

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

    strict: Optional[bool]
    class BetaCodeExecutionTool20250825: …
    name: Literal["code_execution"]

    Name of the tool.

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

    Accepts one of the following:
    "code_execution"
    type: Literal["code_execution_20250825"]
    Accepts one of the following:
    "code_execution_20250825"
    allowed_callers: Optional[List[Literal["direct", "code_execution_20250825"]]]
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    cache_control: Optional[BetaCacheControlEphemeral]

    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"
    defer_loading: Optional[bool]

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

    strict: Optional[bool]
    class BetaCodeExecutionToolResultBlock: …
    content: BetaCodeExecutionToolResultBlockContent
    Accepts one of the following:
    class BetaCodeExecutionToolResultError: …
    error_code: BetaCodeExecutionToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    type: Literal["code_execution_tool_result_error"]
    Accepts one of the following:
    "code_execution_tool_result_error"
    class BetaCodeExecutionResultBlock: …
    content: List[BetaCodeExecutionOutputBlock]
    file_id: str
    type: Literal["code_execution_output"]
    Accepts one of the following:
    "code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["code_execution_result"]
    Accepts one of the following:
    "code_execution_result"
    tool_use_id: str
    type: Literal["code_execution_tool_result"]
    Accepts one of the following:
    "code_execution_tool_result"
    BetaCodeExecutionToolResultBlockContent = BetaCodeExecutionToolResultBlockContent
    Accepts one of the following:
    class BetaCodeExecutionToolResultError: …
    error_code: BetaCodeExecutionToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    type: Literal["code_execution_tool_result_error"]
    Accepts one of the following:
    "code_execution_tool_result_error"
    class BetaCodeExecutionResultBlock: …
    content: List[BetaCodeExecutionOutputBlock]
    file_id: str
    type: Literal["code_execution_output"]
    Accepts one of the following:
    "code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["code_execution_result"]
    Accepts one of the following:
    "code_execution_result"
    class BetaCodeExecutionToolResultBlockParam: …
    content: BetaCodeExecutionToolResultBlockParamContent
    Accepts one of the following:
    class BetaCodeExecutionToolResultErrorParam: …
    error_code: BetaCodeExecutionToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    type: Literal["code_execution_tool_result_error"]
    Accepts one of the following:
    "code_execution_tool_result_error"
    class BetaCodeExecutionResultBlockParam: …
    content: List[BetaCodeExecutionOutputBlockParam]
    file_id: str
    type: Literal["code_execution_output"]
    Accepts one of the following:
    "code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["code_execution_result"]
    Accepts one of the following:
    "code_execution_result"
    tool_use_id: str
    type: Literal["code_execution_tool_result"]
    Accepts one of the following:
    "code_execution_tool_result"
    cache_control: Optional[BetaCacheControlEphemeral]

    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"
    BetaCodeExecutionToolResultBlockParamContent = BetaCodeExecutionToolResultBlockParamContent
    Accepts one of the following:
    class BetaCodeExecutionToolResultErrorParam: …
    error_code: BetaCodeExecutionToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    type: Literal["code_execution_tool_result_error"]
    Accepts one of the following:
    "code_execution_tool_result_error"
    class BetaCodeExecutionResultBlockParam: …
    content: List[BetaCodeExecutionOutputBlockParam]
    file_id: str
    type: Literal["code_execution_output"]
    Accepts one of the following:
    "code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["code_execution_result"]
    Accepts one of the following:
    "code_execution_result"
    class BetaCodeExecutionToolResultError: …
    error_code: BetaCodeExecutionToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    type: Literal["code_execution_tool_result_error"]
    Accepts one of the following:
    "code_execution_tool_result_error"
    BetaCodeExecutionToolResultErrorCode = Literal["invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded"]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    class BetaCodeExecutionToolResultErrorParam: …
    error_code: BetaCodeExecutionToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    type: Literal["code_execution_tool_result_error"]
    Accepts one of the following:
    "code_execution_tool_result_error"
    class BetaContainer: …

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

    id: str

    Identifier for the container used in this request

    expires_at: datetime

    The time at which the container will expire.

    formatdate-time
    skills: Optional[List[BetaSkill]]

    Skills loaded in the container

    skill_id: str

    Skill ID

    maxLength64
    minLength1
    type: Literal["anthropic", "custom"]

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

    Accepts one of the following:
    "anthropic"
    "custom"
    version: str

    Skill version or 'latest' for most recent version

    maxLength64
    minLength1
    class BetaContainerParams: …

    Container parameters with skills to be loaded.

    id: Optional[str]

    Container id

    skills: Optional[List[BetaSkillParams]]

    List of skills to load in the container

    skill_id: str

    Skill ID

    maxLength64
    minLength1
    type: Literal["anthropic", "custom"]

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

    Accepts one of the following:
    "anthropic"
    "custom"
    version: Optional[str]

    Skill version or 'latest' for most recent version

    maxLength64
    minLength1
    class BetaContainerUploadBlock: …

    Response model for a file uploaded to the container.

    file_id: str
    type: Literal["container_upload"]
    Accepts one of the following:
    "container_upload"
    class BetaContainerUploadBlockParam: …

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

    file_id: str
    type: Literal["container_upload"]
    Accepts one of the following:
    "container_upload"
    cache_control: Optional[BetaCacheControlEphemeral]

    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"
    BetaContentBlock = BetaContentBlock

    Response model for a file uploaded to the container.

    Accepts one of the following:
    class BetaTextBlock: …
    citations: Optional[List[BetaTextCitation]]

    Citations supporting the text block.

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

    Accepts one of the following:
    class BetaCitationCharLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class BetaThinkingBlock: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class BetaRedactedThinkingBlock: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class BetaToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    caller: Optional[Caller]

    Tool invocation directly from the model.

    Accepts one of the following:
    class BetaDirectCaller: …

    Tool invocation directly from the model.

    type: Literal["direct"]
    Accepts one of the following:
    "direct"
    class BetaServerToolCaller: …

    Tool invocation generated by a server-side tool.

    tool_id: str
    type: Literal["code_execution_20250825"]
    Accepts one of the following:
    "code_execution_20250825"
    class BetaServerToolUseBlock: …
    id: str
    caller: Caller

    Tool invocation directly from the model.

    Accepts one of the following:
    class BetaDirectCaller: …

    Tool invocation directly from the model.

    type: Literal["direct"]
    Accepts one of the following:
    "direct"
    class BetaServerToolCaller: …

    Tool invocation generated by a server-side tool.

    tool_id: str
    type: Literal["code_execution_20250825"]
    Accepts one of the following:
    "code_execution_20250825"
    input: Dict[str, object]
    name: Literal["web_search", "web_fetch", "code_execution", 4 more]
    Accepts one of the following:
    "web_search"
    "web_fetch"
    "code_execution"
    "bash_code_execution"
    "text_editor_code_execution"
    "tool_search_tool_regex"
    "tool_search_tool_bm25"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    class BetaWebSearchToolResultBlock: …
    content: BetaWebSearchToolResultBlockContent
    Accepts one of the following:
    class BetaWebSearchToolResultError: …
    error_code: BetaWebSearchToolResultErrorCode
    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[BetaWebSearchResultBlock]
    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"
    class BetaWebFetchToolResultBlock: …
    content: Content
    Accepts one of the following:
    class BetaWebFetchToolResultErrorBlock: …
    error_code: BetaWebFetchToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "url_too_long"
    "url_not_allowed"
    "url_not_accessible"
    "unsupported_content_type"
    "too_many_requests"
    "max_uses_exceeded"
    "unavailable"
    type: Literal["web_fetch_tool_result_error"]
    Accepts one of the following:
    "web_fetch_tool_result_error"
    class BetaWebFetchBlock: …
    content: BetaDocumentBlock
    citations: Optional[BetaCitationConfig]

    Citation configuration for the document

    enabled: bool
    source: Source
    Accepts one of the following:
    class BetaBase64PDFSource: …
    data: str
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class BetaPlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    title: Optional[str]

    The title of the document

    type: Literal["document"]
    Accepts one of the following:
    "document"
    retrieved_at: Optional[str]

    ISO 8601 timestamp when the content was retrieved

    type: Literal["web_fetch_result"]
    Accepts one of the following:
    "web_fetch_result"
    url: str

    Fetched content URL

    tool_use_id: str
    type: Literal["web_fetch_tool_result"]
    Accepts one of the following:
    "web_fetch_tool_result"
    class BetaCodeExecutionToolResultBlock: …
    content: BetaCodeExecutionToolResultBlockContent
    Accepts one of the following:
    class BetaCodeExecutionToolResultError: …
    error_code: BetaCodeExecutionToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    type: Literal["code_execution_tool_result_error"]
    Accepts one of the following:
    "code_execution_tool_result_error"
    class BetaCodeExecutionResultBlock: …
    content: List[BetaCodeExecutionOutputBlock]
    file_id: str
    type: Literal["code_execution_output"]
    Accepts one of the following:
    "code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["code_execution_result"]
    Accepts one of the following:
    "code_execution_result"
    tool_use_id: str
    type: Literal["code_execution_tool_result"]
    Accepts one of the following:
    "code_execution_tool_result"
    class BetaBashCodeExecutionToolResultBlock: …
    content: Content
    Accepts one of the following:
    class BetaBashCodeExecutionToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    "output_file_too_large"
    type: Literal["bash_code_execution_tool_result_error"]
    Accepts one of the following:
    "bash_code_execution_tool_result_error"
    class BetaBashCodeExecutionResultBlock: …
    content: List[BetaBashCodeExecutionOutputBlock]
    file_id: str
    type: Literal["bash_code_execution_output"]
    Accepts one of the following:
    "bash_code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["bash_code_execution_result"]
    Accepts one of the following:
    "bash_code_execution_result"
    tool_use_id: str
    type: Literal["bash_code_execution_tool_result"]
    Accepts one of the following:
    "bash_code_execution_tool_result"
    class BetaTextEditorCodeExecutionToolResultBlock: …
    content: Content
    Accepts one of the following:
    class BetaTextEditorCodeExecutionToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    "file_not_found"
    error_message: Optional[str]
    type: Literal["text_editor_code_execution_tool_result_error"]
    Accepts one of the following:
    "text_editor_code_execution_tool_result_error"
    class BetaTextEditorCodeExecutionViewResultBlock: …
    content: str
    file_type: Literal["text", "image", "pdf"]
    Accepts one of the following:
    "text"
    "image"
    "pdf"
    num_lines: Optional[int]
    start_line: Optional[int]
    total_lines: Optional[int]
    type: Literal["text_editor_code_execution_view_result"]
    Accepts one of the following:
    "text_editor_code_execution_view_result"
    class BetaTextEditorCodeExecutionCreateResultBlock: …
    is_file_update: bool
    type: Literal["text_editor_code_execution_create_result"]
    Accepts one of the following:
    "text_editor_code_execution_create_result"
    class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
    lines: Optional[List[str]]
    new_lines: Optional[int]
    new_start: Optional[int]
    old_lines: Optional[int]
    old_start: Optional[int]
    type: Literal["text_editor_code_execution_str_replace_result"]
    Accepts one of the following:
    "text_editor_code_execution_str_replace_result"
    tool_use_id: str
    type: Literal["text_editor_code_execution_tool_result"]
    Accepts one of the following:
    "text_editor_code_execution_tool_result"
    class BetaToolSearchToolResultBlock: …
    content: Content
    Accepts one of the following:
    class BetaToolSearchToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded"]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    error_message: Optional[str]
    type: Literal["tool_search_tool_result_error"]
    Accepts one of the following:
    "tool_search_tool_result_error"
    class BetaToolSearchToolSearchResultBlock: …
    tool_references: List[BetaToolReferenceBlock]
    tool_name: str
    type: Literal["tool_reference"]
    Accepts one of the following:
    "tool_reference"
    type: Literal["tool_search_tool_search_result"]
    Accepts one of the following:
    "tool_search_tool_search_result"
    tool_use_id: str
    type: Literal["tool_search_tool_result"]
    Accepts one of the following:
    "tool_search_tool_result"
    class BetaMCPToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str

    The name of the MCP tool

    server_name: str

    The name of the MCP server

    type: Literal["mcp_tool_use"]
    Accepts one of the following:
    "mcp_tool_use"
    class BetaMCPToolResultBlock: …
    content: Union[str, List[BetaTextBlock]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentBetaMCPToolResultBlockContent = List[BetaTextBlock]
    citations: Optional[List[BetaTextCitation]]

    Citations supporting the text block.

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

    Accepts one of the following:
    class BetaCitationCharLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    is_error: bool
    tool_use_id: str
    type: Literal["mcp_tool_result"]
    Accepts one of the following:
    "mcp_tool_result"
    class BetaContainerUploadBlock: …

    Response model for a file uploaded to the container.

    file_id: str
    type: Literal["container_upload"]
    Accepts one of the following:
    "container_upload"
    BetaContentBlockParam = BetaContentBlockParam

    Regular text content.

    Accepts one of the following:
    class BetaTextBlockParam: …
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class BetaImageBlockParam: …
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource: …
    data: str
    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 BetaURLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileImageSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaRequestDocumentBlock: …
    source: Source
    Accepts one of the following:
    class BetaBase64PDFSource: …
    data: str
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class BetaPlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class BetaContentBlockSource: …
    content: Union[str, List[BetaContentBlockSourceContent]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentBetaContentBlockSourceContent = List[BetaContentBlockSourceContent]
    Accepts one of the following:
    class BetaTextBlockParam: …
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class BetaImageBlockParam: …
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource: …
    data: str
    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 BetaURLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileImageSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaURLPDFSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileDocumentSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["document"]
    Accepts one of the following:
    "document"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaCitationsConfigParam]
    enabled: Optional[bool]
    context: Optional[str]
    title: Optional[str]
    class BetaSearchResultBlockParam: …
    content: List[BetaTextBlockParam]
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    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[BetaCacheControlEphemeral]

    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[BetaCitationsConfigParam]
    enabled: Optional[bool]
    class BetaThinkingBlockParam: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class BetaRedactedThinkingBlockParam: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class BetaToolUseBlockParam: …
    id: str
    input: Dict[str, object]
    name: str
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    cache_control: Optional[BetaCacheControlEphemeral]

    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"
    caller: Optional[Caller]

    Tool invocation directly from the model.

    Accepts one of the following:
    class BetaDirectCaller: …

    Tool invocation directly from the model.

    type: Literal["direct"]
    Accepts one of the following:
    "direct"
    class BetaServerToolCaller: …

    Tool invocation generated by a server-side tool.

    tool_id: str
    type: Literal["code_execution_20250825"]
    Accepts one of the following:
    "code_execution_20250825"
    class BetaToolResultBlockParam: …
    tool_use_id: str
    type: Literal["tool_result"]
    Accepts one of the following:
    "tool_result"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaTextBlockParam: …
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class BetaImageBlockParam: …
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource: …
    data: str
    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 BetaURLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileImageSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaSearchResultBlockParam: …
    content: List[BetaTextBlockParam]
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    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[BetaCacheControlEphemeral]

    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[BetaCitationsConfigParam]
    enabled: Optional[bool]
    class BetaRequestDocumentBlock: …
    source: Source
    Accepts one of the following:
    class BetaBase64PDFSource: …
    data: str
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class BetaPlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class BetaContentBlockSource: …
    content: Union[str, List[BetaContentBlockSourceContent]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentBetaContentBlockSourceContent = List[BetaContentBlockSourceContent]
    Accepts one of the following:
    class BetaTextBlockParam: …
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class BetaImageBlockParam: …
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource: …
    data: str
    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 BetaURLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileImageSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaURLPDFSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileDocumentSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["document"]
    Accepts one of the following:
    "document"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaCitationsConfigParam]
    enabled: Optional[bool]
    context: Optional[str]
    title: Optional[str]
    class BetaToolReferenceBlockParam: …

    Tool reference block that can be included in tool_result content.

    tool_name: str
    type: Literal["tool_reference"]
    Accepts one of the following:
    "tool_reference"
    cache_control: Optional[BetaCacheControlEphemeral]

    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"
    is_error: Optional[bool]
    class BetaServerToolUseBlockParam: …
    id: str
    input: Dict[str, object]
    name: Literal["web_search", "web_fetch", "code_execution", 4 more]
    Accepts one of the following:
    "web_search"
    "web_fetch"
    "code_execution"
    "bash_code_execution"
    "text_editor_code_execution"
    "tool_search_tool_regex"
    "tool_search_tool_bm25"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    cache_control: Optional[BetaCacheControlEphemeral]

    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"
    caller: Optional[Caller]

    Tool invocation directly from the model.

    Accepts one of the following:
    class BetaDirectCaller: …

    Tool invocation directly from the model.

    type: Literal["direct"]
    Accepts one of the following:
    "direct"
    class BetaServerToolCaller: …

    Tool invocation generated by a server-side tool.

    tool_id: str
    type: Literal["code_execution_20250825"]
    Accepts one of the following:
    "code_execution_20250825"
    class BetaWebSearchToolResultBlockParam: …
    content: BetaWebSearchToolResultBlockParamContent
    Accepts one of the following:
    ResultBlock = List[BetaWebSearchResultBlockParam]
    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 BetaWebSearchToolRequestError: …
    error_code: BetaWebSearchToolResultErrorCode
    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[BetaCacheControlEphemeral]

    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 BetaWebFetchToolResultBlockParam: …
    content: Content
    Accepts one of the following:
    class BetaWebFetchToolResultErrorBlockParam: …
    error_code: BetaWebFetchToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "url_too_long"
    "url_not_allowed"
    "url_not_accessible"
    "unsupported_content_type"
    "too_many_requests"
    "max_uses_exceeded"
    "unavailable"
    type: Literal["web_fetch_tool_result_error"]
    Accepts one of the following:
    "web_fetch_tool_result_error"
    class BetaWebFetchBlockParam: …
    content: BetaRequestDocumentBlock
    source: Source
    Accepts one of the following:
    class BetaBase64PDFSource: …
    data: str
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class BetaPlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class BetaContentBlockSource: …
    content: Union[str, List[BetaContentBlockSourceContent]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentBetaContentBlockSourceContent = List[BetaContentBlockSourceContent]
    Accepts one of the following:
    class BetaTextBlockParam: …
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class BetaImageBlockParam: …
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource: …
    data: str
    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 BetaURLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileImageSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaURLPDFSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileDocumentSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["document"]
    Accepts one of the following:
    "document"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaCitationsConfigParam]
    enabled: Optional[bool]
    context: Optional[str]
    title: Optional[str]
    type: Literal["web_fetch_result"]
    Accepts one of the following:
    "web_fetch_result"
    url: str

    Fetched content URL

    retrieved_at: Optional[str]

    ISO 8601 timestamp when the content was retrieved

    tool_use_id: str
    type: Literal["web_fetch_tool_result"]
    Accepts one of the following:
    "web_fetch_tool_result"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaCodeExecutionToolResultBlockParam: …
    content: BetaCodeExecutionToolResultBlockParamContent
    Accepts one of the following:
    class BetaCodeExecutionToolResultErrorParam: …
    error_code: BetaCodeExecutionToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    type: Literal["code_execution_tool_result_error"]
    Accepts one of the following:
    "code_execution_tool_result_error"
    class BetaCodeExecutionResultBlockParam: …
    content: List[BetaCodeExecutionOutputBlockParam]
    file_id: str
    type: Literal["code_execution_output"]
    Accepts one of the following:
    "code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["code_execution_result"]
    Accepts one of the following:
    "code_execution_result"
    tool_use_id: str
    type: Literal["code_execution_tool_result"]
    Accepts one of the following:
    "code_execution_tool_result"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaBashCodeExecutionToolResultBlockParam: …
    content: Content
    Accepts one of the following:
    class BetaBashCodeExecutionToolResultErrorParam: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    "output_file_too_large"
    type: Literal["bash_code_execution_tool_result_error"]
    Accepts one of the following:
    "bash_code_execution_tool_result_error"
    class BetaBashCodeExecutionResultBlockParam: …
    content: List[BetaBashCodeExecutionOutputBlockParam]
    file_id: str
    type: Literal["bash_code_execution_output"]
    Accepts one of the following:
    "bash_code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["bash_code_execution_result"]
    Accepts one of the following:
    "bash_code_execution_result"
    tool_use_id: str
    type: Literal["bash_code_execution_tool_result"]
    Accepts one of the following:
    "bash_code_execution_tool_result"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaTextEditorCodeExecutionToolResultBlockParam: …
    content: Content
    Accepts one of the following:
    class BetaTextEditorCodeExecutionToolResultErrorParam: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    "file_not_found"
    type: Literal["text_editor_code_execution_tool_result_error"]
    Accepts one of the following:
    "text_editor_code_execution_tool_result_error"
    error_message: Optional[str]
    class BetaTextEditorCodeExecutionViewResultBlockParam: …
    content: str
    file_type: Literal["text", "image", "pdf"]
    Accepts one of the following:
    "text"
    "image"
    "pdf"
    type: Literal["text_editor_code_execution_view_result"]
    Accepts one of the following:
    "text_editor_code_execution_view_result"
    num_lines: Optional[int]
    start_line: Optional[int]
    total_lines: Optional[int]
    class BetaTextEditorCodeExecutionCreateResultBlockParam: …
    is_file_update: bool
    type: Literal["text_editor_code_execution_create_result"]
    Accepts one of the following:
    "text_editor_code_execution_create_result"
    class BetaTextEditorCodeExecutionStrReplaceResultBlockParam: …
    type: Literal["text_editor_code_execution_str_replace_result"]
    Accepts one of the following:
    "text_editor_code_execution_str_replace_result"
    lines: Optional[List[str]]
    new_lines: Optional[int]
    new_start: Optional[int]
    old_lines: Optional[int]
    old_start: Optional[int]
    tool_use_id: str
    type: Literal["text_editor_code_execution_tool_result"]
    Accepts one of the following:
    "text_editor_code_execution_tool_result"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaToolSearchToolResultBlockParam: …
    content: Content
    Accepts one of the following:
    class BetaToolSearchToolResultErrorParam: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded"]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    type: Literal["tool_search_tool_result_error"]
    Accepts one of the following:
    "tool_search_tool_result_error"
    class BetaToolSearchToolSearchResultBlockParam: …
    tool_references: List[BetaToolReferenceBlockParam]
    tool_name: str
    type: Literal["tool_reference"]
    Accepts one of the following:
    "tool_reference"
    cache_control: Optional[BetaCacheControlEphemeral]

    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["tool_search_tool_search_result"]
    Accepts one of the following:
    "tool_search_tool_search_result"
    tool_use_id: str
    type: Literal["tool_search_tool_result"]
    Accepts one of the following:
    "tool_search_tool_result"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaMCPToolUseBlockParam: …
    id: str
    input: Dict[str, object]
    name: str
    server_name: str

    The name of the MCP server

    type: Literal["mcp_tool_use"]
    Accepts one of the following:
    "mcp_tool_use"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaRequestMCPToolResultBlockParam: …
    tool_use_id: str
    type: Literal["mcp_tool_result"]
    Accepts one of the following:
    "mcp_tool_result"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextBlockParam], null]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentBetaMCPToolResultBlockParamContent = List[BetaTextBlockParam]
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    is_error: Optional[bool]
    class BetaContainerUploadBlockParam: …

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

    file_id: str
    type: Literal["container_upload"]
    Accepts one of the following:
    "container_upload"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaContentBlockSource: …
    content: Union[str, List[BetaContentBlockSourceContent]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentBetaContentBlockSourceContent = List[BetaContentBlockSourceContent]
    Accepts one of the following:
    class BetaTextBlockParam: …
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class BetaImageBlockParam: …
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource: …
    data: str
    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 BetaURLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileImageSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[BetaCacheControlEphemeral]

    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"
    BetaContentBlockSourceContent = BetaContentBlockSourceContent
    Accepts one of the following:
    class BetaTextBlockParam: …
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class BetaImageBlockParam: …
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource: …
    data: str
    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 BetaURLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileImageSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaContextManagementConfig: …
    edits: Optional[List[Edit]]

    List of context management edits to apply

    Accepts one of the following:
    class BetaClearToolUses20250919Edit: …
    type: Literal["clear_tool_uses_20250919"]
    Accepts one of the following:
    "clear_tool_uses_20250919"
    clear_at_least: Optional[BetaInputTokensClearAtLeast]

    Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed.

    type: Literal["input_tokens"]
    Accepts one of the following:
    "input_tokens"
    value: int
    clear_tool_inputs: Optional[Union[bool, List[str], null]]

    Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)

    Accepts one of the following:
    ClearToolInputsUnionMember0 = bool
    ClearToolInputsUnionMember1 = List[str]
    exclude_tools: Optional[List[str]]

    Tool names whose uses are preserved from clearing

    keep: Optional[BetaToolUsesKeep]

    Number of tool uses to retain in the conversation

    type: Literal["tool_uses"]
    Accepts one of the following:
    "tool_uses"
    value: int
    trigger: Optional[Trigger]

    Condition that triggers the context management strategy

    Accepts one of the following:
    class BetaInputTokensTrigger: …
    type: Literal["input_tokens"]
    Accepts one of the following:
    "input_tokens"
    value: int
    class BetaToolUsesTrigger: …
    type: Literal["tool_uses"]
    Accepts one of the following:
    "tool_uses"
    value: int
    class BetaClearThinking20251015Edit: …
    type: Literal["clear_thinking_20251015"]
    Accepts one of the following:
    "clear_thinking_20251015"
    keep: Optional[Keep]

    Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.

    Accepts one of the following:
    class BetaThinkingTurns: …
    type: Literal["thinking_turns"]
    Accepts one of the following:
    "thinking_turns"
    value: int
    class BetaAllThinkingTurns: …
    type: Literal["all"]
    Accepts one of the following:
    "all"
    KeepUnionMember2 = Literal["all"]
    Accepts one of the following:
    "all"
    class BetaContextManagementResponse: …
    applied_edits: List[AppliedEdit]

    List of context management edits that were applied.

    Accepts one of the following:
    class BetaClearToolUses20250919EditResponse: …
    cleared_input_tokens: int

    Number of input tokens cleared by this edit.

    minimum0
    cleared_tool_uses: int

    Number of tool uses that were cleared.

    minimum0
    type: Literal["clear_tool_uses_20250919"]

    The type of context management edit applied.

    Accepts one of the following:
    "clear_tool_uses_20250919"
    class BetaClearThinking20251015EditResponse: …
    cleared_input_tokens: int

    Number of input tokens cleared by this edit.

    minimum0
    cleared_thinking_turns: int

    Number of thinking turns that were cleared.

    minimum0
    type: Literal["clear_thinking_20251015"]

    The type of context management edit applied.

    Accepts one of the following:
    "clear_thinking_20251015"
    class BetaCountTokensContextManagementResponse: …
    original_input_tokens: int

    The original token count before context management was applied

    class BetaDirectCaller: …

    Tool invocation directly from the model.

    type: Literal["direct"]
    Accepts one of the following:
    "direct"
    class BetaDocumentBlock: …
    citations: Optional[BetaCitationConfig]

    Citation configuration for the document

    enabled: bool
    source: Source
    Accepts one of the following:
    class BetaBase64PDFSource: …
    data: str
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class BetaPlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    title: Optional[str]

    The title of the document

    type: Literal["document"]
    Accepts one of the following:
    "document"
    class BetaFileDocumentSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    class BetaFileImageSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    class BetaImageBlockParam: …
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource: …
    data: str
    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 BetaURLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileImageSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaInputJSONDelta: …
    partial_json: str
    type: Literal["input_json_delta"]
    Accepts one of the following:
    "input_json_delta"
    class BetaInputTokensClearAtLeast: …
    type: Literal["input_tokens"]
    Accepts one of the following:
    "input_tokens"
    value: int
    class BetaInputTokensTrigger: …
    type: Literal["input_tokens"]
    Accepts one of the following:
    "input_tokens"
    value: int
    class BetaJSONOutputFormat: …
    schema: Dict[str, object]

    The JSON schema of the format

    type: Literal["json_schema"]
    Accepts one of the following:
    "json_schema"
    class BetaMCPToolConfig: …

    Configuration for a specific tool in an MCP toolset.

    defer_loading: Optional[bool]
    enabled: Optional[bool]
    class BetaMCPToolDefaultConfig: …

    Default configuration for tools in an MCP toolset.

    defer_loading: Optional[bool]
    enabled: Optional[bool]
    class BetaMCPToolResultBlock: …
    content: Union[str, List[BetaTextBlock]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentBetaMCPToolResultBlockContent = List[BetaTextBlock]
    citations: Optional[List[BetaTextCitation]]

    Citations supporting the text block.

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

    Accepts one of the following:
    class BetaCitationCharLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    is_error: bool
    tool_use_id: str
    type: Literal["mcp_tool_result"]
    Accepts one of the following:
    "mcp_tool_result"
    class BetaMCPToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str

    The name of the MCP tool

    server_name: str

    The name of the MCP server

    type: Literal["mcp_tool_use"]
    Accepts one of the following:
    "mcp_tool_use"
    class BetaMCPToolUseBlockParam: …
    id: str
    input: Dict[str, object]
    name: str
    server_name: str

    The name of the MCP server

    type: Literal["mcp_tool_use"]
    Accepts one of the following:
    "mcp_tool_use"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaMCPToolset: …

    Configuration for a group of tools from an MCP server.

    Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides.

    mcp_server_name: str

    Name of the MCP server to configure tools for

    maxLength255
    minLength1
    type: Literal["mcp_toolset"]
    Accepts one of the following:
    "mcp_toolset"
    cache_control: Optional[BetaCacheControlEphemeral]

    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"
    configs: Optional[Dict[str, BetaMCPToolConfig]]

    Configuration overrides for specific tools, keyed by tool name

    defer_loading: Optional[bool]
    enabled: Optional[bool]
    default_config: Optional[BetaMCPToolDefaultConfig]

    Default configuration applied to all tools from this server

    defer_loading: Optional[bool]
    enabled: Optional[bool]
    class BetaMemoryTool20250818: …
    name: Literal["memory"]

    Name of the tool.

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

    Accepts one of the following:
    "memory"
    type: Literal["memory_20250818"]
    Accepts one of the following:
    "memory_20250818"
    allowed_callers: Optional[List[Literal["direct", "code_execution_20250825"]]]
    Accepts one of the following:
    "direct"
    "code_execution_20250825"
    cache_control: Optional[BetaCacheControlEphemeral]

    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"
    defer_loading: Optional[bool]

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

    input_examples: Optional[List[Dict[str, object]]]
    strict: Optional[bool]
    BetaMemoryTool20250818Command = BetaMemoryTool20250818Command
    Accepts one of the following:
    class BetaMemoryTool20250818ViewCommand: …
    command: Literal["view"]

    Command type identifier

    Accepts one of the following:
    "view"
    path: str

    Path to directory or file to view

    view_range: Optional[List[int]]

    Optional line range for viewing specific lines

    class BetaMemoryTool20250818CreateCommand: …
    command: Literal["create"]

    Command type identifier

    Accepts one of the following:
    "create"
    file_text: str

    Content to write to the file

    path: str

    Path where the file should be created

    class BetaMemoryTool20250818StrReplaceCommand: …
    command: Literal["str_replace"]

    Command type identifier

    Accepts one of the following:
    "str_replace"
    new_str: str

    Text to replace with

    old_str: str

    Text to search for and replace

    path: str

    Path to the file where text should be replaced

    class BetaMemoryTool20250818InsertCommand: …
    command: Literal["insert"]

    Command type identifier

    Accepts one of the following:
    "insert"
    insert_line: int

    Line number where text should be inserted

    minimum1
    insert_text: str

    Text to insert at the specified line

    path: str

    Path to the file where text should be inserted

    class BetaMemoryTool20250818DeleteCommand: …
    command: Literal["delete"]

    Command type identifier

    Accepts one of the following:
    "delete"
    path: str

    Path to the file or directory to delete

    class BetaMemoryTool20250818RenameCommand: …
    command: Literal["rename"]

    Command type identifier

    Accepts one of the following:
    "rename"
    new_path: str

    New path for the file or directory

    old_path: str

    Current path of the file or directory

    class BetaMemoryTool20250818CreateCommand: …
    command: Literal["create"]

    Command type identifier

    Accepts one of the following:
    "create"
    file_text: str

    Content to write to the file

    path: str

    Path where the file should be created

    class BetaMemoryTool20250818DeleteCommand: …
    command: Literal["delete"]

    Command type identifier

    Accepts one of the following:
    "delete"
    path: str

    Path to the file or directory to delete

    class BetaMemoryTool20250818InsertCommand: …
    command: Literal["insert"]

    Command type identifier

    Accepts one of the following:
    "insert"
    insert_line: int

    Line number where text should be inserted

    minimum1
    insert_text: str

    Text to insert at the specified line

    path: str

    Path to the file where text should be inserted

    class BetaMemoryTool20250818RenameCommand: …
    command: Literal["rename"]

    Command type identifier

    Accepts one of the following:
    "rename"
    new_path: str

    New path for the file or directory

    old_path: str

    Current path of the file or directory

    class BetaMemoryTool20250818StrReplaceCommand: …
    command: Literal["str_replace"]

    Command type identifier

    Accepts one of the following:
    "str_replace"
    new_str: str

    Text to replace with

    old_str: str

    Text to search for and replace

    path: str

    Path to the file where text should be replaced

    class BetaMemoryTool20250818ViewCommand: …
    command: Literal["view"]

    Command type identifier

    Accepts one of the following:
    "view"
    path: str

    Path to directory or file to view

    view_range: Optional[List[int]]

    Optional line range for viewing specific lines

    class BetaMessage: …
    id: str

    Unique object identifier.

    The format and length of IDs may change over time.

    container: Optional[BetaContainer]

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

    id: str

    Identifier for the container used in this request

    expires_at: datetime

    The time at which the container will expire.

    formatdate-time
    skills: Optional[List[BetaSkill]]

    Skills loaded in the container

    skill_id: str

    Skill ID

    maxLength64
    minLength1
    type: Literal["anthropic", "custom"]

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

    Accepts one of the following:
    "anthropic"
    "custom"
    version: str

    Skill version or 'latest' for most recent version

    maxLength64
    minLength1
    content: List[BetaContentBlock]

    Content generated by the model.

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

    Example:

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

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

    For example, if the input messages were:

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

    Then the response content might be:

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

    Citations supporting the text block.

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

    Accepts one of the following:
    class BetaCitationCharLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class BetaThinkingBlock: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class BetaRedactedThinkingBlock: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class BetaToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    caller: Optional[Caller]

    Tool invocation directly from the model.

    Accepts one of the following:
    class BetaDirectCaller: …

    Tool invocation directly from the model.

    type: Literal["direct"]
    Accepts one of the following:
    "direct"
    class BetaServerToolCaller: …

    Tool invocation generated by a server-side tool.

    tool_id: str
    type: Literal["code_execution_20250825"]
    Accepts one of the following:
    "code_execution_20250825"
    class BetaServerToolUseBlock: …
    id: str
    caller: Caller

    Tool invocation directly from the model.

    Accepts one of the following:
    class BetaDirectCaller: …

    Tool invocation directly from the model.

    type: Literal["direct"]
    Accepts one of the following:
    "direct"
    class BetaServerToolCaller: …

    Tool invocation generated by a server-side tool.

    tool_id: str
    type: Literal["code_execution_20250825"]
    Accepts one of the following:
    "code_execution_20250825"
    input: Dict[str, object]
    name: Literal["web_search", "web_fetch", "code_execution", 4 more]
    Accepts one of the following:
    "web_search"
    "web_fetch"
    "code_execution"
    "bash_code_execution"
    "text_editor_code_execution"
    "tool_search_tool_regex"
    "tool_search_tool_bm25"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    class BetaWebSearchToolResultBlock: …
    content: BetaWebSearchToolResultBlockContent
    Accepts one of the following:
    class BetaWebSearchToolResultError: …
    error_code: BetaWebSearchToolResultErrorCode
    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[BetaWebSearchResultBlock]
    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"
    class BetaWebFetchToolResultBlock: …
    content: Content
    Accepts one of the following:
    class BetaWebFetchToolResultErrorBlock: …
    error_code: BetaWebFetchToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "url_too_long"
    "url_not_allowed"
    "url_not_accessible"
    "unsupported_content_type"
    "too_many_requests"
    "max_uses_exceeded"
    "unavailable"
    type: Literal["web_fetch_tool_result_error"]
    Accepts one of the following:
    "web_fetch_tool_result_error"
    class BetaWebFetchBlock: …
    content: BetaDocumentBlock
    citations: Optional[BetaCitationConfig]

    Citation configuration for the document

    enabled: bool
    source: Source
    Accepts one of the following:
    class BetaBase64PDFSource: …
    data: str
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class BetaPlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    title: Optional[str]

    The title of the document

    type: Literal["document"]
    Accepts one of the following:
    "document"
    retrieved_at: Optional[str]

    ISO 8601 timestamp when the content was retrieved

    type: Literal["web_fetch_result"]
    Accepts one of the following:
    "web_fetch_result"
    url: str

    Fetched content URL

    tool_use_id: str
    type: Literal["web_fetch_tool_result"]
    Accepts one of the following:
    "web_fetch_tool_result"
    class BetaCodeExecutionToolResultBlock: …
    content: BetaCodeExecutionToolResultBlockContent
    Accepts one of the following:
    class BetaCodeExecutionToolResultError: …
    error_code: BetaCodeExecutionToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    type: Literal["code_execution_tool_result_error"]
    Accepts one of the following:
    "code_execution_tool_result_error"
    class BetaCodeExecutionResultBlock: …
    content: List[BetaCodeExecutionOutputBlock]
    file_id: str
    type: Literal["code_execution_output"]
    Accepts one of the following:
    "code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["code_execution_result"]
    Accepts one of the following:
    "code_execution_result"
    tool_use_id: str
    type: Literal["code_execution_tool_result"]
    Accepts one of the following:
    "code_execution_tool_result"
    class BetaBashCodeExecutionToolResultBlock: …
    content: Content
    Accepts one of the following:
    class BetaBashCodeExecutionToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    "output_file_too_large"
    type: Literal["bash_code_execution_tool_result_error"]
    Accepts one of the following:
    "bash_code_execution_tool_result_error"
    class BetaBashCodeExecutionResultBlock: …
    content: List[BetaBashCodeExecutionOutputBlock]
    file_id: str
    type: Literal["bash_code_execution_output"]
    Accepts one of the following:
    "bash_code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["bash_code_execution_result"]
    Accepts one of the following:
    "bash_code_execution_result"
    tool_use_id: str
    type: Literal["bash_code_execution_tool_result"]
    Accepts one of the following:
    "bash_code_execution_tool_result"
    class BetaTextEditorCodeExecutionToolResultBlock: …
    content: Content
    Accepts one of the following:
    class BetaTextEditorCodeExecutionToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    "file_not_found"
    error_message: Optional[str]
    type: Literal["text_editor_code_execution_tool_result_error"]
    Accepts one of the following:
    "text_editor_code_execution_tool_result_error"
    class BetaTextEditorCodeExecutionViewResultBlock: …
    content: str
    file_type: Literal["text", "image", "pdf"]
    Accepts one of the following:
    "text"
    "image"
    "pdf"
    num_lines: Optional[int]
    start_line: Optional[int]
    total_lines: Optional[int]
    type: Literal["text_editor_code_execution_view_result"]
    Accepts one of the following:
    "text_editor_code_execution_view_result"
    class BetaTextEditorCodeExecutionCreateResultBlock: …
    is_file_update: bool
    type: Literal["text_editor_code_execution_create_result"]
    Accepts one of the following:
    "text_editor_code_execution_create_result"
    class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
    lines: Optional[List[str]]
    new_lines: Optional[int]
    new_start: Optional[int]
    old_lines: Optional[int]
    old_start: Optional[int]
    type: Literal["text_editor_code_execution_str_replace_result"]
    Accepts one of the following:
    "text_editor_code_execution_str_replace_result"
    tool_use_id: str
    type: Literal["text_editor_code_execution_tool_result"]
    Accepts one of the following:
    "text_editor_code_execution_tool_result"
    class BetaToolSearchToolResultBlock: …
    content: Content
    Accepts one of the following:
    class BetaToolSearchToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded"]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    error_message: Optional[str]
    type: Literal["tool_search_tool_result_error"]
    Accepts one of the following:
    "tool_search_tool_result_error"
    class BetaToolSearchToolSearchResultBlock: …
    tool_references: List[BetaToolReferenceBlock]
    tool_name: str
    type: Literal["tool_reference"]
    Accepts one of the following:
    "tool_reference"
    type: Literal["tool_search_tool_search_result"]
    Accepts one of the following:
    "tool_search_tool_search_result"
    tool_use_id: str
    type: Literal["tool_search_tool_result"]
    Accepts one of the following:
    "tool_search_tool_result"
    class BetaMCPToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str

    The name of the MCP tool

    server_name: str

    The name of the MCP server

    type: Literal["mcp_tool_use"]
    Accepts one of the following:
    "mcp_tool_use"
    class BetaMCPToolResultBlock: …
    content: Union[str, List[BetaTextBlock]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentBetaMCPToolResultBlockContent = List[BetaTextBlock]
    citations: Optional[List[BetaTextCitation]]

    Citations supporting the text block.

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

    Accepts one of the following:
    class BetaCitationCharLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    is_error: bool
    tool_use_id: str
    type: Literal["mcp_tool_result"]
    Accepts one of the following:
    "mcp_tool_result"
    class BetaContainerUploadBlock: …

    Response model for a file uploaded to the container.

    file_id: str
    type: Literal["container_upload"]
    Accepts one of the following:
    "container_upload"
    context_management: Optional[BetaContextManagementResponse]

    Context management response.

    Information about context management strategies applied during the request.

    applied_edits: List[AppliedEdit]

    List of context management edits that were applied.

    Accepts one of the following:
    class BetaClearToolUses20250919EditResponse: …
    cleared_input_tokens: int

    Number of input tokens cleared by this edit.

    minimum0
    cleared_tool_uses: int

    Number of tool uses that were cleared.

    minimum0
    type: Literal["clear_tool_uses_20250919"]

    The type of context management edit applied.

    Accepts one of the following:
    "clear_tool_uses_20250919"
    class BetaClearThinking20251015EditResponse: …
    cleared_input_tokens: int

    Number of input tokens cleared by this edit.

    minimum0
    cleared_thinking_turns: int

    Number of thinking turns that were cleared.

    minimum0
    type: Literal["clear_thinking_20251015"]

    The type of context management edit applied.

    Accepts one of the following:
    "clear_thinking_20251015"
    model: Model

    The model that will complete your prompt.

    See models for additional details and options.

    Accepts one of the following:
    UnionMember0 = Literal["claude-opus-4-5-20251101", "claude-opus-4-5", "claude-3-7-sonnet-latest", 17 more]

    The model that will complete your prompt.

    See models for additional details and options.

    • claude-opus-4-5-20251101 - Premium model combining maximum intelligence with practical performance
    • claude-opus-4-5 - Premium model combining maximum intelligence with practical performance
    • claude-3-7-sonnet-latest - 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-opus-4-5-20251101"

    Premium model combining maximum intelligence with practical performance

    "claude-opus-4-5"

    Premium model combining maximum intelligence with practical performance

    "claude-3-7-sonnet-latest"

    High-performance model with early extended thinking

    "claude-3-7-sonnet-20250219"

    High-performance model with early extended thinking

    "claude-3-5-haiku-latest"

    Fastest and most compact model for near-instant responsiveness

    "claude-3-5-haiku-20241022"

    Our fastest model

    "claude-haiku-4-5"

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

    "claude-haiku-4-5-20251001"

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

    "claude-sonnet-4-20250514"

    High-performance model with extended thinking

    "claude-sonnet-4-0"

    High-performance model with extended thinking

    "claude-4-sonnet-20250514"

    High-performance model with extended thinking

    "claude-sonnet-4-5"

    Our best model for real-world agents and coding

    "claude-sonnet-4-5-20250929"

    Our best model for real-world agents and coding

    "claude-opus-4-0"

    Our most capable model

    "claude-opus-4-20250514"

    Our most capable model

    "claude-4-opus-20250514"

    Our most capable model

    "claude-opus-4-1-20250805"

    Our most capable model

    "claude-3-opus-latest"

    Excels at writing and complex tasks

    "claude-3-opus-20240229"

    Excels at writing and complex tasks

    "claude-3-haiku-20240307"

    Our previous most fast and cost-effective

    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[BetaStopReason]

    The reason that we stopped.

    This may be one the following values:

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

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

    Accepts one of the following:
    "end_turn"
    "max_tokens"
    "stop_sequence"
    "tool_use"
    "pause_turn"
    "refusal"
    "model_context_window_exceeded"
    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: BetaUsage

    Billing and rate-limit usage.

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

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

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

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

    cache_creation: Optional[BetaCacheCreation]

    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[BetaServerToolUsage]

    The number of server tool requests.

    web_fetch_requests: int

    The number of web fetch tool requests.

    minimum0
    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 BetaMessageDeltaUsage: …
    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[BetaServerToolUsage]

    The number of server tool requests.

    web_fetch_requests: int

    The number of web fetch tool requests.

    minimum0
    web_search_requests: int

    The number of web search tool requests.

    minimum0
    class BetaMessageParam: …
    content: Union[str, List[BetaContentBlockParam]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentUnionMember1 = List[BetaContentBlockParam]
    Accepts one of the following:
    class BetaTextBlockParam: …
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class BetaImageBlockParam: …
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource: …
    data: str
    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 BetaURLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileImageSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaRequestDocumentBlock: …
    source: Source
    Accepts one of the following:
    class BetaBase64PDFSource: …
    data: str
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class BetaPlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class BetaContentBlockSource: …
    content: Union[str, List[BetaContentBlockSourceContent]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentBetaContentBlockSourceContent = List[BetaContentBlockSourceContent]
    Accepts one of the following:
    class BetaTextBlockParam: …
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class BetaImageBlockParam: …
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource: …
    data: str
    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 BetaURLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileImageSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaURLPDFSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileDocumentSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["document"]
    Accepts one of the following:
    "document"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaCitationsConfigParam]
    enabled: Optional[bool]
    context: Optional[str]
    title: Optional[str]
    class BetaSearchResultBlockParam: …
    content: List[BetaTextBlockParam]
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    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[BetaCacheControlEphemeral]

    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[BetaCitationsConfigParam]
    enabled: Optional[bool]
    class BetaThinkingBlockParam: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class BetaRedactedThinkingBlockParam: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class BetaToolUseBlockParam: …
    id: str
    input: Dict[str, object]
    name: str
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    cache_control: Optional[BetaCacheControlEphemeral]

    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"
    caller: Optional[Caller]

    Tool invocation directly from the model.

    Accepts one of the following:
    class BetaDirectCaller: …

    Tool invocation directly from the model.

    type: Literal["direct"]
    Accepts one of the following:
    "direct"
    class BetaServerToolCaller: …

    Tool invocation generated by a server-side tool.

    tool_id: str
    type: Literal["code_execution_20250825"]
    Accepts one of the following:
    "code_execution_20250825"
    class BetaToolResultBlockParam: …
    tool_use_id: str
    type: Literal["tool_result"]
    Accepts one of the following:
    "tool_result"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaTextBlockParam: …
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class BetaImageBlockParam: …
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource: …
    data: str
    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 BetaURLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileImageSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaSearchResultBlockParam: …
    content: List[BetaTextBlockParam]
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    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[BetaCacheControlEphemeral]

    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[BetaCitationsConfigParam]
    enabled: Optional[bool]
    class BetaRequestDocumentBlock: …
    source: Source
    Accepts one of the following:
    class BetaBase64PDFSource: …
    data: str
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class BetaPlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class BetaContentBlockSource: …
    content: Union[str, List[BetaContentBlockSourceContent]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentBetaContentBlockSourceContent = List[BetaContentBlockSourceContent]
    Accepts one of the following:
    class BetaTextBlockParam: …
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class BetaImageBlockParam: …
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource: …
    data: str
    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 BetaURLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileImageSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaURLPDFSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileDocumentSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["document"]
    Accepts one of the following:
    "document"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaCitationsConfigParam]
    enabled: Optional[bool]
    context: Optional[str]
    title: Optional[str]
    class BetaToolReferenceBlockParam: …

    Tool reference block that can be included in tool_result content.

    tool_name: str
    type: Literal["tool_reference"]
    Accepts one of the following:
    "tool_reference"
    cache_control: Optional[BetaCacheControlEphemeral]

    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"
    is_error: Optional[bool]
    class BetaServerToolUseBlockParam: …
    id: str
    input: Dict[str, object]
    name: Literal["web_search", "web_fetch", "code_execution", 4 more]
    Accepts one of the following:
    "web_search"
    "web_fetch"
    "code_execution"
    "bash_code_execution"
    "text_editor_code_execution"
    "tool_search_tool_regex"
    "tool_search_tool_bm25"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    cache_control: Optional[BetaCacheControlEphemeral]

    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"
    caller: Optional[Caller]

    Tool invocation directly from the model.

    Accepts one of the following:
    class BetaDirectCaller: …

    Tool invocation directly from the model.

    type: Literal["direct"]
    Accepts one of the following:
    "direct"
    class BetaServerToolCaller: …

    Tool invocation generated by a server-side tool.

    tool_id: str
    type: Literal["code_execution_20250825"]
    Accepts one of the following:
    "code_execution_20250825"
    class BetaWebSearchToolResultBlockParam: …
    content: BetaWebSearchToolResultBlockParamContent
    Accepts one of the following:
    ResultBlock = List[BetaWebSearchResultBlockParam]
    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 BetaWebSearchToolRequestError: …
    error_code: BetaWebSearchToolResultErrorCode
    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[BetaCacheControlEphemeral]

    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 BetaWebFetchToolResultBlockParam: …
    content: Content
    Accepts one of the following:
    class BetaWebFetchToolResultErrorBlockParam: …
    error_code: BetaWebFetchToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "url_too_long"
    "url_not_allowed"
    "url_not_accessible"
    "unsupported_content_type"
    "too_many_requests"
    "max_uses_exceeded"
    "unavailable"
    type: Literal["web_fetch_tool_result_error"]
    Accepts one of the following:
    "web_fetch_tool_result_error"
    class BetaWebFetchBlockParam: …
    content: BetaRequestDocumentBlock
    source: Source
    Accepts one of the following:
    class BetaBase64PDFSource: …
    data: str
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class BetaPlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class BetaContentBlockSource: …
    content: Union[str, List[BetaContentBlockSourceContent]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentBetaContentBlockSourceContent = List[BetaContentBlockSourceContent]
    Accepts one of the following:
    class BetaTextBlockParam: …
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    class BetaImageBlockParam: …
    source: Source
    Accepts one of the following:
    class BetaBase64ImageSource: …
    data: str
    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 BetaURLImageSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileImageSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["image"]
    Accepts one of the following:
    "image"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaURLPDFSource: …
    type: Literal["url"]
    Accepts one of the following:
    "url"
    url: str
    class BetaFileDocumentSource: …
    file_id: str
    type: Literal["file"]
    Accepts one of the following:
    "file"
    type: Literal["document"]
    Accepts one of the following:
    "document"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaCitationsConfigParam]
    enabled: Optional[bool]
    context: Optional[str]
    title: Optional[str]
    type: Literal["web_fetch_result"]
    Accepts one of the following:
    "web_fetch_result"
    url: str

    Fetched content URL

    retrieved_at: Optional[str]

    ISO 8601 timestamp when the content was retrieved

    tool_use_id: str
    type: Literal["web_fetch_tool_result"]
    Accepts one of the following:
    "web_fetch_tool_result"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaCodeExecutionToolResultBlockParam: …
    content: BetaCodeExecutionToolResultBlockParamContent
    Accepts one of the following:
    class BetaCodeExecutionToolResultErrorParam: …
    error_code: BetaCodeExecutionToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    type: Literal["code_execution_tool_result_error"]
    Accepts one of the following:
    "code_execution_tool_result_error"
    class BetaCodeExecutionResultBlockParam: …
    content: List[BetaCodeExecutionOutputBlockParam]
    file_id: str
    type: Literal["code_execution_output"]
    Accepts one of the following:
    "code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["code_execution_result"]
    Accepts one of the following:
    "code_execution_result"
    tool_use_id: str
    type: Literal["code_execution_tool_result"]
    Accepts one of the following:
    "code_execution_tool_result"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaBashCodeExecutionToolResultBlockParam: …
    content: Content
    Accepts one of the following:
    class BetaBashCodeExecutionToolResultErrorParam: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    "output_file_too_large"
    type: Literal["bash_code_execution_tool_result_error"]
    Accepts one of the following:
    "bash_code_execution_tool_result_error"
    class BetaBashCodeExecutionResultBlockParam: …
    content: List[BetaBashCodeExecutionOutputBlockParam]
    file_id: str
    type: Literal["bash_code_execution_output"]
    Accepts one of the following:
    "bash_code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["bash_code_execution_result"]
    Accepts one of the following:
    "bash_code_execution_result"
    tool_use_id: str
    type: Literal["bash_code_execution_tool_result"]
    Accepts one of the following:
    "bash_code_execution_tool_result"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaTextEditorCodeExecutionToolResultBlockParam: …
    content: Content
    Accepts one of the following:
    class BetaTextEditorCodeExecutionToolResultErrorParam: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    "file_not_found"
    type: Literal["text_editor_code_execution_tool_result_error"]
    Accepts one of the following:
    "text_editor_code_execution_tool_result_error"
    error_message: Optional[str]
    class BetaTextEditorCodeExecutionViewResultBlockParam: …
    content: str
    file_type: Literal["text", "image", "pdf"]
    Accepts one of the following:
    "text"
    "image"
    "pdf"
    type: Literal["text_editor_code_execution_view_result"]
    Accepts one of the following:
    "text_editor_code_execution_view_result"
    num_lines: Optional[int]
    start_line: Optional[int]
    total_lines: Optional[int]
    class BetaTextEditorCodeExecutionCreateResultBlockParam: …
    is_file_update: bool
    type: Literal["text_editor_code_execution_create_result"]
    Accepts one of the following:
    "text_editor_code_execution_create_result"
    class BetaTextEditorCodeExecutionStrReplaceResultBlockParam: …
    type: Literal["text_editor_code_execution_str_replace_result"]
    Accepts one of the following:
    "text_editor_code_execution_str_replace_result"
    lines: Optional[List[str]]
    new_lines: Optional[int]
    new_start: Optional[int]
    old_lines: Optional[int]
    old_start: Optional[int]
    tool_use_id: str
    type: Literal["text_editor_code_execution_tool_result"]
    Accepts one of the following:
    "text_editor_code_execution_tool_result"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaToolSearchToolResultBlockParam: …
    content: Content
    Accepts one of the following:
    class BetaToolSearchToolResultErrorParam: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded"]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    type: Literal["tool_search_tool_result_error"]
    Accepts one of the following:
    "tool_search_tool_result_error"
    class BetaToolSearchToolSearchResultBlockParam: …
    tool_references: List[BetaToolReferenceBlockParam]
    tool_name: str
    type: Literal["tool_reference"]
    Accepts one of the following:
    "tool_reference"
    cache_control: Optional[BetaCacheControlEphemeral]

    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["tool_search_tool_search_result"]
    Accepts one of the following:
    "tool_search_tool_search_result"
    tool_use_id: str
    type: Literal["tool_search_tool_result"]
    Accepts one of the following:
    "tool_search_tool_result"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaMCPToolUseBlockParam: …
    id: str
    input: Dict[str, object]
    name: str
    server_name: str

    The name of the MCP server

    type: Literal["mcp_tool_use"]
    Accepts one of the following:
    "mcp_tool_use"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaRequestMCPToolResultBlockParam: …
    tool_use_id: str
    type: Literal["mcp_tool_result"]
    Accepts one of the following:
    "mcp_tool_result"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextBlockParam], null]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentBetaMCPToolResultBlockParamContent = List[BetaTextBlockParam]
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    cache_control: Optional[BetaCacheControlEphemeral]

    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[BetaTextCitationParam]]
    Accepts one of the following:
    class BetaCitationCharLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocationParam: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationWebSearchResultLocationParam: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocationParam: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    is_error: Optional[bool]
    class BetaContainerUploadBlockParam: …

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

    file_id: str
    type: Literal["container_upload"]
    Accepts one of the following:
    "container_upload"
    cache_control: Optional[BetaCacheControlEphemeral]

    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 BetaMessageTokensCount: …
    context_management: Optional[BetaCountTokensContextManagementResponse]

    Information about context management applied to the message.

    original_input_tokens: int

    The original token count before context management was applied

    input_tokens: int

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

    class BetaMetadata: …
    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
    class BetaOutputConfig: …
    effort: Optional[Literal["low", "medium", "high"]]

    All possible effort levels.

    Accepts one of the following:
    "low"
    "medium"
    "high"
    class BetaPlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    BetaRawContentBlockDelta = BetaRawContentBlockDelta
    Accepts one of the following:
    class BetaTextDelta: …
    text: str
    type: Literal["text_delta"]
    Accepts one of the following:
    "text_delta"
    class BetaInputJSONDelta: …
    partial_json: str
    type: Literal["input_json_delta"]
    Accepts one of the following:
    "input_json_delta"
    class BetaCitationsDelta: …
    citation: Citation
    Accepts one of the following:
    class BetaCitationCharLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    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 BetaThinkingDelta: …
    thinking: str
    type: Literal["thinking_delta"]
    Accepts one of the following:
    "thinking_delta"
    class BetaSignatureDelta: …
    signature: str
    type: Literal["signature_delta"]
    Accepts one of the following:
    "signature_delta"
    class BetaRawContentBlockDeltaEvent: …
    delta: BetaRawContentBlockDelta
    Accepts one of the following:
    class BetaTextDelta: …
    text: str
    type: Literal["text_delta"]
    Accepts one of the following:
    "text_delta"
    class BetaInputJSONDelta: …
    partial_json: str
    type: Literal["input_json_delta"]
    Accepts one of the following:
    "input_json_delta"
    class BetaCitationsDelta: …
    citation: Citation
    Accepts one of the following:
    class BetaCitationCharLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    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 BetaThinkingDelta: …
    thinking: str
    type: Literal["thinking_delta"]
    Accepts one of the following:
    "thinking_delta"
    class BetaSignatureDelta: …
    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 BetaRawContentBlockStartEvent: …
    content_block: ContentBlock

    Response model for a file uploaded to the container.

    Accepts one of the following:
    class BetaTextBlock: …
    citations: Optional[List[BetaTextCitation]]

    Citations supporting the text block.

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

    Accepts one of the following:
    class BetaCitationCharLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    class BetaThinkingBlock: …
    signature: str
    thinking: str
    type: Literal["thinking"]
    Accepts one of the following:
    "thinking"
    class BetaRedactedThinkingBlock: …
    data: str
    type: Literal["redacted_thinking"]
    Accepts one of the following:
    "redacted_thinking"
    class BetaToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str
    type: Literal["tool_use"]
    Accepts one of the following:
    "tool_use"
    caller: Optional[Caller]

    Tool invocation directly from the model.

    Accepts one of the following:
    class BetaDirectCaller: …

    Tool invocation directly from the model.

    type: Literal["direct"]
    Accepts one of the following:
    "direct"
    class BetaServerToolCaller: …

    Tool invocation generated by a server-side tool.

    tool_id: str
    type: Literal["code_execution_20250825"]
    Accepts one of the following:
    "code_execution_20250825"
    class BetaServerToolUseBlock: …
    id: str
    caller: Caller

    Tool invocation directly from the model.

    Accepts one of the following:
    class BetaDirectCaller: …

    Tool invocation directly from the model.

    type: Literal["direct"]
    Accepts one of the following:
    "direct"
    class BetaServerToolCaller: …

    Tool invocation generated by a server-side tool.

    tool_id: str
    type: Literal["code_execution_20250825"]
    Accepts one of the following:
    "code_execution_20250825"
    input: Dict[str, object]
    name: Literal["web_search", "web_fetch", "code_execution", 4 more]
    Accepts one of the following:
    "web_search"
    "web_fetch"
    "code_execution"
    "bash_code_execution"
    "text_editor_code_execution"
    "tool_search_tool_regex"
    "tool_search_tool_bm25"
    type: Literal["server_tool_use"]
    Accepts one of the following:
    "server_tool_use"
    class BetaWebSearchToolResultBlock: …
    content: BetaWebSearchToolResultBlockContent
    Accepts one of the following:
    class BetaWebSearchToolResultError: …
    error_code: BetaWebSearchToolResultErrorCode
    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[BetaWebSearchResultBlock]
    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"
    class BetaWebFetchToolResultBlock: …
    content: Content
    Accepts one of the following:
    class BetaWebFetchToolResultErrorBlock: …
    error_code: BetaWebFetchToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "url_too_long"
    "url_not_allowed"
    "url_not_accessible"
    "unsupported_content_type"
    "too_many_requests"
    "max_uses_exceeded"
    "unavailable"
    type: Literal["web_fetch_tool_result_error"]
    Accepts one of the following:
    "web_fetch_tool_result_error"
    class BetaWebFetchBlock: …
    content: BetaDocumentBlock
    citations: Optional[BetaCitationConfig]

    Citation configuration for the document

    enabled: bool
    source: Source
    Accepts one of the following:
    class BetaBase64PDFSource: …
    data: str
    media_type: Literal["application/pdf"]
    Accepts one of the following:
    "application/pdf"
    type: Literal["base64"]
    Accepts one of the following:
    "base64"
    class BetaPlainTextSource: …
    data: str
    media_type: Literal["text/plain"]
    Accepts one of the following:
    "text/plain"
    type: Literal["text"]
    Accepts one of the following:
    "text"
    title: Optional[str]

    The title of the document

    type: Literal["document"]
    Accepts one of the following:
    "document"
    retrieved_at: Optional[str]

    ISO 8601 timestamp when the content was retrieved

    type: Literal["web_fetch_result"]
    Accepts one of the following:
    "web_fetch_result"
    url: str

    Fetched content URL

    tool_use_id: str
    type: Literal["web_fetch_tool_result"]
    Accepts one of the following:
    "web_fetch_tool_result"
    class BetaCodeExecutionToolResultBlock: …
    content: BetaCodeExecutionToolResultBlockContent
    Accepts one of the following:
    class BetaCodeExecutionToolResultError: …
    error_code: BetaCodeExecutionToolResultErrorCode
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    type: Literal["code_execution_tool_result_error"]
    Accepts one of the following:
    "code_execution_tool_result_error"
    class BetaCodeExecutionResultBlock: …
    content: List[BetaCodeExecutionOutputBlock]
    file_id: str
    type: Literal["code_execution_output"]
    Accepts one of the following:
    "code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["code_execution_result"]
    Accepts one of the following:
    "code_execution_result"
    tool_use_id: str
    type: Literal["code_execution_tool_result"]
    Accepts one of the following:
    "code_execution_tool_result"
    class BetaBashCodeExecutionToolResultBlock: …
    content: Content
    Accepts one of the following:
    class BetaBashCodeExecutionToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    "output_file_too_large"
    type: Literal["bash_code_execution_tool_result_error"]
    Accepts one of the following:
    "bash_code_execution_tool_result_error"
    class BetaBashCodeExecutionResultBlock: …
    content: List[BetaBashCodeExecutionOutputBlock]
    file_id: str
    type: Literal["bash_code_execution_output"]
    Accepts one of the following:
    "bash_code_execution_output"
    return_code: int
    stderr: str
    stdout: str
    type: Literal["bash_code_execution_result"]
    Accepts one of the following:
    "bash_code_execution_result"
    tool_use_id: str
    type: Literal["bash_code_execution_tool_result"]
    Accepts one of the following:
    "bash_code_execution_tool_result"
    class BetaTextEditorCodeExecutionToolResultBlock: …
    content: Content
    Accepts one of the following:
    class BetaTextEditorCodeExecutionToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    "file_not_found"
    error_message: Optional[str]
    type: Literal["text_editor_code_execution_tool_result_error"]
    Accepts one of the following:
    "text_editor_code_execution_tool_result_error"
    class BetaTextEditorCodeExecutionViewResultBlock: …
    content: str
    file_type: Literal["text", "image", "pdf"]
    Accepts one of the following:
    "text"
    "image"
    "pdf"
    num_lines: Optional[int]
    start_line: Optional[int]
    total_lines: Optional[int]
    type: Literal["text_editor_code_execution_view_result"]
    Accepts one of the following:
    "text_editor_code_execution_view_result"
    class BetaTextEditorCodeExecutionCreateResultBlock: …
    is_file_update: bool
    type: Literal["text_editor_code_execution_create_result"]
    Accepts one of the following:
    "text_editor_code_execution_create_result"
    class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
    lines: Optional[List[str]]
    new_lines: Optional[int]
    new_start: Optional[int]
    old_lines: Optional[int]
    old_start: Optional[int]
    type: Literal["text_editor_code_execution_str_replace_result"]
    Accepts one of the following:
    "text_editor_code_execution_str_replace_result"
    tool_use_id: str
    type: Literal["text_editor_code_execution_tool_result"]
    Accepts one of the following:
    "text_editor_code_execution_tool_result"
    class BetaToolSearchToolResultBlock: …
    content: Content
    Accepts one of the following:
    class BetaToolSearchToolResultError: …
    error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded"]
    Accepts one of the following:
    "invalid_tool_input"
    "unavailable"
    "too_many_requests"
    "execution_time_exceeded"
    error_message: Optional[str]
    type: Literal["tool_search_tool_result_error"]
    Accepts one of the following:
    "tool_search_tool_result_error"
    class BetaToolSearchToolSearchResultBlock: …
    tool_references: List[BetaToolReferenceBlock]
    tool_name: str
    type: Literal["tool_reference"]
    Accepts one of the following:
    "tool_reference"
    type: Literal["tool_search_tool_search_result"]
    Accepts one of the following:
    "tool_search_tool_search_result"
    tool_use_id: str
    type: Literal["tool_search_tool_result"]
    Accepts one of the following:
    "tool_search_tool_result"
    class BetaMCPToolUseBlock: …
    id: str
    input: Dict[str, object]
    name: str

    The name of the MCP tool

    server_name: str

    The name of the MCP server

    type: Literal["mcp_tool_use"]
    Accepts one of the following:
    "mcp_tool_use"
    class BetaMCPToolResultBlock: …
    content: Union[str, List[BetaTextBlock]]
    Accepts one of the following:
    ContentUnionMember0 = str
    ContentBetaMCPToolResultBlockContent = List[BetaTextBlock]
    citations: Optional[List[BetaTextCitation]]

    Citations supporting the text block.

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

    Accepts one of the following:
    class BetaCitationCharLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_char_index: int
    file_id: Optional[str]
    start_char_index: int
    type: Literal["char_location"]
    Accepts one of the following:
    "char_location"
    class BetaCitationPageLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_page_number: int
    file_id: Optional[str]
    start_page_number: int
    type: Literal["page_location"]
    Accepts one of the following:
    "page_location"
    class BetaCitationContentBlockLocation: …
    cited_text: str
    document_index: int
    document_title: Optional[str]
    end_block_index: int
    file_id: Optional[str]
    start_block_index: int
    type: Literal["content_block_location"]
    Accepts one of the following:
    "content_block_location"
    class BetaCitationsWebSearchResultLocation: …
    cited_text: str
    encrypted_index: str
    title: Optional[str]
    type: Literal["web_search_result_location"]
    Accepts one of the following:
    "web_search_result_location"
    url: str
    class BetaCitationSearchResultLocation: …
    cited_text: str
    end_block_index: int
    search_result_index: int
    source: str
    start_block_index: int
    title: Optional[str]
    type: Literal["search_result_location"]
    Accepts one of the following:
    "search_result_location"
    text: str
    type: Literal["text"]
    Accepts one of the following:
    "text"
    is_error: bool
    tool_use_id: str
    type: Literal["mcp_tool_result"]
    Accepts one of the following:
    "mcp_tool_result"
    class BetaContainerUploadBlock: …

    Response model for a file uploaded to the container.

    file_id: str
    type: Literal["container_upload"]
    Accepts one of the following:
    "container_upload"
    index: int
    type: Literal["content_block_start"]
    Accepts one of the following:
    "content_block_start"
    class BetaRawContentBlockStopEvent: …
    index: int
    type: Literal["content_block_stop"]
    Accepts one of the following:
    "content_block_stop"
    class BetaRawMessageDeltaEvent: …
    context_management: Optional[BetaContextManagementResponse]

    Information about context management strategies applied during the request

    applied_edits: List[AppliedEdit]

    List of context management edits that were applied.

    Accepts one of the following:
    class BetaClearToolUses20250919EditResponse: …
    cleared_input_tokens: int

    Number of input tokens cleared by this edit.

    minimum0
    cleared_tool_uses: int

    Number of tool uses that were cleared.

    minimum0
    type: Literal["clear_tool_uses_20250919"]

    The type of context management edit applied.

    Accepts one of the following:
    "clear_tool_uses_20250919"
    class BetaClearThinking20251015EditResponse: …
    cleared_input_tokens: int

    Number of input tokens cleared by this edit.

    minimum0
    cleared_thinking_turns: int

    Number of thinking turns that were cleared.

    minimum0
    type: Literal["clear_thinking_20251015"]

    The type of context management edit applied.

    Accepts one of the following:
    "clear_thinking_20251015"
    delta: Delta
    container: Optional[BetaContainer]

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

    id: str

    Identifier for the container used in this request

    expires_at: datetime

    The time at which the container will expire.

    formatdate-time
    skills: Optional[List[BetaSkill]]

    Skills loaded in the container

    skill_id: str

    Skill ID

    maxLength64
    minLength1
    type: Literal["anthropic", "custom"]

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

    Accepts one of the following:
    "anthropic"
    "custom"
    version: str

    Skill version or 'latest' for most recent version

    maxLength64
    minLength1
    stop_reason: Optional[BetaStopReason]
    Accepts one of the following:
    "end_turn"
    "max_tokens"
    "stop_sequence"
    "tool_use"
    "pause_turn"