Messages
Count tokens in a Message
ModelsExpand Collapse
class BetaAllThinkingTurns: …
type: Literal["all"]
class BetaBase64ImageSource: …
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
type: Literal["base64"]
class BetaBase64PDFSource: …
media_type: Literal["application/pdf"]
type: Literal["base64"]
class BetaBashCodeExecutionOutputBlock: …
type: Literal["bash_code_execution_output"]
class BetaBashCodeExecutionOutputBlockParam: …
type: Literal["bash_code_execution_output"]
class BetaBashCodeExecutionResultBlock: …
type: Literal["bash_code_execution_output"]
type: Literal["bash_code_execution_result"]
class BetaBashCodeExecutionResultBlockParam: …
type: Literal["bash_code_execution_output"]
type: Literal["bash_code_execution_result"]
class BetaBashCodeExecutionToolResultBlock: …
content: Content
class BetaBashCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
type: Literal["bash_code_execution_tool_result_error"]
class BetaBashCodeExecutionResultBlock: …
type: Literal["bash_code_execution_output"]
type: Literal["bash_code_execution_result"]
type: Literal["bash_code_execution_tool_result"]
class BetaBashCodeExecutionToolResultBlockParam: …
content: Content
class BetaBashCodeExecutionToolResultErrorParam: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
type: Literal["bash_code_execution_tool_result_error"]
class BetaBashCodeExecutionResultBlockParam: …
type: Literal["bash_code_execution_output"]
type: Literal["bash_code_execution_result"]
type: Literal["bash_code_execution_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaBashCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
type: Literal["bash_code_execution_tool_result_error"]
class BetaBashCodeExecutionToolResultErrorParam: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
type: Literal["bash_code_execution_tool_result_error"]
class BetaCacheControlEphemeral: …
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCacheCreation: …
ephemeral_1h_input_tokens: int
The number of input tokens used to create the 1 hour cache entry.
ephemeral_5m_input_tokens: int
The number of input tokens used to create the 5 minute cache entry.
class BetaCitationCharLocation: …
type: Literal["char_location"]
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationConfig: …
class BetaCitationContentBlockLocation: …
type: Literal["content_block_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationPageLocation: …
type: Literal["page_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationSearchResultLocation: …
type: Literal["search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationsConfigParam: …
class BetaCitationsDelta: …
citation: Citation
class BetaCitationCharLocation: …
type: Literal["char_location"]
class BetaCitationPageLocation: …
type: Literal["page_location"]
class BetaCitationContentBlockLocation: …
type: Literal["content_block_location"]
class BetaCitationsWebSearchResultLocation: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocation: …
type: Literal["search_result_location"]
type: Literal["citations_delta"]
class BetaCitationsWebSearchResultLocation: …
type: Literal["web_search_result_location"]
class BetaClearThinking20251015Edit: …
type: Literal["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.
class BetaThinkingTurns: …
type: Literal["thinking_turns"]
class BetaAllThinkingTurns: …
type: Literal["all"]
KeepUnionMember2 = Literal["all"]
class BetaClearThinking20251015EditResponse: …
cleared_input_tokens: int
Number of input tokens cleared by this edit.
cleared_thinking_turns: int
Number of thinking turns that were cleared.
type: Literal["clear_thinking_20251015"]
The type of context management edit applied.
class BetaClearToolUses20250919Edit: …
type: Literal["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"]
clear_tool_inputs: Optional[Union[bool, List[str], null]]
Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)
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"]
trigger: Optional[Trigger]
Condition that triggers the context management strategy
class BetaInputTokensTrigger: …
type: Literal["input_tokens"]
class BetaToolUsesTrigger: …
type: Literal["tool_uses"]
class BetaClearToolUses20250919EditResponse: …
cleared_input_tokens: int
Number of input tokens cleared by this edit.
cleared_tool_uses: int
Number of tool uses that were cleared.
type: Literal["clear_tool_uses_20250919"]
The type of context management edit applied.
class BetaCodeExecutionOutputBlock: …
type: Literal["code_execution_output"]
class BetaCodeExecutionOutputBlockParam: …
type: Literal["code_execution_output"]
class BetaCodeExecutionResultBlock: …
type: Literal["code_execution_output"]
type: Literal["code_execution_result"]
class BetaCodeExecutionResultBlockParam: …
type: Literal["code_execution_output"]
type: Literal["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.
type: Literal["code_execution_20250522"]
allowed_callers: Optional[List[Literal["direct", "code_execution_20250825"]]]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
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.
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.
type: Literal["code_execution_20250825"]
allowed_callers: Optional[List[Literal["direct", "code_execution_20250825"]]]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
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.
class BetaCodeExecutionToolResultBlock: …
class BetaCodeExecutionToolResultError: …
type: Literal["code_execution_tool_result_error"]
class BetaCodeExecutionResultBlock: …
type: Literal["code_execution_output"]
type: Literal["code_execution_result"]
type: Literal["code_execution_tool_result"]
class BetaCodeExecutionToolResultError: …
type: Literal["code_execution_tool_result_error"]
class BetaCodeExecutionResultBlock: …
type: Literal["code_execution_output"]
type: Literal["code_execution_result"]
class BetaCodeExecutionToolResultBlockParam: …
class BetaCodeExecutionToolResultErrorParam: …
type: Literal["code_execution_tool_result_error"]
class BetaCodeExecutionResultBlockParam: …
type: Literal["code_execution_output"]
type: Literal["code_execution_result"]
type: Literal["code_execution_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCodeExecutionToolResultErrorParam: …
type: Literal["code_execution_tool_result_error"]
class BetaCodeExecutionResultBlockParam: …
type: Literal["code_execution_output"]
type: Literal["code_execution_result"]
class BetaCodeExecutionToolResultError: …
type: Literal["code_execution_tool_result_error"]
BetaCodeExecutionToolResultErrorCode = Literal["invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded"]
class BetaCodeExecutionToolResultErrorParam: …
type: Literal["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.
Skills loaded in the container
skill_id: str
Skill ID
type: Literal["anthropic", "custom"]
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: str
Skill version or 'latest' for most recent version
class BetaContainerParams: …
Container parameters with skills to be loaded.
id: Optional[str]
Container id
List of skills to load in the container
skill_id: str
Skill ID
type: Literal["anthropic", "custom"]
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: Optional[str]
Skill version or 'latest' for most recent version
class BetaContainerUploadBlock: …
Response model for a file uploaded to the container.
type: Literal["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.
type: Literal["container_upload"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Response model for a file uploaded to the container.
class BetaTextBlock: …
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.
class BetaCitationCharLocation: …
type: Literal["char_location"]
class BetaCitationPageLocation: …
type: Literal["page_location"]
class BetaCitationContentBlockLocation: …
type: Literal["content_block_location"]
class BetaCitationsWebSearchResultLocation: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocation: …
type: Literal["search_result_location"]
type: Literal["text"]
class BetaThinkingBlock: …
type: Literal["thinking"]
class BetaRedactedThinkingBlock: …
type: Literal["redacted_thinking"]
class BetaToolUseBlock: …
type: Literal["tool_use"]
caller: Optional[Caller]
Tool invocation directly from the model.
class BetaDirectCaller: …
Tool invocation directly from the model.
type: Literal["direct"]
class BetaServerToolCaller: …
Tool invocation generated by a server-side tool.
type: Literal["code_execution_20250825"]
class BetaServerToolUseBlock: …
caller: Caller
Tool invocation directly from the model.
class BetaDirectCaller: …
Tool invocation directly from the model.
type: Literal["direct"]
class BetaServerToolCaller: …
Tool invocation generated by a server-side tool.
type: Literal["code_execution_20250825"]
name: Literal["web_search", "web_fetch", "code_execution", 4 more]
type: Literal["server_tool_use"]
class BetaWebSearchToolResultBlock: …
class BetaWebSearchToolResultError: …
type: Literal["web_search_tool_result_error"]
type: Literal["web_search_result"]
type: Literal["web_search_tool_result"]
class BetaWebFetchToolResultBlock: …
content: Content
class BetaWebFetchToolResultErrorBlock: …
type: Literal["web_fetch_tool_result_error"]
class BetaWebFetchBlock: …
citations: Optional[BetaCitationConfig]
Citation configuration for the document
source: Source
class BetaBase64PDFSource: …
media_type: Literal["application/pdf"]
type: Literal["base64"]
class BetaPlainTextSource: …
media_type: Literal["text/plain"]
type: Literal["text"]
title: Optional[str]
The title of the document
type: Literal["document"]
retrieved_at: Optional[str]
ISO 8601 timestamp when the content was retrieved
type: Literal["web_fetch_result"]
url: str
Fetched content URL
type: Literal["web_fetch_tool_result"]
class BetaCodeExecutionToolResultBlock: …
class BetaCodeExecutionToolResultError: …
type: Literal["code_execution_tool_result_error"]
class BetaCodeExecutionResultBlock: …
type: Literal["code_execution_output"]
type: Literal["code_execution_result"]
type: Literal["code_execution_tool_result"]
class BetaBashCodeExecutionToolResultBlock: …
content: Content
class BetaBashCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
type: Literal["bash_code_execution_tool_result_error"]
class BetaBashCodeExecutionResultBlock: …
type: Literal["bash_code_execution_output"]
type: Literal["bash_code_execution_result"]
type: Literal["bash_code_execution_tool_result"]
class BetaTextEditorCodeExecutionToolResultBlock: …
content: Content
class BetaTextEditorCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
type: Literal["text_editor_code_execution_tool_result_error"]
class BetaTextEditorCodeExecutionViewResultBlock: …
file_type: Literal["text", "image", "pdf"]
type: Literal["text_editor_code_execution_view_result"]
class BetaTextEditorCodeExecutionCreateResultBlock: …
type: Literal["text_editor_code_execution_create_result"]
class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
type: Literal["text_editor_code_execution_str_replace_result"]
type: Literal["text_editor_code_execution_tool_result"]
class BetaToolSearchToolResultBlock: …
content: Content
class BetaToolSearchToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded"]
type: Literal["tool_search_tool_result_error"]
class BetaToolSearchToolSearchResultBlock: …
type: Literal["tool_reference"]
type: Literal["tool_search_tool_search_result"]
type: Literal["tool_search_tool_result"]
class BetaMCPToolUseBlock: …
name: str
The name of the MCP tool
server_name: str
The name of the MCP server
type: Literal["mcp_tool_use"]
class BetaMCPToolResultBlock: …
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.
class BetaCitationCharLocation: …
type: Literal["char_location"]
class BetaCitationPageLocation: …
type: Literal["page_location"]
class BetaCitationContentBlockLocation: …
type: Literal["content_block_location"]
class BetaCitationsWebSearchResultLocation: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocation: …
type: Literal["search_result_location"]
type: Literal["text"]
type: Literal["mcp_tool_result"]
class BetaContainerUploadBlock: …
Response model for a file uploaded to the container.
type: Literal["container_upload"]
Regular text content.
class BetaTextBlockParam: …
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
class BetaImageBlockParam: …
source: Source
class BetaBase64ImageSource: …
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
type: Literal["base64"]
class BetaURLImageSource: …
type: Literal["url"]
class BetaFileImageSource: …
type: Literal["file"]
type: Literal["image"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestDocumentBlock: …
source: Source
class BetaBase64PDFSource: …
media_type: Literal["application/pdf"]
type: Literal["base64"]
class BetaPlainTextSource: …
media_type: Literal["text/plain"]
type: Literal["text"]
class BetaContentBlockSource: …
class BetaTextBlockParam: …
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
class BetaImageBlockParam: …
source: Source
class BetaBase64ImageSource: …
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
type: Literal["base64"]
class BetaURLImageSource: …
type: Literal["url"]
class BetaFileImageSource: …
type: Literal["file"]
type: Literal["image"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: Literal["content"]
class BetaURLPDFSource: …
type: Literal["url"]
class BetaFileDocumentSource: …
type: Literal["file"]
type: Literal["document"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Optional[BetaCitationsConfigParam]
class BetaSearchResultBlockParam: …
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
type: Literal["search_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Optional[BetaCitationsConfigParam]
class BetaThinkingBlockParam: …
type: Literal["thinking"]
class BetaRedactedThinkingBlockParam: …
type: Literal["redacted_thinking"]
class BetaToolUseBlockParam: …
type: Literal["tool_use"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
caller: Optional[Caller]
Tool invocation directly from the model.
class BetaDirectCaller: …
Tool invocation directly from the model.
type: Literal["direct"]
class BetaServerToolCaller: …
Tool invocation generated by a server-side tool.
type: Literal["code_execution_20250825"]
class BetaToolResultBlockParam: …
type: Literal["tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
content: Optional[Union[str, List[Content], null]]
Content = List[Content]
class BetaTextBlockParam: …
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
class BetaImageBlockParam: …
source: Source
class BetaBase64ImageSource: …
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
type: Literal["base64"]
class BetaURLImageSource: …
type: Literal["url"]
class BetaFileImageSource: …
type: Literal["file"]
type: Literal["image"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaSearchResultBlockParam: …
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
type: Literal["search_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Optional[BetaCitationsConfigParam]
class BetaRequestDocumentBlock: …
source: Source
class BetaBase64PDFSource: …
media_type: Literal["application/pdf"]
type: Literal["base64"]
class BetaPlainTextSource: …
media_type: Literal["text/plain"]
type: Literal["text"]
class BetaContentBlockSource: …
class BetaTextBlockParam: …
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
class BetaImageBlockParam: …
source: Source
class BetaBase64ImageSource: …
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
type: Literal["base64"]
class BetaURLImageSource: …
type: Literal["url"]
class BetaFileImageSource: …
type: Literal["file"]
type: Literal["image"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: Literal["content"]
class BetaURLPDFSource: …
type: Literal["url"]
class BetaFileDocumentSource: …
type: Literal["file"]
type: Literal["document"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Optional[BetaCitationsConfigParam]
class BetaToolReferenceBlockParam: …
Tool reference block that can be included in tool_result content.
type: Literal["tool_reference"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaServerToolUseBlockParam: …
name: Literal["web_search", "web_fetch", "code_execution", 4 more]
type: Literal["server_tool_use"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
caller: Optional[Caller]
Tool invocation directly from the model.
class BetaDirectCaller: …
Tool invocation directly from the model.
type: Literal["direct"]
class BetaServerToolCaller: …
Tool invocation generated by a server-side tool.
type: Literal["code_execution_20250825"]
class BetaWebSearchToolResultBlockParam: …
type: Literal["web_search_result"]
class BetaWebSearchToolRequestError: …
type: Literal["web_search_tool_result_error"]
type: Literal["web_search_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaWebFetchToolResultBlockParam: …
content: Content
class BetaWebFetchToolResultErrorBlockParam: …
type: Literal["web_fetch_tool_result_error"]
class BetaWebFetchBlockParam: …
source: Source
class BetaBase64PDFSource: …
media_type: Literal["application/pdf"]
type: Literal["base64"]
class BetaPlainTextSource: …
media_type: Literal["text/plain"]
type: Literal["text"]
class BetaContentBlockSource: …
class BetaTextBlockParam: …
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
class BetaImageBlockParam: …
source: Source
class BetaBase64ImageSource: …
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
type: Literal["base64"]
class BetaURLImageSource: …
type: Literal["url"]
class BetaFileImageSource: …
type: Literal["file"]
type: Literal["image"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: Literal["content"]
class BetaURLPDFSource: …
type: Literal["url"]
class BetaFileDocumentSource: …
type: Literal["file"]
type: Literal["document"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Optional[BetaCitationsConfigParam]
type: Literal["web_fetch_result"]
url: str
Fetched content URL
retrieved_at: Optional[str]
ISO 8601 timestamp when the content was retrieved
type: Literal["web_fetch_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCodeExecutionToolResultBlockParam: …
class BetaCodeExecutionToolResultErrorParam: …
type: Literal["code_execution_tool_result_error"]
class BetaCodeExecutionResultBlockParam: …
type: Literal["code_execution_output"]
type: Literal["code_execution_result"]
type: Literal["code_execution_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaBashCodeExecutionToolResultBlockParam: …
content: Content
class BetaBashCodeExecutionToolResultErrorParam: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
type: Literal["bash_code_execution_tool_result_error"]
class BetaBashCodeExecutionResultBlockParam: …
type: Literal["bash_code_execution_output"]
type: Literal["bash_code_execution_result"]
type: Literal["bash_code_execution_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaTextEditorCodeExecutionToolResultBlockParam: …
content: Content
class BetaTextEditorCodeExecutionToolResultErrorParam: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
type: Literal["text_editor_code_execution_tool_result_error"]
class BetaTextEditorCodeExecutionViewResultBlockParam: …
file_type: Literal["text", "image", "pdf"]
type: Literal["text_editor_code_execution_view_result"]
class BetaTextEditorCodeExecutionCreateResultBlockParam: …
type: Literal["text_editor_code_execution_create_result"]
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam: …
type: Literal["text_editor_code_execution_str_replace_result"]
type: Literal["text_editor_code_execution_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolSearchToolResultBlockParam: …
content: Content
class BetaToolSearchToolResultErrorParam: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded"]
type: Literal["tool_search_tool_result_error"]
class BetaToolSearchToolSearchResultBlockParam: …
type: Literal["tool_reference"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: Literal["tool_search_tool_search_result"]
type: Literal["tool_search_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaMCPToolUseBlockParam: …
server_name: str
The name of the MCP server
type: Literal["mcp_tool_use"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestMCPToolResultBlockParam: …
type: Literal["mcp_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
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.
type: Literal["container_upload"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaContentBlockSource: …
class BetaTextBlockParam: …
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
class BetaImageBlockParam: …
source: Source
class BetaBase64ImageSource: …
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
type: Literal["base64"]
class BetaURLImageSource: …
type: Literal["url"]
class BetaFileImageSource: …
type: Literal["file"]
type: Literal["image"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: Literal["content"]
class BetaTextBlockParam: …
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
class BetaImageBlockParam: …
source: Source
class BetaBase64ImageSource: …
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
type: Literal["base64"]
class BetaURLImageSource: …
type: Literal["url"]
class BetaFileImageSource: …
type: Literal["file"]
type: Literal["image"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaContextManagementConfig: …
edits: Optional[List[Edit]]
List of context management edits to apply
class BetaClearToolUses20250919Edit: …
type: Literal["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"]
clear_tool_inputs: Optional[Union[bool, List[str], null]]
Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)
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"]
trigger: Optional[Trigger]
Condition that triggers the context management strategy
class BetaInputTokensTrigger: …
type: Literal["input_tokens"]
class BetaToolUsesTrigger: …
type: Literal["tool_uses"]
class BetaClearThinking20251015Edit: …
type: Literal["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.
class BetaThinkingTurns: …
type: Literal["thinking_turns"]
class BetaAllThinkingTurns: …
type: Literal["all"]
KeepUnionMember2 = Literal["all"]
class BetaContextManagementResponse: …
applied_edits: List[AppliedEdit]
List of context management edits that were applied.
class BetaClearToolUses20250919EditResponse: …
cleared_input_tokens: int
Number of input tokens cleared by this edit.
cleared_tool_uses: int
Number of tool uses that were cleared.
type: Literal["clear_tool_uses_20250919"]
The type of context management edit applied.
class BetaClearThinking20251015EditResponse: …
cleared_input_tokens: int
Number of input tokens cleared by this edit.
cleared_thinking_turns: int
Number of thinking turns that were cleared.
type: Literal["clear_thinking_20251015"]
The type of context management edit applied.
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"]
class BetaDocumentBlock: …
citations: Optional[BetaCitationConfig]
Citation configuration for the document
source: Source
class BetaBase64PDFSource: …
media_type: Literal["application/pdf"]
type: Literal["base64"]
class BetaPlainTextSource: …
media_type: Literal["text/plain"]
type: Literal["text"]
title: Optional[str]
The title of the document
type: Literal["document"]
class BetaFileDocumentSource: …
type: Literal["file"]
class BetaFileImageSource: …
type: Literal["file"]
class BetaImageBlockParam: …
source: Source
class BetaBase64ImageSource: …
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
type: Literal["base64"]
class BetaURLImageSource: …
type: Literal["url"]
class BetaFileImageSource: …
type: Literal["file"]
type: Literal["image"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaInputJSONDelta: …
type: Literal["input_json_delta"]
class BetaInputTokensClearAtLeast: …
type: Literal["input_tokens"]
class BetaInputTokensTrigger: …
type: Literal["input_tokens"]
class BetaJSONOutputFormat: …
schema: Dict[str, object]
The JSON schema of the format
type: Literal["json_schema"]
class BetaMCPToolConfig: …
Configuration for a specific tool in an MCP toolset.
class BetaMCPToolDefaultConfig: …
Default configuration for tools in an MCP toolset.
class BetaMCPToolResultBlock: …
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.
class BetaCitationCharLocation: …
type: Literal["char_location"]
class BetaCitationPageLocation: …
type: Literal["page_location"]
class BetaCitationContentBlockLocation: …
type: Literal["content_block_location"]
class BetaCitationsWebSearchResultLocation: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocation: …
type: Literal["search_result_location"]
type: Literal["text"]
type: Literal["mcp_tool_result"]
class BetaMCPToolUseBlock: …
name: str
The name of the MCP tool
server_name: str
The name of the MCP server
type: Literal["mcp_tool_use"]
class BetaMCPToolUseBlockParam: …
server_name: str
The name of the MCP server
type: Literal["mcp_tool_use"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
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
type: Literal["mcp_toolset"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
Configuration overrides for specific tools, keyed by tool name
default_config: Optional[BetaMCPToolDefaultConfig]
Default configuration applied to all tools from this server
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.
type: Literal["memory_20250818"]
allowed_callers: Optional[List[Literal["direct", "code_execution_20250825"]]]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
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.
class BetaMemoryTool20250818ViewCommand: …
command: Literal["view"]
Command type identifier
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
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
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
insert_line: int
Line number where text should be inserted
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
path: str
Path to the file or directory to delete
class BetaMemoryTool20250818RenameCommand: …
command: Literal["rename"]
Command type identifier
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
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
path: str
Path to the file or directory to delete
class BetaMemoryTool20250818InsertCommand: …
command: Literal["insert"]
Command type identifier
insert_line: int
Line number where text should be inserted
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
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
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
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.
Skills loaded in the container
skill_id: str
Skill ID
type: Literal["anthropic", "custom"]
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: str
Skill version or 'latest' for most recent version
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)"}]
class BetaTextBlock: …
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.
class BetaCitationCharLocation: …
type: Literal["char_location"]
class BetaCitationPageLocation: …
type: Literal["page_location"]
class BetaCitationContentBlockLocation: …
type: Literal["content_block_location"]
class BetaCitationsWebSearchResultLocation: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocation: …
type: Literal["search_result_location"]
type: Literal["text"]
class BetaThinkingBlock: …
type: Literal["thinking"]
class BetaRedactedThinkingBlock: …
type: Literal["redacted_thinking"]
class BetaToolUseBlock: …
type: Literal["tool_use"]
caller: Optional[Caller]
Tool invocation directly from the model.
class BetaDirectCaller: …
Tool invocation directly from the model.
type: Literal["direct"]
class BetaServerToolCaller: …
Tool invocation generated by a server-side tool.
type: Literal["code_execution_20250825"]
class BetaServerToolUseBlock: …
caller: Caller
Tool invocation directly from the model.
class BetaDirectCaller: …
Tool invocation directly from the model.
type: Literal["direct"]
class BetaServerToolCaller: …
Tool invocation generated by a server-side tool.
type: Literal["code_execution_20250825"]
name: Literal["web_search", "web_fetch", "code_execution", 4 more]
type: Literal["server_tool_use"]
class BetaWebSearchToolResultBlock: …
class BetaWebSearchToolResultError: …
type: Literal["web_search_tool_result_error"]
type: Literal["web_search_result"]
type: Literal["web_search_tool_result"]
class BetaWebFetchToolResultBlock: …
content: Content
class BetaWebFetchToolResultErrorBlock: …
type: Literal["web_fetch_tool_result_error"]
class BetaWebFetchBlock: …
citations: Optional[BetaCitationConfig]
Citation configuration for the document
source: Source
class BetaBase64PDFSource: …
media_type: Literal["application/pdf"]
type: Literal["base64"]
class BetaPlainTextSource: …
media_type: Literal["text/plain"]
type: Literal["text"]
title: Optional[str]
The title of the document
type: Literal["document"]
retrieved_at: Optional[str]
ISO 8601 timestamp when the content was retrieved
type: Literal["web_fetch_result"]
url: str
Fetched content URL
type: Literal["web_fetch_tool_result"]
class BetaCodeExecutionToolResultBlock: …
class BetaCodeExecutionToolResultError: …
type: Literal["code_execution_tool_result_error"]
class BetaCodeExecutionResultBlock: …
type: Literal["code_execution_output"]
type: Literal["code_execution_result"]
type: Literal["code_execution_tool_result"]
class BetaBashCodeExecutionToolResultBlock: …
content: Content
class BetaBashCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
type: Literal["bash_code_execution_tool_result_error"]
class BetaBashCodeExecutionResultBlock: …
type: Literal["bash_code_execution_output"]
type: Literal["bash_code_execution_result"]
type: Literal["bash_code_execution_tool_result"]
class BetaTextEditorCodeExecutionToolResultBlock: …
content: Content
class BetaTextEditorCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
type: Literal["text_editor_code_execution_tool_result_error"]
class BetaTextEditorCodeExecutionViewResultBlock: …
file_type: Literal["text", "image", "pdf"]
type: Literal["text_editor_code_execution_view_result"]
class BetaTextEditorCodeExecutionCreateResultBlock: …
type: Literal["text_editor_code_execution_create_result"]
class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
type: Literal["text_editor_code_execution_str_replace_result"]
type: Literal["text_editor_code_execution_tool_result"]
class BetaToolSearchToolResultBlock: …
content: Content
class BetaToolSearchToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded"]
type: Literal["tool_search_tool_result_error"]
class BetaToolSearchToolSearchResultBlock: …
type: Literal["tool_reference"]
type: Literal["tool_search_tool_search_result"]
type: Literal["tool_search_tool_result"]
class BetaMCPToolUseBlock: …
name: str
The name of the MCP tool
server_name: str
The name of the MCP server
type: Literal["mcp_tool_use"]
class BetaMCPToolResultBlock: …
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.
class BetaCitationCharLocation: …
type: Literal["char_location"]
class BetaCitationPageLocation: …
type: Literal["page_location"]
class BetaCitationContentBlockLocation: …
type: Literal["content_block_location"]
class BetaCitationsWebSearchResultLocation: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocation: …
type: Literal["search_result_location"]
type: Literal["text"]
type: Literal["mcp_tool_result"]
class BetaContainerUploadBlock: …
Response model for a file uploaded to the container.
type: Literal["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.
class BetaClearToolUses20250919EditResponse: …
cleared_input_tokens: int
Number of input tokens cleared by this edit.
cleared_tool_uses: int
Number of tool uses that were cleared.
type: Literal["clear_tool_uses_20250919"]
The type of context management edit applied.
class BetaClearThinking20251015EditResponse: …
cleared_input_tokens: int
Number of input tokens cleared by this edit.
cleared_thinking_turns: int
Number of thinking turns that were cleared.
type: Literal["clear_thinking_20251015"]
The type of context management edit applied.
The model that will complete your prompt.
See models for additional details and options.
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 performanceclaude-opus-4-5- Premium model combining maximum intelligence with practical performanceclaude-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 responsivenessclaude-3-5-haiku-20241022- Our fastest modelclaude-haiku-4-5- Hybrid model, capable of near-instant responses and extended thinkingclaude-haiku-4-5-20251001- Hybrid model, capable of near-instant responses and extended thinkingclaude-sonnet-4-20250514- High-performance model with extended thinkingclaude-sonnet-4-0- High-performance model with extended thinkingclaude-4-sonnet-20250514- High-performance model with extended thinkingclaude-sonnet-4-5- Our best model for real-world agents and codingclaude-sonnet-4-5-20250929- Our best model for real-world agents and codingclaude-opus-4-0- Our most capable modelclaude-opus-4-20250514- Our most capable modelclaude-4-opus-20250514- Our most capable modelclaude-opus-4-1-20250805- Our most capable modelclaude-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
"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
role: Literal["assistant"]
Conversational role of the generated message.
This will always be "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 requestedmax_tokensor the model's maximum"stop_sequence": one of your provided customstop_sequenceswas 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.
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".
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.
ephemeral_5m_input_tokens: int
The number of input tokens used to create the 5 minute cache entry.
cache_creation_input_tokens: Optional[int]
The number of input tokens used to create the cache entry.
cache_read_input_tokens: Optional[int]
The number of input tokens read from the cache.
input_tokens: int
The number of input tokens which were used.
output_tokens: int
The 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.
web_search_requests: int
The number of web search tool requests.
service_tier: Optional[Literal["standard", "priority", "batch"]]
If the request used the priority, standard, or batch tier.
class BetaMessageDeltaUsage: …
cache_creation_input_tokens: Optional[int]
The cumulative number of input tokens used to create the cache entry.
cache_read_input_tokens: Optional[int]
The cumulative number of input tokens read from the cache.
input_tokens: Optional[int]
The cumulative number of input tokens which were used.
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.
web_search_requests: int
The number of web search tool requests.
class BetaMessageParam: …
class BetaTextBlockParam: …
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
class BetaImageBlockParam: …
source: Source
class BetaBase64ImageSource: …
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
type: Literal["base64"]
class BetaURLImageSource: …
type: Literal["url"]
class BetaFileImageSource: …
type: Literal["file"]
type: Literal["image"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestDocumentBlock: …
source: Source
class BetaBase64PDFSource: …
media_type: Literal["application/pdf"]
type: Literal["base64"]
class BetaPlainTextSource: …
media_type: Literal["text/plain"]
type: Literal["text"]
class BetaContentBlockSource: …
class BetaTextBlockParam: …
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
class BetaImageBlockParam: …
source: Source
class BetaBase64ImageSource: …
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
type: Literal["base64"]
class BetaURLImageSource: …
type: Literal["url"]
class BetaFileImageSource: …
type: Literal["file"]
type: Literal["image"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: Literal["content"]
class BetaURLPDFSource: …
type: Literal["url"]
class BetaFileDocumentSource: …
type: Literal["file"]
type: Literal["document"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Optional[BetaCitationsConfigParam]
class BetaSearchResultBlockParam: …
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
type: Literal["search_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Optional[BetaCitationsConfigParam]
class BetaThinkingBlockParam: …
type: Literal["thinking"]
class BetaRedactedThinkingBlockParam: …
type: Literal["redacted_thinking"]
class BetaToolUseBlockParam: …
type: Literal["tool_use"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
caller: Optional[Caller]
Tool invocation directly from the model.
class BetaDirectCaller: …
Tool invocation directly from the model.
type: Literal["direct"]
class BetaServerToolCaller: …
Tool invocation generated by a server-side tool.
type: Literal["code_execution_20250825"]
class BetaToolResultBlockParam: …
type: Literal["tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
content: Optional[Union[str, List[Content], null]]
Content = List[Content]
class BetaTextBlockParam: …
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
class BetaImageBlockParam: …
source: Source
class BetaBase64ImageSource: …
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
type: Literal["base64"]
class BetaURLImageSource: …
type: Literal["url"]
class BetaFileImageSource: …
type: Literal["file"]
type: Literal["image"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaSearchResultBlockParam: …
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
type: Literal["search_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Optional[BetaCitationsConfigParam]
class BetaRequestDocumentBlock: …
source: Source
class BetaBase64PDFSource: …
media_type: Literal["application/pdf"]
type: Literal["base64"]
class BetaPlainTextSource: …
media_type: Literal["text/plain"]
type: Literal["text"]
class BetaContentBlockSource: …
class BetaTextBlockParam: …
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
class BetaImageBlockParam: …
source: Source
class BetaBase64ImageSource: …
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
type: Literal["base64"]
class BetaURLImageSource: …
type: Literal["url"]
class BetaFileImageSource: …
type: Literal["file"]
type: Literal["image"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: Literal["content"]
class BetaURLPDFSource: …
type: Literal["url"]
class BetaFileDocumentSource: …
type: Literal["file"]
type: Literal["document"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Optional[BetaCitationsConfigParam]
class BetaToolReferenceBlockParam: …
Tool reference block that can be included in tool_result content.
type: Literal["tool_reference"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaServerToolUseBlockParam: …
name: Literal["web_search", "web_fetch", "code_execution", 4 more]
type: Literal["server_tool_use"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
caller: Optional[Caller]
Tool invocation directly from the model.
class BetaDirectCaller: …
Tool invocation directly from the model.
type: Literal["direct"]
class BetaServerToolCaller: …
Tool invocation generated by a server-side tool.
type: Literal["code_execution_20250825"]
class BetaWebSearchToolResultBlockParam: …
type: Literal["web_search_result"]
class BetaWebSearchToolRequestError: …
type: Literal["web_search_tool_result_error"]
type: Literal["web_search_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaWebFetchToolResultBlockParam: …
content: Content
class BetaWebFetchToolResultErrorBlockParam: …
type: Literal["web_fetch_tool_result_error"]
class BetaWebFetchBlockParam: …
source: Source
class BetaBase64PDFSource: …
media_type: Literal["application/pdf"]
type: Literal["base64"]
class BetaPlainTextSource: …
media_type: Literal["text/plain"]
type: Literal["text"]
class BetaContentBlockSource: …
class BetaTextBlockParam: …
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
class BetaImageBlockParam: …
source: Source
class BetaBase64ImageSource: …
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
type: Literal["base64"]
class BetaURLImageSource: …
type: Literal["url"]
class BetaFileImageSource: …
type: Literal["file"]
type: Literal["image"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: Literal["content"]
class BetaURLPDFSource: …
type: Literal["url"]
class BetaFileDocumentSource: …
type: Literal["file"]
type: Literal["document"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
citations: Optional[BetaCitationsConfigParam]
type: Literal["web_fetch_result"]
url: str
Fetched content URL
retrieved_at: Optional[str]
ISO 8601 timestamp when the content was retrieved
type: Literal["web_fetch_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCodeExecutionToolResultBlockParam: …
class BetaCodeExecutionToolResultErrorParam: …
type: Literal["code_execution_tool_result_error"]
class BetaCodeExecutionResultBlockParam: …
type: Literal["code_execution_output"]
type: Literal["code_execution_result"]
type: Literal["code_execution_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaBashCodeExecutionToolResultBlockParam: …
content: Content
class BetaBashCodeExecutionToolResultErrorParam: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
type: Literal["bash_code_execution_tool_result_error"]
class BetaBashCodeExecutionResultBlockParam: …
type: Literal["bash_code_execution_output"]
type: Literal["bash_code_execution_result"]
type: Literal["bash_code_execution_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaTextEditorCodeExecutionToolResultBlockParam: …
content: Content
class BetaTextEditorCodeExecutionToolResultErrorParam: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
type: Literal["text_editor_code_execution_tool_result_error"]
class BetaTextEditorCodeExecutionViewResultBlockParam: …
file_type: Literal["text", "image", "pdf"]
type: Literal["text_editor_code_execution_view_result"]
class BetaTextEditorCodeExecutionCreateResultBlockParam: …
type: Literal["text_editor_code_execution_create_result"]
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam: …
type: Literal["text_editor_code_execution_str_replace_result"]
type: Literal["text_editor_code_execution_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaToolSearchToolResultBlockParam: …
content: Content
class BetaToolSearchToolResultErrorParam: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded"]
type: Literal["tool_search_tool_result_error"]
class BetaToolSearchToolSearchResultBlockParam: …
type: Literal["tool_reference"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: Literal["tool_search_tool_search_result"]
type: Literal["tool_search_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaMCPToolUseBlockParam: …
server_name: str
The name of the MCP server
type: Literal["mcp_tool_use"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaRequestMCPToolResultBlockParam: …
type: Literal["mcp_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
type: Literal["text"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
class BetaCitationCharLocationParam: …
type: Literal["char_location"]
class BetaCitationPageLocationParam: …
type: Literal["page_location"]
class BetaCitationContentBlockLocationParam: …
type: Literal["content_block_location"]
class BetaCitationWebSearchResultLocationParam: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocationParam: …
type: Literal["search_result_location"]
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.
type: Literal["container_upload"]
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
ttl: Optional[Literal["5m", "1h"]]
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m.
role: Literal["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.
class BetaOutputConfig: …
effort: Optional[Literal["low", "medium", "high"]]
All possible effort levels.
class BetaPlainTextSource: …
media_type: Literal["text/plain"]
type: Literal["text"]
class BetaTextDelta: …
type: Literal["text_delta"]
class BetaInputJSONDelta: …
type: Literal["input_json_delta"]
class BetaCitationsDelta: …
citation: Citation
class BetaCitationCharLocation: …
type: Literal["char_location"]
class BetaCitationPageLocation: …
type: Literal["page_location"]
class BetaCitationContentBlockLocation: …
type: Literal["content_block_location"]
class BetaCitationsWebSearchResultLocation: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocation: …
type: Literal["search_result_location"]
type: Literal["citations_delta"]
class BetaThinkingDelta: …
type: Literal["thinking_delta"]
class BetaSignatureDelta: …
type: Literal["signature_delta"]
class BetaRawContentBlockDeltaEvent: …
class BetaTextDelta: …
type: Literal["text_delta"]
class BetaInputJSONDelta: …
type: Literal["input_json_delta"]
class BetaCitationsDelta: …
citation: Citation
class BetaCitationCharLocation: …
type: Literal["char_location"]
class BetaCitationPageLocation: …
type: Literal["page_location"]
class BetaCitationContentBlockLocation: …
type: Literal["content_block_location"]
class BetaCitationsWebSearchResultLocation: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocation: …
type: Literal["search_result_location"]
type: Literal["citations_delta"]
class BetaThinkingDelta: …
type: Literal["thinking_delta"]
class BetaSignatureDelta: …
type: Literal["signature_delta"]
type: Literal["content_block_delta"]
class BetaRawContentBlockStartEvent: …
content_block: ContentBlock
Response model for a file uploaded to the container.
class BetaTextBlock: …
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.
class BetaCitationCharLocation: …
type: Literal["char_location"]
class BetaCitationPageLocation: …
type: Literal["page_location"]
class BetaCitationContentBlockLocation: …
type: Literal["content_block_location"]
class BetaCitationsWebSearchResultLocation: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocation: …
type: Literal["search_result_location"]
type: Literal["text"]
class BetaThinkingBlock: …
type: Literal["thinking"]
class BetaRedactedThinkingBlock: …
type: Literal["redacted_thinking"]
class BetaToolUseBlock: …
type: Literal["tool_use"]
caller: Optional[Caller]
Tool invocation directly from the model.
class BetaDirectCaller: …
Tool invocation directly from the model.
type: Literal["direct"]
class BetaServerToolCaller: …
Tool invocation generated by a server-side tool.
type: Literal["code_execution_20250825"]
class BetaServerToolUseBlock: …
caller: Caller
Tool invocation directly from the model.
class BetaDirectCaller: …
Tool invocation directly from the model.
type: Literal["direct"]
class BetaServerToolCaller: …
Tool invocation generated by a server-side tool.
type: Literal["code_execution_20250825"]
name: Literal["web_search", "web_fetch", "code_execution", 4 more]
type: Literal["server_tool_use"]
class BetaWebSearchToolResultBlock: …
class BetaWebSearchToolResultError: …
type: Literal["web_search_tool_result_error"]
type: Literal["web_search_result"]
type: Literal["web_search_tool_result"]
class BetaWebFetchToolResultBlock: …
content: Content
class BetaWebFetchToolResultErrorBlock: …
type: Literal["web_fetch_tool_result_error"]
class BetaWebFetchBlock: …
citations: Optional[BetaCitationConfig]
Citation configuration for the document
source: Source
class BetaBase64PDFSource: …
media_type: Literal["application/pdf"]
type: Literal["base64"]
class BetaPlainTextSource: …
media_type: Literal["text/plain"]
type: Literal["text"]
title: Optional[str]
The title of the document
type: Literal["document"]
retrieved_at: Optional[str]
ISO 8601 timestamp when the content was retrieved
type: Literal["web_fetch_result"]
url: str
Fetched content URL
type: Literal["web_fetch_tool_result"]
class BetaCodeExecutionToolResultBlock: …
class BetaCodeExecutionToolResultError: …
type: Literal["code_execution_tool_result_error"]
class BetaCodeExecutionResultBlock: …
type: Literal["code_execution_output"]
type: Literal["code_execution_result"]
type: Literal["code_execution_tool_result"]
class BetaBashCodeExecutionToolResultBlock: …
content: Content
class BetaBashCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
type: Literal["bash_code_execution_tool_result_error"]
class BetaBashCodeExecutionResultBlock: …
type: Literal["bash_code_execution_output"]
type: Literal["bash_code_execution_result"]
type: Literal["bash_code_execution_tool_result"]
class BetaTextEditorCodeExecutionToolResultBlock: …
content: Content
class BetaTextEditorCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
type: Literal["text_editor_code_execution_tool_result_error"]
class BetaTextEditorCodeExecutionViewResultBlock: …
file_type: Literal["text", "image", "pdf"]
type: Literal["text_editor_code_execution_view_result"]
class BetaTextEditorCodeExecutionCreateResultBlock: …
type: Literal["text_editor_code_execution_create_result"]
class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
type: Literal["text_editor_code_execution_str_replace_result"]
type: Literal["text_editor_code_execution_tool_result"]
class BetaToolSearchToolResultBlock: …
content: Content
class BetaToolSearchToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded"]
type: Literal["tool_search_tool_result_error"]
class BetaToolSearchToolSearchResultBlock: …
type: Literal["tool_reference"]
type: Literal["tool_search_tool_search_result"]
type: Literal["tool_search_tool_result"]
class BetaMCPToolUseBlock: …
name: str
The name of the MCP tool
server_name: str
The name of the MCP server
type: Literal["mcp_tool_use"]
class BetaMCPToolResultBlock: …
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.
class BetaCitationCharLocation: …
type: Literal["char_location"]
class BetaCitationPageLocation: …
type: Literal["page_location"]
class BetaCitationContentBlockLocation: …
type: Literal["content_block_location"]
class BetaCitationsWebSearchResultLocation: …
type: Literal["web_search_result_location"]
class BetaCitationSearchResultLocation: …
type: Literal["search_result_location"]
type: Literal["text"]
type: Literal["mcp_tool_result"]
class BetaContainerUploadBlock: …
Response model for a file uploaded to the container.
type: Literal["container_upload"]
type: Literal["content_block_start"]
class BetaRawContentBlockStopEvent: …
type: Literal["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.
class BetaClearToolUses20250919EditResponse: …
cleared_input_tokens: int
Number of input tokens cleared by this edit.
cleared_tool_uses: int
Number of tool uses that were cleared.
type: Literal["clear_tool_uses_20250919"]
The type of context management edit applied.
class BetaClearThinking20251015EditResponse: …
cleared_input_tokens: int
Number of input tokens cleared by this edit.
cleared_thinking_turns: int
Number of thinking turns that were cleared.
type: Literal["clear_thinking_20251015"]
The type of context management edit applied.
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.
Skills loaded in the container
skill_id: str
Skill ID
type: Literal["anthropic", "custom"]
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
version: str
Skill version or 'latest' for most recent version