Beta
ModelsExpand Collapse
AnthropicBeta = Union[str, Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 15 more]]
AnthropicBeta = Union[str, Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 15 more]]
Accepts one of the following:
UnionMember0 = str
UnionMember1 = Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 15 more]
UnionMember1 = Literal["message-batches-2024-09-24", "prompt-caching-2024-07-31", "computer-use-2024-10-22", 15 more]
Accepts one of the following:
"message-batches-2024-09-24"
"prompt-caching-2024-07-31"
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"pdfs-2024-09-25"
"token-counting-2024-11-01"
"token-efficient-tools-2025-02-19"
"output-128k-2025-02-19"
"files-api-2025-04-14"
"mcp-client-2025-04-04"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"extended-cache-ttl-2025-04-11"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"skills-2025-10-02"
class BetaAPIError: …
class BetaAPIError: …
message: str
type: Literal["api_error"]
type: Literal["api_error"]
Accepts one of the following:
"api_error"
class BetaAuthenticationError: …
class BetaAuthenticationError: …
message: str
type: Literal["authentication_error"]
type: Literal["authentication_error"]
Accepts one of the following:
"authentication_error"
class BetaBillingError: …
class BetaBillingError: …
message: str
type: Literal["billing_error"]
type: Literal["billing_error"]
Accepts one of the following:
"billing_error"
Accepts one of the following:
class BetaInvalidRequestError: …
class BetaInvalidRequestError: …
message: str
type: Literal["invalid_request_error"]
type: Literal["invalid_request_error"]
Accepts one of the following:
"invalid_request_error"
class BetaAuthenticationError: …
class BetaAuthenticationError: …
message: str
type: Literal["authentication_error"]
type: Literal["authentication_error"]
Accepts one of the following:
"authentication_error"
class BetaBillingError: …
class BetaBillingError: …
message: str
type: Literal["billing_error"]
type: Literal["billing_error"]
Accepts one of the following:
"billing_error"
class BetaPermissionError: …
class BetaPermissionError: …
message: str
type: Literal["permission_error"]
type: Literal["permission_error"]
Accepts one of the following:
"permission_error"
class BetaNotFoundError: …
class BetaNotFoundError: …
message: str
type: Literal["not_found_error"]
type: Literal["not_found_error"]
Accepts one of the following:
"not_found_error"
class BetaRateLimitError: …
class BetaRateLimitError: …
message: str
type: Literal["rate_limit_error"]
type: Literal["rate_limit_error"]
Accepts one of the following:
"rate_limit_error"
class BetaGatewayTimeoutError: …
class BetaGatewayTimeoutError: …
message: str
type: Literal["timeout_error"]
type: Literal["timeout_error"]
Accepts one of the following:
"timeout_error"
class BetaAPIError: …
class BetaAPIError: …
message: str
type: Literal["api_error"]
type: Literal["api_error"]
Accepts one of the following:
"api_error"
class BetaOverloadedError: …
class BetaOverloadedError: …
message: str
type: Literal["overloaded_error"]
type: Literal["overloaded_error"]
Accepts one of the following:
"overloaded_error"
class BetaErrorResponse: …
class BetaErrorResponse: …
Accepts one of the following:
class BetaInvalidRequestError: …
class BetaInvalidRequestError: …
message: str
type: Literal["invalid_request_error"]
type: Literal["invalid_request_error"]
Accepts one of the following:
"invalid_request_error"
class BetaAuthenticationError: …
class BetaAuthenticationError: …
message: str
type: Literal["authentication_error"]
type: Literal["authentication_error"]
Accepts one of the following:
"authentication_error"
class BetaBillingError: …
class BetaBillingError: …
message: str
type: Literal["billing_error"]
type: Literal["billing_error"]
Accepts one of the following:
"billing_error"
class BetaPermissionError: …
class BetaPermissionError: …
message: str
type: Literal["permission_error"]
type: Literal["permission_error"]
Accepts one of the following:
"permission_error"
class BetaNotFoundError: …
class BetaNotFoundError: …
message: str
type: Literal["not_found_error"]
type: Literal["not_found_error"]
Accepts one of the following:
"not_found_error"
class BetaRateLimitError: …
class BetaRateLimitError: …
message: str
type: Literal["rate_limit_error"]
type: Literal["rate_limit_error"]
Accepts one of the following:
"rate_limit_error"
class BetaGatewayTimeoutError: …
class BetaGatewayTimeoutError: …
message: str
type: Literal["timeout_error"]
type: Literal["timeout_error"]
Accepts one of the following:
"timeout_error"
class BetaAPIError: …
class BetaAPIError: …
message: str
type: Literal["api_error"]
type: Literal["api_error"]
Accepts one of the following:
"api_error"
class BetaOverloadedError: …
class BetaOverloadedError: …
message: str
type: Literal["overloaded_error"]
type: Literal["overloaded_error"]
Accepts one of the following:
"overloaded_error"
request_id: Optional[str]
type: Literal["error"]
type: Literal["error"]
Accepts one of the following:
"error"
class BetaGatewayTimeoutError: …
class BetaGatewayTimeoutError: …
message: str
type: Literal["timeout_error"]
type: Literal["timeout_error"]
Accepts one of the following:
"timeout_error"
class BetaInvalidRequestError: …
class BetaInvalidRequestError: …
message: str
type: Literal["invalid_request_error"]
type: Literal["invalid_request_error"]
Accepts one of the following:
"invalid_request_error"
class BetaNotFoundError: …
class BetaNotFoundError: …
message: str
type: Literal["not_found_error"]
type: Literal["not_found_error"]
Accepts one of the following:
"not_found_error"
class BetaOverloadedError: …
class BetaOverloadedError: …
message: str
type: Literal["overloaded_error"]
type: Literal["overloaded_error"]
Accepts one of the following:
"overloaded_error"
class BetaPermissionError: …
class BetaPermissionError: …
message: str
type: Literal["permission_error"]
type: Literal["permission_error"]
Accepts one of the following:
"permission_error"
class BetaRateLimitError: …
class BetaRateLimitError: …
message: str
type: Literal["rate_limit_error"]
type: Literal["rate_limit_error"]
Accepts one of the following:
"rate_limit_error"
BetaFiles
Delete File
beta.files.delete(strfile_id, FileDeleteParams**kwargs) -> DeletedFile
delete/v1/files/{file_id}?beta=true
Download File
beta.files.download(strfile_id, FileDownloadParams**kwargs) -> BinaryResponseContent
get/v1/files/{file_id}/content?beta=true
Get File Metadata
beta.files.retrieve_metadata(strfile_id, FileRetrieveMetadataParams**kwargs) -> FileMetadata
get/v1/files/{file_id}?beta=true
ModelsExpand Collapse
class DeletedFile: …
class DeletedFile: …
id: str
ID of the deleted file.
type: Optional[Literal["file_deleted"]]Deleted object type.
For file deletion, this is always "file_deleted".
type: Optional[Literal["file_deleted"]]
Deleted object type.
For file deletion, this is always "file_deleted".
Accepts one of the following:
"file_deleted"
class FileMetadata: …
class FileMetadata: …
id: str
Unique object identifier.
The format and length of IDs may change over time.
created_at: datetime
RFC 3339 datetime string representing when the file was created.
formatdate-time
filename: str
Original filename of the uploaded file.
maxLength500
minLength1
mime_type: str
MIME type of the file.
maxLength255
minLength1
size_bytes: int
Size of the file in bytes.
minimum0
type: Literal["file"]Object type.
For files, this is always "file".
type: Literal["file"]
Object type.
For files, this is always "file".
Accepts one of the following:
"file"
downloadable: Optional[bool]
Whether the file can be downloaded.
BetaMessages
Count tokens in a Message
beta.messages.count_tokens(MessageCountTokensParams**kwargs) -> BetaMessageTokensCount
post/v1/messages/count_tokens?beta=true
Create a Message
beta.messages.create(MessageCreateParams**kwargs) -> BetaMessage
post/v1/messages?beta=true
ModelsExpand Collapse
class BetaAllThinkingTurns: …
class BetaAllThinkingTurns: …
type: Literal["all"]
type: Literal["all"]
Accepts one of the following:
"all"
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaBashCodeExecutionOutputBlock: …
class BetaBashCodeExecutionOutputBlock: …
file_id: str
type: Literal["bash_code_execution_output"]
type: Literal["bash_code_execution_output"]
Accepts one of the following:
"bash_code_execution_output"
class BetaBashCodeExecutionOutputBlockParam: …
class BetaBashCodeExecutionOutputBlockParam: …
file_id: str
type: Literal["bash_code_execution_output"]
type: Literal["bash_code_execution_output"]
Accepts one of the following:
"bash_code_execution_output"
class BetaBashCodeExecutionResultBlock: …
class BetaBashCodeExecutionResultBlock: …
file_id: str
type: Literal["bash_code_execution_output"]
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"]
type: Literal["bash_code_execution_result"]
Accepts one of the following:
"bash_code_execution_result"
class BetaBashCodeExecutionResultBlockParam: …
class BetaBashCodeExecutionResultBlockParam: …
file_id: str
type: Literal["bash_code_execution_output"]
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"]
type: Literal["bash_code_execution_result"]
Accepts one of the following:
"bash_code_execution_result"
class BetaBashCodeExecutionToolResultBlock: …
class BetaBashCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaBashCodeExecutionToolResultError: …
class BetaBashCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["bash_code_execution_tool_result_error"]
Accepts one of the following:
"bash_code_execution_tool_result_error"
class BetaBashCodeExecutionResultBlock: …
class BetaBashCodeExecutionResultBlock: …
file_id: str
type: Literal["bash_code_execution_output"]
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"]
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"]
type: Literal["bash_code_execution_tool_result"]
Accepts one of the following:
"bash_code_execution_tool_result"
class BetaBashCodeExecutionToolResultBlockParam: …
class BetaBashCodeExecutionToolResultBlockParam: …
content: Content
content: Content
Accepts one of the following:
class BetaBashCodeExecutionToolResultErrorParam: …
class BetaBashCodeExecutionToolResultErrorParam: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["bash_code_execution_tool_result_error"]
Accepts one of the following:
"bash_code_execution_tool_result_error"
class BetaBashCodeExecutionResultBlockParam: …
class BetaBashCodeExecutionResultBlockParam: …
file_id: str
type: Literal["bash_code_execution_output"]
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"]
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"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaBashCodeExecutionToolResultError: …
class BetaBashCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["bash_code_execution_tool_result_error"]
Accepts one of the following:
"bash_code_execution_tool_result_error"
class BetaBashCodeExecutionToolResultErrorParam: …
class BetaBashCodeExecutionToolResultErrorParam: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["bash_code_execution_tool_result_error"]
Accepts one of the following:
"bash_code_execution_tool_result_error"
class BetaCacheControlEphemeral: …
class BetaCacheControlEphemeral: …
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaCacheCreation: …
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationConfig: …
class BetaCitationConfig: …
enabled: bool
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationsConfigParam: …
class BetaCitationsConfigParam: …
enabled: Optional[bool]
class BetaCitationsDelta: …
class BetaCitationsDelta: …
citation: Citation
citation: Citation
Accepts one of the following:
class BetaCitationCharLocation: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
type: Literal["citations_delta"]
type: Literal["citations_delta"]
Accepts one of the following:
"citations_delta"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaClearThinking20251015Edit: …
class BetaClearThinking20251015Edit: …
type: Literal["clear_thinking_20251015"]
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.
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: …
class BetaThinkingTurns: …
type: Literal["thinking_turns"]
type: Literal["thinking_turns"]
Accepts one of the following:
"thinking_turns"
value: int
minimum1
class BetaAllThinkingTurns: …
class BetaAllThinkingTurns: …
type: Literal["all"]
type: Literal["all"]
Accepts one of the following:
"all"
KeepUnionMember2 = Literal["all"]
KeepUnionMember2 = Literal["all"]
Accepts one of the following:
"all"
class BetaClearThinking20251015EditResponse: …
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.
type: Literal["clear_thinking_20251015"]
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
class BetaClearToolUses20250919Edit: …
class BetaClearToolUses20250919Edit: …
type: Literal["clear_tool_uses_20250919"]
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.
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"]
type: Literal["input_tokens"]
Accepts one of the following:
"input_tokens"
value: int
minimum0
clear_tool_inputs: Optional[Union[bool, List[str], null]]Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)
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
keep: Optional[BetaToolUsesKeep]
Number of tool uses to retain in the conversation
type: Literal["tool_uses"]
type: Literal["tool_uses"]
Accepts one of the following:
"tool_uses"
value: int
minimum0
trigger: Optional[Trigger]Condition that triggers the context management strategy
trigger: Optional[Trigger]
Condition that triggers the context management strategy
Accepts one of the following:
class BetaInputTokensTrigger: …
class BetaInputTokensTrigger: …
type: Literal["input_tokens"]
type: Literal["input_tokens"]
Accepts one of the following:
"input_tokens"
value: int
minimum1
class BetaToolUsesTrigger: …
class BetaToolUsesTrigger: …
type: Literal["tool_uses"]
type: Literal["tool_uses"]
Accepts one of the following:
"tool_uses"
value: int
minimum1
class BetaClearToolUses20250919EditResponse: …
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.
type: Literal["clear_tool_uses_20250919"]
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
class BetaCodeExecutionOutputBlock: …
class BetaCodeExecutionOutputBlock: …
file_id: str
type: Literal["code_execution_output"]
type: Literal["code_execution_output"]
Accepts one of the following:
"code_execution_output"
class BetaCodeExecutionOutputBlockParam: …
class BetaCodeExecutionOutputBlockParam: …
file_id: str
type: Literal["code_execution_output"]
type: Literal["code_execution_output"]
Accepts one of the following:
"code_execution_output"
class BetaCodeExecutionResultBlock: …
class BetaCodeExecutionResultBlock: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
class BetaCodeExecutionResultBlockParam: …
class BetaCodeExecutionResultBlockParam: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
class BetaCodeExecutionTool20250522: …
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.
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"]
type: Literal["code_execution_20250522"]
Accepts one of the following:
"code_execution_20250522"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaCodeExecutionTool20250825: …
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.
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"]
type: Literal["code_execution_20250825"]
Accepts one of the following:
"code_execution_20250825"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaCodeExecutionToolResultBlock: …
class BetaCodeExecutionToolResultBlock: …
Accepts one of the following:
class BetaCodeExecutionToolResultError: …
class BetaCodeExecutionToolResultError: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
type: Literal["code_execution_tool_result_error"]
Accepts one of the following:
"code_execution_tool_result_error"
class BetaCodeExecutionResultBlock: …
class BetaCodeExecutionResultBlock: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
tool_use_id: str
type: Literal["code_execution_tool_result"]
type: Literal["code_execution_tool_result"]
Accepts one of the following:
"code_execution_tool_result"
Accepts one of the following:
class BetaCodeExecutionToolResultError: …
class BetaCodeExecutionToolResultError: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
type: Literal["code_execution_tool_result_error"]
Accepts one of the following:
"code_execution_tool_result_error"
class BetaCodeExecutionResultBlock: …
class BetaCodeExecutionResultBlock: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
class BetaCodeExecutionToolResultBlockParam: …
class BetaCodeExecutionToolResultBlockParam: …
Accepts one of the following:
class BetaCodeExecutionToolResultErrorParam: …
class BetaCodeExecutionToolResultErrorParam: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
type: Literal["code_execution_tool_result_error"]
Accepts one of the following:
"code_execution_tool_result_error"
class BetaCodeExecutionResultBlockParam: …
class BetaCodeExecutionResultBlockParam: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
tool_use_id: str
type: Literal["code_execution_tool_result"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCodeExecutionToolResultErrorParam: …
class BetaCodeExecutionToolResultErrorParam: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
type: Literal["code_execution_tool_result_error"]
Accepts one of the following:
"code_execution_tool_result_error"
class BetaCodeExecutionResultBlockParam: …
class BetaCodeExecutionResultBlockParam: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
class BetaCodeExecutionToolResultError: …
class BetaCodeExecutionToolResultError: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
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"]
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: …
class BetaCodeExecutionToolResultErrorParam: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
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)
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 loaded in the container
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)
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.
class BetaContainerParams: …
Container parameters with skills to be loaded.
id: Optional[str]
Container id
List of skills to load in the container
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)
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.
class BetaContainerUploadBlock: …
Response model for a file uploaded to the container.
file_id: str
type: Literal["container_upload"]
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.
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"]
type: Literal["container_upload"]
Accepts one of the following:
"container_upload"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
Accepts one of the following:
class BetaTextBlock: …
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaThinkingBlock: …
class BetaThinkingBlock: …
signature: str
thinking: str
type: Literal["thinking"]
type: Literal["thinking"]
Accepts one of the following:
"thinking"
class BetaRedactedThinkingBlock: …
class BetaRedactedThinkingBlock: …
data: str
type: Literal["redacted_thinking"]
type: Literal["redacted_thinking"]
Accepts one of the following:
"redacted_thinking"
class BetaToolUseBlock: …
class BetaToolUseBlock: …
id: str
input: Dict[str, object]
name: str
minLength1
type: Literal["tool_use"]
type: Literal["tool_use"]
Accepts one of the following:
"tool_use"
class BetaServerToolUseBlock: …
class BetaServerToolUseBlock: …
id: str
input: Dict[str, object]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: Literal["server_tool_use"]
type: Literal["server_tool_use"]
Accepts one of the following:
"server_tool_use"
class BetaWebSearchToolResultBlock: …
class BetaWebSearchToolResultBlock: …
Accepts one of the following:
class BetaWebSearchToolResultError: …
class BetaWebSearchToolResultError: …
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"]
type: Literal["web_search_tool_result_error"]
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: str
page_age: Optional[str]
title: str
type: Literal["web_search_result"]
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"]
type: Literal["web_search_tool_result"]
Accepts one of the following:
"web_search_tool_result"
class BetaWebFetchToolResultBlock: …
class BetaWebFetchToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaWebFetchToolResultErrorBlock: …
class BetaWebFetchToolResultErrorBlock: …
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"]
type: Literal["web_fetch_tool_result_error"]
Accepts one of the following:
"web_fetch_tool_result_error"
class BetaWebFetchBlock: …
class BetaWebFetchBlock: …
citations: Optional[BetaCitationConfig]Citation configuration for the document
citations: Optional[BetaCitationConfig]
Citation configuration for the document
enabled: bool
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
title: Optional[str]
The title of the document
type: Literal["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"]
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"]
type: Literal["web_fetch_tool_result"]
Accepts one of the following:
"web_fetch_tool_result"
class BetaCodeExecutionToolResultBlock: …
class BetaCodeExecutionToolResultBlock: …
Accepts one of the following:
class BetaCodeExecutionToolResultError: …
class BetaCodeExecutionToolResultError: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
type: Literal["code_execution_tool_result_error"]
Accepts one of the following:
"code_execution_tool_result_error"
class BetaCodeExecutionResultBlock: …
class BetaCodeExecutionResultBlock: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
tool_use_id: str
type: Literal["code_execution_tool_result"]
type: Literal["code_execution_tool_result"]
Accepts one of the following:
"code_execution_tool_result"
class BetaBashCodeExecutionToolResultBlock: …
class BetaBashCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaBashCodeExecutionToolResultError: …
class BetaBashCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["bash_code_execution_tool_result_error"]
Accepts one of the following:
"bash_code_execution_tool_result_error"
class BetaBashCodeExecutionResultBlock: …
class BetaBashCodeExecutionResultBlock: …
file_id: str
type: Literal["bash_code_execution_output"]
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"]
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"]
type: Literal["bash_code_execution_tool_result"]
Accepts one of the following:
"bash_code_execution_tool_result"
class BetaTextEditorCodeExecutionToolResultBlock: …
class BetaTextEditorCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaTextEditorCodeExecutionToolResultError: …
class BetaTextEditorCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["text_editor_code_execution_tool_result_error"]
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
class BetaTextEditorCodeExecutionViewResultBlock: …
class BetaTextEditorCodeExecutionViewResultBlock: …
content: str
file_type: Literal["text", "image", "pdf"]
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"]
type: Literal["text_editor_code_execution_view_result"]
Accepts one of the following:
"text_editor_code_execution_view_result"
class BetaTextEditorCodeExecutionCreateResultBlock: …
class BetaTextEditorCodeExecutionCreateResultBlock: …
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
type: Literal["text_editor_code_execution_create_result"]
Accepts one of the following:
"text_editor_code_execution_create_result"
class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
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"]
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"]
type: Literal["text_editor_code_execution_tool_result"]
Accepts one of the following:
"text_editor_code_execution_tool_result"
class BetaMCPToolUseBlock: …
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"]
type: Literal["mcp_tool_use"]
Accepts one of the following:
"mcp_tool_use"
class BetaMCPToolResultBlock: …
class BetaMCPToolResultBlock: …
Accepts one of the following:
ContentUnionMember0 = str
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
is_error: bool
tool_use_id: str
type: Literal["mcp_tool_result"]
type: Literal["mcp_tool_result"]
Accepts one of the following:
"mcp_tool_result"
class BetaContainerUploadBlock: …Response model for a file uploaded to the container.
class BetaContainerUploadBlock: …
Response model for a file uploaded to the container.
file_id: str
type: Literal["container_upload"]
type: Literal["container_upload"]
Accepts one of the following:
"container_upload"
Regular text content.
Regular text content.
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaRequestDocumentBlock: …
class BetaRequestDocumentBlock: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaContentBlockSource: …
class BetaContentBlockSource: …
Accepts one of the following:
ContentUnionMember0 = str
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
type: Literal["content"]
type: Literal["content"]
Accepts one of the following:
"content"
class BetaURLPDFSource: …
class BetaURLPDFSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileDocumentSource: …
class BetaFileDocumentSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["document"]
type: Literal["document"]
Accepts one of the following:
"document"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]
citations: Optional[BetaCitationsConfigParam]
enabled: Optional[bool]
context: Optional[str]
minLength1
title: Optional[str]
maxLength500
minLength1
class BetaSearchResultBlockParam: …
class BetaSearchResultBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
source: str
title: str
type: Literal["search_result"]
type: Literal["search_result"]
Accepts one of the following:
"search_result"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]
citations: Optional[BetaCitationsConfigParam]
enabled: Optional[bool]
class BetaThinkingBlockParam: …
class BetaThinkingBlockParam: …
signature: str
thinking: str
type: Literal["thinking"]
type: Literal["thinking"]
Accepts one of the following:
"thinking"
class BetaRedactedThinkingBlockParam: …
class BetaRedactedThinkingBlockParam: …
data: str
type: Literal["redacted_thinking"]
type: Literal["redacted_thinking"]
Accepts one of the following:
"redacted_thinking"
class BetaToolUseBlockParam: …
class BetaToolUseBlockParam: …
id: str
input: Dict[str, object]
name: str
maxLength200
minLength1
type: Literal["tool_use"]
type: Literal["tool_use"]
Accepts one of the following:
"tool_use"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaToolResultBlockParam: …
class BetaToolResultBlockParam: …
tool_use_id: str
type: Literal["tool_result"]
type: Literal["tool_result"]
Accepts one of the following:
"tool_result"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
content: Optional[Union[str, List[Content], null]]
content: Optional[Union[str, List[Content], null]]
Accepts one of the following:
ContentUnionMember0 = str
Content = List[Content]
Content = List[Content]
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaSearchResultBlockParam: …
class BetaSearchResultBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
source: str
title: str
type: Literal["search_result"]
type: Literal["search_result"]
Accepts one of the following:
"search_result"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]
citations: Optional[BetaCitationsConfigParam]
enabled: Optional[bool]
class BetaRequestDocumentBlock: …
class BetaRequestDocumentBlock: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaContentBlockSource: …
class BetaContentBlockSource: …
Accepts one of the following:
ContentUnionMember0 = str
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
type: Literal["content"]
type: Literal["content"]
Accepts one of the following:
"content"
class BetaURLPDFSource: …
class BetaURLPDFSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileDocumentSource: …
class BetaFileDocumentSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["document"]
type: Literal["document"]
Accepts one of the following:
"document"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]
citations: Optional[BetaCitationsConfigParam]
enabled: Optional[bool]
context: Optional[str]
minLength1
title: Optional[str]
maxLength500
minLength1
is_error: Optional[bool]
class BetaServerToolUseBlockParam: …
class BetaServerToolUseBlockParam: …
id: str
input: Dict[str, object]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: Literal["server_tool_use"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaWebSearchToolResultBlockParam: …
class BetaWebSearchToolResultBlockParam: …
Accepts one of the following:
encrypted_content: str
title: str
type: Literal["web_search_result"]
type: Literal["web_search_result"]
Accepts one of the following:
"web_search_result"
url: str
page_age: Optional[str]
class BetaWebSearchToolRequestError: …
class BetaWebSearchToolRequestError: …
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"]
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"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaWebFetchToolResultBlockParam: …
class BetaWebFetchToolResultBlockParam: …
content: Content
content: Content
Accepts one of the following:
class BetaWebFetchToolResultErrorBlockParam: …
class BetaWebFetchToolResultErrorBlockParam: …
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"]
type: Literal["web_fetch_tool_result_error"]
Accepts one of the following:
"web_fetch_tool_result_error"
class BetaWebFetchBlockParam: …
class BetaWebFetchBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaContentBlockSource: …
class BetaContentBlockSource: …
Accepts one of the following:
ContentUnionMember0 = str
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
type: Literal["content"]
type: Literal["content"]
Accepts one of the following:
"content"
class BetaURLPDFSource: …
class BetaURLPDFSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileDocumentSource: …
class BetaFileDocumentSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["document"]
type: Literal["document"]
Accepts one of the following:
"document"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]
citations: Optional[BetaCitationsConfigParam]
enabled: Optional[bool]
context: Optional[str]
minLength1
title: Optional[str]
maxLength500
minLength1
type: Literal["web_fetch_result"]
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"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaCodeExecutionToolResultBlockParam: …
class BetaCodeExecutionToolResultBlockParam: …
Accepts one of the following:
class BetaCodeExecutionToolResultErrorParam: …
class BetaCodeExecutionToolResultErrorParam: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
type: Literal["code_execution_tool_result_error"]
Accepts one of the following:
"code_execution_tool_result_error"
class BetaCodeExecutionResultBlockParam: …
class BetaCodeExecutionResultBlockParam: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
tool_use_id: str
type: Literal["code_execution_tool_result"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaBashCodeExecutionToolResultBlockParam: …
class BetaBashCodeExecutionToolResultBlockParam: …
content: Content
content: Content
Accepts one of the following:
class BetaBashCodeExecutionToolResultErrorParam: …
class BetaBashCodeExecutionToolResultErrorParam: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["bash_code_execution_tool_result_error"]
Accepts one of the following:
"bash_code_execution_tool_result_error"
class BetaBashCodeExecutionResultBlockParam: …
class BetaBashCodeExecutionResultBlockParam: …
file_id: str
type: Literal["bash_code_execution_output"]
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"]
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"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaTextEditorCodeExecutionToolResultBlockParam: …
class BetaTextEditorCodeExecutionToolResultBlockParam: …
content: Content
content: Content
Accepts one of the following:
class BetaTextEditorCodeExecutionToolResultErrorParam: …
class BetaTextEditorCodeExecutionToolResultErrorParam: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
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: …
class BetaTextEditorCodeExecutionViewResultBlockParam: …
content: str
file_type: Literal["text", "image", "pdf"]
file_type: Literal["text", "image", "pdf"]
Accepts one of the following:
"text"
"image"
"pdf"
type: Literal["text_editor_code_execution_view_result"]
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: …
class BetaTextEditorCodeExecutionCreateResultBlockParam: …
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
type: Literal["text_editor_code_execution_create_result"]
Accepts one of the following:
"text_editor_code_execution_create_result"
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam: …
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam: …
type: Literal["text_editor_code_execution_str_replace_result"]
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"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaMCPToolUseBlockParam: …
class BetaMCPToolUseBlockParam: …
id: str
input: Dict[str, object]
name: str
server_name: str
The name of the MCP server
type: Literal["mcp_tool_use"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaRequestMCPToolResultBlockParam: …
class BetaRequestMCPToolResultBlockParam: …
tool_use_id: str
type: Literal["mcp_tool_result"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
ContentUnionMember0 = str
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
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.
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"]
type: Literal["container_upload"]
Accepts one of the following:
"container_upload"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaContentBlockSource: …
class BetaContentBlockSource: …
Accepts one of the following:
ContentUnionMember0 = str
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
type: Literal["content"]
type: Literal["content"]
Accepts one of the following:
"content"
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaContextManagementConfig: …
class BetaContextManagementConfig: …
edits: Optional[List[Edit]]List of context management edits to apply
edits: Optional[List[Edit]]
List of context management edits to apply
Accepts one of the following:
class BetaClearToolUses20250919Edit: …
class BetaClearToolUses20250919Edit: …
type: Literal["clear_tool_uses_20250919"]
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.
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"]
type: Literal["input_tokens"]
Accepts one of the following:
"input_tokens"
value: int
minimum0
clear_tool_inputs: Optional[Union[bool, List[str], null]]Whether to clear all tool inputs (bool) or specific tool inputs to clear (list)
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
keep: Optional[BetaToolUsesKeep]
Number of tool uses to retain in the conversation
type: Literal["tool_uses"]
type: Literal["tool_uses"]
Accepts one of the following:
"tool_uses"
value: int
minimum0
trigger: Optional[Trigger]Condition that triggers the context management strategy
trigger: Optional[Trigger]
Condition that triggers the context management strategy
Accepts one of the following:
class BetaInputTokensTrigger: …
class BetaInputTokensTrigger: …
type: Literal["input_tokens"]
type: Literal["input_tokens"]
Accepts one of the following:
"input_tokens"
value: int
minimum1
class BetaToolUsesTrigger: …
class BetaToolUsesTrigger: …
type: Literal["tool_uses"]
type: Literal["tool_uses"]
Accepts one of the following:
"tool_uses"
value: int
minimum1
class BetaClearThinking20251015Edit: …
class BetaClearThinking20251015Edit: …
type: Literal["clear_thinking_20251015"]
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.
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: …
class BetaThinkingTurns: …
type: Literal["thinking_turns"]
type: Literal["thinking_turns"]
Accepts one of the following:
"thinking_turns"
value: int
minimum1
class BetaAllThinkingTurns: …
class BetaAllThinkingTurns: …
type: Literal["all"]
type: Literal["all"]
Accepts one of the following:
"all"
KeepUnionMember2 = Literal["all"]
KeepUnionMember2 = Literal["all"]
Accepts one of the following:
"all"
class BetaContextManagementResponse: …
class BetaContextManagementResponse: …
applied_edits: List[AppliedEdit]List of context management edits that were applied.
applied_edits: List[AppliedEdit]
List of context management edits that were applied.
Accepts one of the following:
class BetaClearToolUses20250919EditResponse: …
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.
type: Literal["clear_tool_uses_20250919"]
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
class BetaClearThinking20251015EditResponse: …
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.
type: Literal["clear_thinking_20251015"]
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
class BetaCountTokensContextManagementResponse: …
class BetaCountTokensContextManagementResponse: …
original_input_tokens: int
The original token count before context management was applied
class BetaDocumentBlock: …
class BetaDocumentBlock: …
citations: Optional[BetaCitationConfig]Citation configuration for the document
citations: Optional[BetaCitationConfig]
Citation configuration for the document
enabled: bool
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
title: Optional[str]
The title of the document
type: Literal["document"]
type: Literal["document"]
Accepts one of the following:
"document"
class BetaFileDocumentSource: …
class BetaFileDocumentSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaInputJSONDelta: …
class BetaInputJSONDelta: …
partial_json: str
type: Literal["input_json_delta"]
type: Literal["input_json_delta"]
Accepts one of the following:
"input_json_delta"
class BetaInputTokensClearAtLeast: …
class BetaInputTokensClearAtLeast: …
type: Literal["input_tokens"]
type: Literal["input_tokens"]
Accepts one of the following:
"input_tokens"
value: int
minimum0
class BetaInputTokensTrigger: …
class BetaInputTokensTrigger: …
type: Literal["input_tokens"]
type: Literal["input_tokens"]
Accepts one of the following:
"input_tokens"
value: int
minimum1
class BetaMCPToolResultBlock: …
class BetaMCPToolResultBlock: …
Accepts one of the following:
ContentUnionMember0 = str
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
is_error: bool
tool_use_id: str
type: Literal["mcp_tool_result"]
type: Literal["mcp_tool_result"]
Accepts one of the following:
"mcp_tool_result"
class BetaMCPToolUseBlock: …
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"]
type: Literal["mcp_tool_use"]
Accepts one of the following:
"mcp_tool_use"
class BetaMCPToolUseBlockParam: …
class BetaMCPToolUseBlockParam: …
id: str
input: Dict[str, object]
name: str
server_name: str
The name of the MCP server
type: Literal["mcp_tool_use"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaMemoryTool20250818: …
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.
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"]
type: Literal["memory_20250818"]
Accepts one of the following:
"memory_20250818"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaMemoryTool20250818ViewCommand: …
class BetaMemoryTool20250818ViewCommand: …
command: Literal["view"]Command type identifier
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: …
class BetaMemoryTool20250818CreateCommand: …
command: Literal["create"]Command type identifier
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: …
class BetaMemoryTool20250818StrReplaceCommand: …
command: Literal["str_replace"]Command type identifier
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: …
class BetaMemoryTool20250818InsertCommand: …
command: Literal["insert"]Command type identifier
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: …
class BetaMemoryTool20250818DeleteCommand: …
command: Literal["delete"]Command type identifier
command: Literal["delete"]
Command type identifier
Accepts one of the following:
"delete"
path: str
Path to the file or directory to delete
class BetaMemoryTool20250818RenameCommand: …
class BetaMemoryTool20250818RenameCommand: …
command: Literal["rename"]Command type identifier
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: …
class BetaMemoryTool20250818CreateCommand: …
command: Literal["create"]Command type identifier
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: …
class BetaMemoryTool20250818DeleteCommand: …
command: Literal["delete"]Command type identifier
command: Literal["delete"]
Command type identifier
Accepts one of the following:
"delete"
path: str
Path to the file or directory to delete
class BetaMemoryTool20250818InsertCommand: …
class BetaMemoryTool20250818InsertCommand: …
command: Literal["insert"]Command type identifier
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: …
class BetaMemoryTool20250818RenameCommand: …
command: Literal["rename"]Command type identifier
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: …
class BetaMemoryTool20250818StrReplaceCommand: …
command: Literal["str_replace"]Command type identifier
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: …
class BetaMemoryTool20250818ViewCommand: …
command: Literal["view"]Command type identifier
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: …
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)
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 loaded in the container
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)
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 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)"}]
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: …
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaThinkingBlock: …
class BetaThinkingBlock: …
signature: str
thinking: str
type: Literal["thinking"]
type: Literal["thinking"]
Accepts one of the following:
"thinking"
class BetaRedactedThinkingBlock: …
class BetaRedactedThinkingBlock: …
data: str
type: Literal["redacted_thinking"]
type: Literal["redacted_thinking"]
Accepts one of the following:
"redacted_thinking"
class BetaToolUseBlock: …
class BetaToolUseBlock: …
id: str
input: Dict[str, object]
name: str
minLength1
type: Literal["tool_use"]
type: Literal["tool_use"]
Accepts one of the following:
"tool_use"
class BetaServerToolUseBlock: …
class BetaServerToolUseBlock: …
id: str
input: Dict[str, object]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: Literal["server_tool_use"]
type: Literal["server_tool_use"]
Accepts one of the following:
"server_tool_use"
class BetaWebSearchToolResultBlock: …
class BetaWebSearchToolResultBlock: …
Accepts one of the following:
class BetaWebSearchToolResultError: …
class BetaWebSearchToolResultError: …
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"]
type: Literal["web_search_tool_result_error"]
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: str
page_age: Optional[str]
title: str
type: Literal["web_search_result"]
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"]
type: Literal["web_search_tool_result"]
Accepts one of the following:
"web_search_tool_result"
class BetaWebFetchToolResultBlock: …
class BetaWebFetchToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaWebFetchToolResultErrorBlock: …
class BetaWebFetchToolResultErrorBlock: …
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"]
type: Literal["web_fetch_tool_result_error"]
Accepts one of the following:
"web_fetch_tool_result_error"
class BetaWebFetchBlock: …
class BetaWebFetchBlock: …
citations: Optional[BetaCitationConfig]Citation configuration for the document
citations: Optional[BetaCitationConfig]
Citation configuration for the document
enabled: bool
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
title: Optional[str]
The title of the document
type: Literal["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"]
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"]
type: Literal["web_fetch_tool_result"]
Accepts one of the following:
"web_fetch_tool_result"
class BetaCodeExecutionToolResultBlock: …
class BetaCodeExecutionToolResultBlock: …
Accepts one of the following:
class BetaCodeExecutionToolResultError: …
class BetaCodeExecutionToolResultError: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
type: Literal["code_execution_tool_result_error"]
Accepts one of the following:
"code_execution_tool_result_error"
class BetaCodeExecutionResultBlock: …
class BetaCodeExecutionResultBlock: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
tool_use_id: str
type: Literal["code_execution_tool_result"]
type: Literal["code_execution_tool_result"]
Accepts one of the following:
"code_execution_tool_result"
class BetaBashCodeExecutionToolResultBlock: …
class BetaBashCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaBashCodeExecutionToolResultError: …
class BetaBashCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["bash_code_execution_tool_result_error"]
Accepts one of the following:
"bash_code_execution_tool_result_error"
class BetaBashCodeExecutionResultBlock: …
class BetaBashCodeExecutionResultBlock: …
file_id: str
type: Literal["bash_code_execution_output"]
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"]
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"]
type: Literal["bash_code_execution_tool_result"]
Accepts one of the following:
"bash_code_execution_tool_result"
class BetaTextEditorCodeExecutionToolResultBlock: …
class BetaTextEditorCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaTextEditorCodeExecutionToolResultError: …
class BetaTextEditorCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["text_editor_code_execution_tool_result_error"]
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
class BetaTextEditorCodeExecutionViewResultBlock: …
class BetaTextEditorCodeExecutionViewResultBlock: …
content: str
file_type: Literal["text", "image", "pdf"]
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"]
type: Literal["text_editor_code_execution_view_result"]
Accepts one of the following:
"text_editor_code_execution_view_result"
class BetaTextEditorCodeExecutionCreateResultBlock: …
class BetaTextEditorCodeExecutionCreateResultBlock: …
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
type: Literal["text_editor_code_execution_create_result"]
Accepts one of the following:
"text_editor_code_execution_create_result"
class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
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"]
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"]
type: Literal["text_editor_code_execution_tool_result"]
Accepts one of the following:
"text_editor_code_execution_tool_result"
class BetaMCPToolUseBlock: …
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"]
type: Literal["mcp_tool_use"]
Accepts one of the following:
"mcp_tool_use"
class BetaMCPToolResultBlock: …
class BetaMCPToolResultBlock: …
Accepts one of the following:
ContentUnionMember0 = str
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
is_error: bool
tool_use_id: str
type: Literal["mcp_tool_result"]
type: Literal["mcp_tool_result"]
Accepts one of the following:
"mcp_tool_result"
class BetaContainerUploadBlock: …Response model for a file uploaded to the container.
class BetaContainerUploadBlock: …
Response model for a file uploaded to the container.
file_id: str
type: Literal["container_upload"]
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.
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.
applied_edits: List[AppliedEdit]
List of context management edits that were applied.
Accepts one of the following:
class BetaClearToolUses20250919EditResponse: …
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.
type: Literal["clear_tool_uses_20250919"]
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
class BetaClearThinking20251015EditResponse: …
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.
type: Literal["clear_thinking_20251015"]
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
Accepts one of the following:
UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]The model that will complete your prompt.
See models for additional details and options.
claude-3-7-sonnet-latest - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-7-sonnet-20250219 - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-5-haiku-latest - Fastest and most compact model for near-instant 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
UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]
The model that will complete your prompt.
See models for additional details and options.
claude-3-7-sonnet-latest- Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-7-sonnet-20250219- Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-5-haiku-latest- Fastest and most compact model for near-instant 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
Accepts one of the following:
"claude-3-7-sonnet-latest"
High-performance model with early extended thinking
"claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
"claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
"claude-3-5-haiku-20241022"
Our fastest model
"claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
"claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
"claude-sonnet-4-20250514"
High-performance model with extended thinking
"claude-sonnet-4-0"
High-performance model with extended thinking
"claude-4-sonnet-20250514"
High-performance model with extended thinking
"claude-sonnet-4-5"
Our best model for real-world agents and coding
"claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
"claude-opus-4-0"
Our most capable model
"claude-opus-4-20250514"
Our most capable model
"claude-4-opus-20250514"
Our most capable model
"claude-opus-4-1-20250805"
Our most capable model
"claude-3-opus-latest"
Excels at writing and complex tasks
"claude-3-opus-20240229"
Excels at writing and complex tasks
"claude-3-haiku-20240307"
Our previous most fast and cost-effective
UnionMember1 = str
role: Literal["assistant"]Conversational role of the generated message.
This will always be "assistant".
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.
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.
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".
type: Literal["message"]
Object type.
For Messages, this is always "message".
Accepts one of the following:
"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.
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
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.
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.
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: …
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.
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: …
class BetaMessageParam: …
Accepts one of the following:
ContentUnionMember0 = str
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaRequestDocumentBlock: …
class BetaRequestDocumentBlock: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaContentBlockSource: …
class BetaContentBlockSource: …
Accepts one of the following:
ContentUnionMember0 = str
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
type: Literal["content"]
type: Literal["content"]
Accepts one of the following:
"content"
class BetaURLPDFSource: …
class BetaURLPDFSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileDocumentSource: …
class BetaFileDocumentSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["document"]
type: Literal["document"]
Accepts one of the following:
"document"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]
citations: Optional[BetaCitationsConfigParam]
enabled: Optional[bool]
context: Optional[str]
minLength1
title: Optional[str]
maxLength500
minLength1
class BetaSearchResultBlockParam: …
class BetaSearchResultBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
source: str
title: str
type: Literal["search_result"]
type: Literal["search_result"]
Accepts one of the following:
"search_result"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]
citations: Optional[BetaCitationsConfigParam]
enabled: Optional[bool]
class BetaThinkingBlockParam: …
class BetaThinkingBlockParam: …
signature: str
thinking: str
type: Literal["thinking"]
type: Literal["thinking"]
Accepts one of the following:
"thinking"
class BetaRedactedThinkingBlockParam: …
class BetaRedactedThinkingBlockParam: …
data: str
type: Literal["redacted_thinking"]
type: Literal["redacted_thinking"]
Accepts one of the following:
"redacted_thinking"
class BetaToolUseBlockParam: …
class BetaToolUseBlockParam: …
id: str
input: Dict[str, object]
name: str
maxLength200
minLength1
type: Literal["tool_use"]
type: Literal["tool_use"]
Accepts one of the following:
"tool_use"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaToolResultBlockParam: …
class BetaToolResultBlockParam: …
tool_use_id: str
type: Literal["tool_result"]
type: Literal["tool_result"]
Accepts one of the following:
"tool_result"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
content: Optional[Union[str, List[Content], null]]
content: Optional[Union[str, List[Content], null]]
Accepts one of the following:
ContentUnionMember0 = str
Content = List[Content]
Content = List[Content]
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaSearchResultBlockParam: …
class BetaSearchResultBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
source: str
title: str
type: Literal["search_result"]
type: Literal["search_result"]
Accepts one of the following:
"search_result"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]
citations: Optional[BetaCitationsConfigParam]
enabled: Optional[bool]
class BetaRequestDocumentBlock: …
class BetaRequestDocumentBlock: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaContentBlockSource: …
class BetaContentBlockSource: …
Accepts one of the following:
ContentUnionMember0 = str
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
type: Literal["content"]
type: Literal["content"]
Accepts one of the following:
"content"
class BetaURLPDFSource: …
class BetaURLPDFSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileDocumentSource: …
class BetaFileDocumentSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["document"]
type: Literal["document"]
Accepts one of the following:
"document"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]
citations: Optional[BetaCitationsConfigParam]
enabled: Optional[bool]
context: Optional[str]
minLength1
title: Optional[str]
maxLength500
minLength1
is_error: Optional[bool]
class BetaServerToolUseBlockParam: …
class BetaServerToolUseBlockParam: …
id: str
input: Dict[str, object]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: Literal["server_tool_use"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaWebSearchToolResultBlockParam: …
class BetaWebSearchToolResultBlockParam: …
Accepts one of the following:
encrypted_content: str
title: str
type: Literal["web_search_result"]
type: Literal["web_search_result"]
Accepts one of the following:
"web_search_result"
url: str
page_age: Optional[str]
class BetaWebSearchToolRequestError: …
class BetaWebSearchToolRequestError: …
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"]
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"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaWebFetchToolResultBlockParam: …
class BetaWebFetchToolResultBlockParam: …
content: Content
content: Content
Accepts one of the following:
class BetaWebFetchToolResultErrorBlockParam: …
class BetaWebFetchToolResultErrorBlockParam: …
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"]
type: Literal["web_fetch_tool_result_error"]
Accepts one of the following:
"web_fetch_tool_result_error"
class BetaWebFetchBlockParam: …
class BetaWebFetchBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaContentBlockSource: …
class BetaContentBlockSource: …
Accepts one of the following:
ContentUnionMember0 = str
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
type: Literal["content"]
type: Literal["content"]
Accepts one of the following:
"content"
class BetaURLPDFSource: …
class BetaURLPDFSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileDocumentSource: …
class BetaFileDocumentSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["document"]
type: Literal["document"]
Accepts one of the following:
"document"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]
citations: Optional[BetaCitationsConfigParam]
enabled: Optional[bool]
context: Optional[str]
minLength1
title: Optional[str]
maxLength500
minLength1
type: Literal["web_fetch_result"]
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"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaCodeExecutionToolResultBlockParam: …
class BetaCodeExecutionToolResultBlockParam: …
Accepts one of the following:
class BetaCodeExecutionToolResultErrorParam: …
class BetaCodeExecutionToolResultErrorParam: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
type: Literal["code_execution_tool_result_error"]
Accepts one of the following:
"code_execution_tool_result_error"
class BetaCodeExecutionResultBlockParam: …
class BetaCodeExecutionResultBlockParam: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
tool_use_id: str
type: Literal["code_execution_tool_result"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaBashCodeExecutionToolResultBlockParam: …
class BetaBashCodeExecutionToolResultBlockParam: …
content: Content
content: Content
Accepts one of the following:
class BetaBashCodeExecutionToolResultErrorParam: …
class BetaBashCodeExecutionToolResultErrorParam: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["bash_code_execution_tool_result_error"]
Accepts one of the following:
"bash_code_execution_tool_result_error"
class BetaBashCodeExecutionResultBlockParam: …
class BetaBashCodeExecutionResultBlockParam: …
file_id: str
type: Literal["bash_code_execution_output"]
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"]
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"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaTextEditorCodeExecutionToolResultBlockParam: …
class BetaTextEditorCodeExecutionToolResultBlockParam: …
content: Content
content: Content
Accepts one of the following:
class BetaTextEditorCodeExecutionToolResultErrorParam: …
class BetaTextEditorCodeExecutionToolResultErrorParam: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
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: …
class BetaTextEditorCodeExecutionViewResultBlockParam: …
content: str
file_type: Literal["text", "image", "pdf"]
file_type: Literal["text", "image", "pdf"]
Accepts one of the following:
"text"
"image"
"pdf"
type: Literal["text_editor_code_execution_view_result"]
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: …
class BetaTextEditorCodeExecutionCreateResultBlockParam: …
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
type: Literal["text_editor_code_execution_create_result"]
Accepts one of the following:
"text_editor_code_execution_create_result"
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam: …
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam: …
type: Literal["text_editor_code_execution_str_replace_result"]
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"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaMCPToolUseBlockParam: …
class BetaMCPToolUseBlockParam: …
id: str
input: Dict[str, object]
name: str
server_name: str
The name of the MCP server
type: Literal["mcp_tool_use"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaRequestMCPToolResultBlockParam: …
class BetaRequestMCPToolResultBlockParam: …
tool_use_id: str
type: Literal["mcp_tool_result"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
ContentUnionMember0 = str
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
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.
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"]
type: Literal["container_upload"]
Accepts one of the following:
"container_upload"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
role: Literal["user", "assistant"]
role: Literal["user", "assistant"]
Accepts one of the following:
"user"
"assistant"
class BetaMessageTokensCount: …
class BetaMessageTokensCount: …
context_management: Optional[BetaCountTokensContextManagementResponse]Information about context management applied to the message.
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: …
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 BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
Accepts one of the following:
class BetaTextDelta: …
class BetaTextDelta: …
text: str
type: Literal["text_delta"]
type: Literal["text_delta"]
Accepts one of the following:
"text_delta"
class BetaInputJSONDelta: …
class BetaInputJSONDelta: …
partial_json: str
type: Literal["input_json_delta"]
type: Literal["input_json_delta"]
Accepts one of the following:
"input_json_delta"
class BetaCitationsDelta: …
class BetaCitationsDelta: …
citation: Citation
citation: Citation
Accepts one of the following:
class BetaCitationCharLocation: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
type: Literal["citations_delta"]
type: Literal["citations_delta"]
Accepts one of the following:
"citations_delta"
class BetaThinkingDelta: …
class BetaThinkingDelta: …
thinking: str
type: Literal["thinking_delta"]
type: Literal["thinking_delta"]
Accepts one of the following:
"thinking_delta"
class BetaSignatureDelta: …
class BetaSignatureDelta: …
signature: str
type: Literal["signature_delta"]
type: Literal["signature_delta"]
Accepts one of the following:
"signature_delta"
class BetaRawContentBlockDeltaEvent: …
class BetaRawContentBlockDeltaEvent: …
Accepts one of the following:
class BetaTextDelta: …
class BetaTextDelta: …
text: str
type: Literal["text_delta"]
type: Literal["text_delta"]
Accepts one of the following:
"text_delta"
class BetaInputJSONDelta: …
class BetaInputJSONDelta: …
partial_json: str
type: Literal["input_json_delta"]
type: Literal["input_json_delta"]
Accepts one of the following:
"input_json_delta"
class BetaCitationsDelta: …
class BetaCitationsDelta: …
citation: Citation
citation: Citation
Accepts one of the following:
class BetaCitationCharLocation: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
type: Literal["citations_delta"]
type: Literal["citations_delta"]
Accepts one of the following:
"citations_delta"
class BetaThinkingDelta: …
class BetaThinkingDelta: …
thinking: str
type: Literal["thinking_delta"]
type: Literal["thinking_delta"]
Accepts one of the following:
"thinking_delta"
class BetaSignatureDelta: …
class BetaSignatureDelta: …
signature: str
type: Literal["signature_delta"]
type: Literal["signature_delta"]
Accepts one of the following:
"signature_delta"
index: int
type: Literal["content_block_delta"]
type: Literal["content_block_delta"]
Accepts one of the following:
"content_block_delta"
class BetaRawContentBlockStartEvent: …
class BetaRawContentBlockStartEvent: …
content_block: ContentBlockResponse model for a file uploaded to the container.
content_block: ContentBlock
Response model for a file uploaded to the container.
Accepts one of the following:
class BetaTextBlock: …
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaThinkingBlock: …
class BetaThinkingBlock: …
signature: str
thinking: str
type: Literal["thinking"]
type: Literal["thinking"]
Accepts one of the following:
"thinking"
class BetaRedactedThinkingBlock: …
class BetaRedactedThinkingBlock: …
data: str
type: Literal["redacted_thinking"]
type: Literal["redacted_thinking"]
Accepts one of the following:
"redacted_thinking"
class BetaToolUseBlock: …
class BetaToolUseBlock: …
id: str
input: Dict[str, object]
name: str
minLength1
type: Literal["tool_use"]
type: Literal["tool_use"]
Accepts one of the following:
"tool_use"
class BetaServerToolUseBlock: …
class BetaServerToolUseBlock: …
id: str
input: Dict[str, object]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: Literal["server_tool_use"]
type: Literal["server_tool_use"]
Accepts one of the following:
"server_tool_use"
class BetaWebSearchToolResultBlock: …
class BetaWebSearchToolResultBlock: …
Accepts one of the following:
class BetaWebSearchToolResultError: …
class BetaWebSearchToolResultError: …
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"]
type: Literal["web_search_tool_result_error"]
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: str
page_age: Optional[str]
title: str
type: Literal["web_search_result"]
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"]
type: Literal["web_search_tool_result"]
Accepts one of the following:
"web_search_tool_result"
class BetaWebFetchToolResultBlock: …
class BetaWebFetchToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaWebFetchToolResultErrorBlock: …
class BetaWebFetchToolResultErrorBlock: …
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"]
type: Literal["web_fetch_tool_result_error"]
Accepts one of the following:
"web_fetch_tool_result_error"
class BetaWebFetchBlock: …
class BetaWebFetchBlock: …
citations: Optional[BetaCitationConfig]Citation configuration for the document
citations: Optional[BetaCitationConfig]
Citation configuration for the document
enabled: bool
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
title: Optional[str]
The title of the document
type: Literal["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"]
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"]
type: Literal["web_fetch_tool_result"]
Accepts one of the following:
"web_fetch_tool_result"
class BetaCodeExecutionToolResultBlock: …
class BetaCodeExecutionToolResultBlock: …
Accepts one of the following:
class BetaCodeExecutionToolResultError: …
class BetaCodeExecutionToolResultError: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
type: Literal["code_execution_tool_result_error"]
Accepts one of the following:
"code_execution_tool_result_error"
class BetaCodeExecutionResultBlock: …
class BetaCodeExecutionResultBlock: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
tool_use_id: str
type: Literal["code_execution_tool_result"]
type: Literal["code_execution_tool_result"]
Accepts one of the following:
"code_execution_tool_result"
class BetaBashCodeExecutionToolResultBlock: …
class BetaBashCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaBashCodeExecutionToolResultError: …
class BetaBashCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["bash_code_execution_tool_result_error"]
Accepts one of the following:
"bash_code_execution_tool_result_error"
class BetaBashCodeExecutionResultBlock: …
class BetaBashCodeExecutionResultBlock: …
file_id: str
type: Literal["bash_code_execution_output"]
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"]
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"]
type: Literal["bash_code_execution_tool_result"]
Accepts one of the following:
"bash_code_execution_tool_result"
class BetaTextEditorCodeExecutionToolResultBlock: …
class BetaTextEditorCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaTextEditorCodeExecutionToolResultError: …
class BetaTextEditorCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["text_editor_code_execution_tool_result_error"]
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
class BetaTextEditorCodeExecutionViewResultBlock: …
class BetaTextEditorCodeExecutionViewResultBlock: …
content: str
file_type: Literal["text", "image", "pdf"]
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"]
type: Literal["text_editor_code_execution_view_result"]
Accepts one of the following:
"text_editor_code_execution_view_result"
class BetaTextEditorCodeExecutionCreateResultBlock: …
class BetaTextEditorCodeExecutionCreateResultBlock: …
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
type: Literal["text_editor_code_execution_create_result"]
Accepts one of the following:
"text_editor_code_execution_create_result"
class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
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"]
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"]
type: Literal["text_editor_code_execution_tool_result"]
Accepts one of the following:
"text_editor_code_execution_tool_result"
class BetaMCPToolUseBlock: …
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"]
type: Literal["mcp_tool_use"]
Accepts one of the following:
"mcp_tool_use"
class BetaMCPToolResultBlock: …
class BetaMCPToolResultBlock: …
Accepts one of the following:
ContentUnionMember0 = str
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
is_error: bool
tool_use_id: str
type: Literal["mcp_tool_result"]
type: Literal["mcp_tool_result"]
Accepts one of the following:
"mcp_tool_result"
class BetaContainerUploadBlock: …Response model for a file uploaded to the container.
class BetaContainerUploadBlock: …
Response model for a file uploaded to the container.
file_id: str
type: Literal["container_upload"]
type: Literal["container_upload"]
Accepts one of the following:
"container_upload"
index: int
type: Literal["content_block_start"]
type: Literal["content_block_start"]
Accepts one of the following:
"content_block_start"
class BetaRawContentBlockStopEvent: …
class BetaRawContentBlockStopEvent: …
index: int
type: Literal["content_block_stop"]
type: Literal["content_block_stop"]
Accepts one of the following:
"content_block_stop"
class BetaRawMessageDeltaEvent: …
class BetaRawMessageDeltaEvent: …
context_management: Optional[BetaContextManagementResponse]Information about context management strategies applied during the request
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.
applied_edits: List[AppliedEdit]
List of context management edits that were applied.
Accepts one of the following:
class BetaClearToolUses20250919EditResponse: …
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.
type: Literal["clear_tool_uses_20250919"]
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
class BetaClearThinking20251015EditResponse: …
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.
type: Literal["clear_thinking_20251015"]
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
delta: Delta
delta: Delta
container: Optional[BetaContainer]Information about the container used in the request (for the code execution tool)
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 loaded in the container
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)
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]
stop_reason: Optional[BetaStopReason]
Accepts one of the following:
"end_turn"
"max_tokens"
"stop_sequence"
"tool_use"
"pause_turn"
"refusal"
"model_context_window_exceeded"
stop_sequence: Optional[str]
type: Literal["message_delta"]
type: Literal["message_delta"]
Accepts one of the following:
"message_delta"
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.
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
cache_creation_input_tokens: Optional[int]
The cumulative number of input tokens used to create the cache entry.
minimum0
cache_read_input_tokens: Optional[int]
The cumulative number of input tokens read from the cache.
minimum0
input_tokens: Optional[int]
The cumulative number of input tokens which were used.
minimum0
output_tokens: int
The cumulative number of output tokens which were used.
server_tool_use: Optional[BetaServerToolUsage]The number of server tool requests.
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 BetaRawMessageStartEvent: …
class BetaRawMessageStartEvent: …
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)
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 loaded in the container
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)
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 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)"}]
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: …
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaThinkingBlock: …
class BetaThinkingBlock: …
signature: str
thinking: str
type: Literal["thinking"]
type: Literal["thinking"]
Accepts one of the following:
"thinking"
class BetaRedactedThinkingBlock: …
class BetaRedactedThinkingBlock: …
data: str
type: Literal["redacted_thinking"]
type: Literal["redacted_thinking"]
Accepts one of the following:
"redacted_thinking"
class BetaToolUseBlock: …
class BetaToolUseBlock: …
id: str
input: Dict[str, object]
name: str
minLength1
type: Literal["tool_use"]
type: Literal["tool_use"]
Accepts one of the following:
"tool_use"
class BetaServerToolUseBlock: …
class BetaServerToolUseBlock: …
id: str
input: Dict[str, object]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: Literal["server_tool_use"]
type: Literal["server_tool_use"]
Accepts one of the following:
"server_tool_use"
class BetaWebSearchToolResultBlock: …
class BetaWebSearchToolResultBlock: …
Accepts one of the following:
class BetaWebSearchToolResultError: …
class BetaWebSearchToolResultError: …
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"]
type: Literal["web_search_tool_result_error"]
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: str
page_age: Optional[str]
title: str
type: Literal["web_search_result"]
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"]
type: Literal["web_search_tool_result"]
Accepts one of the following:
"web_search_tool_result"
class BetaWebFetchToolResultBlock: …
class BetaWebFetchToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaWebFetchToolResultErrorBlock: …
class BetaWebFetchToolResultErrorBlock: …
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"]
type: Literal["web_fetch_tool_result_error"]
Accepts one of the following:
"web_fetch_tool_result_error"
class BetaWebFetchBlock: …
class BetaWebFetchBlock: …
citations: Optional[BetaCitationConfig]Citation configuration for the document
citations: Optional[BetaCitationConfig]
Citation configuration for the document
enabled: bool
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
title: Optional[str]
The title of the document
type: Literal["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"]
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"]
type: Literal["web_fetch_tool_result"]
Accepts one of the following:
"web_fetch_tool_result"
class BetaCodeExecutionToolResultBlock: …
class BetaCodeExecutionToolResultBlock: …
Accepts one of the following:
class BetaCodeExecutionToolResultError: …
class BetaCodeExecutionToolResultError: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
type: Literal["code_execution_tool_result_error"]
Accepts one of the following:
"code_execution_tool_result_error"
class BetaCodeExecutionResultBlock: …
class BetaCodeExecutionResultBlock: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
tool_use_id: str
type: Literal["code_execution_tool_result"]
type: Literal["code_execution_tool_result"]
Accepts one of the following:
"code_execution_tool_result"
class BetaBashCodeExecutionToolResultBlock: …
class BetaBashCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaBashCodeExecutionToolResultError: …
class BetaBashCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["bash_code_execution_tool_result_error"]
Accepts one of the following:
"bash_code_execution_tool_result_error"
class BetaBashCodeExecutionResultBlock: …
class BetaBashCodeExecutionResultBlock: …
file_id: str
type: Literal["bash_code_execution_output"]
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"]
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"]
type: Literal["bash_code_execution_tool_result"]
Accepts one of the following:
"bash_code_execution_tool_result"
class BetaTextEditorCodeExecutionToolResultBlock: …
class BetaTextEditorCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaTextEditorCodeExecutionToolResultError: …
class BetaTextEditorCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["text_editor_code_execution_tool_result_error"]
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
class BetaTextEditorCodeExecutionViewResultBlock: …
class BetaTextEditorCodeExecutionViewResultBlock: …
content: str
file_type: Literal["text", "image", "pdf"]
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"]
type: Literal["text_editor_code_execution_view_result"]
Accepts one of the following:
"text_editor_code_execution_view_result"
class BetaTextEditorCodeExecutionCreateResultBlock: …
class BetaTextEditorCodeExecutionCreateResultBlock: …
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
type: Literal["text_editor_code_execution_create_result"]
Accepts one of the following:
"text_editor_code_execution_create_result"
class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
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"]
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"]
type: Literal["text_editor_code_execution_tool_result"]
Accepts one of the following:
"text_editor_code_execution_tool_result"
class BetaMCPToolUseBlock: …
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"]
type: Literal["mcp_tool_use"]
Accepts one of the following:
"mcp_tool_use"
class BetaMCPToolResultBlock: …
class BetaMCPToolResultBlock: …
Accepts one of the following:
ContentUnionMember0 = str
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
is_error: bool
tool_use_id: str
type: Literal["mcp_tool_result"]
type: Literal["mcp_tool_result"]
Accepts one of the following:
"mcp_tool_result"
class BetaContainerUploadBlock: …Response model for a file uploaded to the container.
class BetaContainerUploadBlock: …
Response model for a file uploaded to the container.
file_id: str
type: Literal["container_upload"]
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.
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.
applied_edits: List[AppliedEdit]
List of context management edits that were applied.
Accepts one of the following:
class BetaClearToolUses20250919EditResponse: …
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.
type: Literal["clear_tool_uses_20250919"]
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
class BetaClearThinking20251015EditResponse: …
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.
type: Literal["clear_thinking_20251015"]
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
Accepts one of the following:
UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]The model that will complete your prompt.
See models for additional details and options.
claude-3-7-sonnet-latest - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-7-sonnet-20250219 - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-5-haiku-latest - Fastest and most compact model for near-instant 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
UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]
The model that will complete your prompt.
See models for additional details and options.
claude-3-7-sonnet-latest- Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-7-sonnet-20250219- Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-5-haiku-latest- Fastest and most compact model for near-instant 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
Accepts one of the following:
"claude-3-7-sonnet-latest"
High-performance model with early extended thinking
"claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
"claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
"claude-3-5-haiku-20241022"
Our fastest model
"claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
"claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
"claude-sonnet-4-20250514"
High-performance model with extended thinking
"claude-sonnet-4-0"
High-performance model with extended thinking
"claude-4-sonnet-20250514"
High-performance model with extended thinking
"claude-sonnet-4-5"
Our best model for real-world agents and coding
"claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
"claude-opus-4-0"
Our most capable model
"claude-opus-4-20250514"
Our most capable model
"claude-4-opus-20250514"
Our most capable model
"claude-opus-4-1-20250805"
Our most capable model
"claude-3-opus-latest"
Excels at writing and complex tasks
"claude-3-opus-20240229"
Excels at writing and complex tasks
"claude-3-haiku-20240307"
Our previous most fast and cost-effective
UnionMember1 = str
role: Literal["assistant"]Conversational role of the generated message.
This will always be "assistant".
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.
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.
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".
type: Literal["message"]
Object type.
For Messages, this is always "message".
Accepts one of the following:
"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.
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
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.
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.
service_tier: Optional[Literal["standard", "priority", "batch"]]
If the request used the priority, standard, or batch tier.
Accepts one of the following:
"standard"
"priority"
"batch"
type: Literal["message_start"]
type: Literal["message_start"]
Accepts one of the following:
"message_start"
class BetaRawMessageStopEvent: …
class BetaRawMessageStopEvent: …
type: Literal["message_stop"]
type: Literal["message_stop"]
Accepts one of the following:
"message_stop"
Accepts one of the following:
class BetaRawMessageStartEvent: …
class BetaRawMessageStartEvent: …
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)
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 loaded in the container
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)
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 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)"}]
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: …
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaThinkingBlock: …
class BetaThinkingBlock: …
signature: str
thinking: str
type: Literal["thinking"]
type: Literal["thinking"]
Accepts one of the following:
"thinking"
class BetaRedactedThinkingBlock: …
class BetaRedactedThinkingBlock: …
data: str
type: Literal["redacted_thinking"]
type: Literal["redacted_thinking"]
Accepts one of the following:
"redacted_thinking"
class BetaToolUseBlock: …
class BetaToolUseBlock: …
id: str
input: Dict[str, object]
name: str
minLength1
type: Literal["tool_use"]
type: Literal["tool_use"]
Accepts one of the following:
"tool_use"
class BetaServerToolUseBlock: …
class BetaServerToolUseBlock: …
id: str
input: Dict[str, object]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: Literal["server_tool_use"]
type: Literal["server_tool_use"]
Accepts one of the following:
"server_tool_use"
class BetaWebSearchToolResultBlock: …
class BetaWebSearchToolResultBlock: …
Accepts one of the following:
class BetaWebSearchToolResultError: …
class BetaWebSearchToolResultError: …
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"]
type: Literal["web_search_tool_result_error"]
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: str
page_age: Optional[str]
title: str
type: Literal["web_search_result"]
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"]
type: Literal["web_search_tool_result"]
Accepts one of the following:
"web_search_tool_result"
class BetaWebFetchToolResultBlock: …
class BetaWebFetchToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaWebFetchToolResultErrorBlock: …
class BetaWebFetchToolResultErrorBlock: …
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"]
type: Literal["web_fetch_tool_result_error"]
Accepts one of the following:
"web_fetch_tool_result_error"
class BetaWebFetchBlock: …
class BetaWebFetchBlock: …
citations: Optional[BetaCitationConfig]Citation configuration for the document
citations: Optional[BetaCitationConfig]
Citation configuration for the document
enabled: bool
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
title: Optional[str]
The title of the document
type: Literal["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"]
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"]
type: Literal["web_fetch_tool_result"]
Accepts one of the following:
"web_fetch_tool_result"
class BetaCodeExecutionToolResultBlock: …
class BetaCodeExecutionToolResultBlock: …
Accepts one of the following:
class BetaCodeExecutionToolResultError: …
class BetaCodeExecutionToolResultError: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
type: Literal["code_execution_tool_result_error"]
Accepts one of the following:
"code_execution_tool_result_error"
class BetaCodeExecutionResultBlock: …
class BetaCodeExecutionResultBlock: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
tool_use_id: str
type: Literal["code_execution_tool_result"]
type: Literal["code_execution_tool_result"]
Accepts one of the following:
"code_execution_tool_result"
class BetaBashCodeExecutionToolResultBlock: …
class BetaBashCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaBashCodeExecutionToolResultError: …
class BetaBashCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["bash_code_execution_tool_result_error"]
Accepts one of the following:
"bash_code_execution_tool_result_error"
class BetaBashCodeExecutionResultBlock: …
class BetaBashCodeExecutionResultBlock: …
file_id: str
type: Literal["bash_code_execution_output"]
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"]
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"]
type: Literal["bash_code_execution_tool_result"]
Accepts one of the following:
"bash_code_execution_tool_result"
class BetaTextEditorCodeExecutionToolResultBlock: …
class BetaTextEditorCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaTextEditorCodeExecutionToolResultError: …
class BetaTextEditorCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["text_editor_code_execution_tool_result_error"]
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
class BetaTextEditorCodeExecutionViewResultBlock: …
class BetaTextEditorCodeExecutionViewResultBlock: …
content: str
file_type: Literal["text", "image", "pdf"]
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"]
type: Literal["text_editor_code_execution_view_result"]
Accepts one of the following:
"text_editor_code_execution_view_result"
class BetaTextEditorCodeExecutionCreateResultBlock: …
class BetaTextEditorCodeExecutionCreateResultBlock: …
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
type: Literal["text_editor_code_execution_create_result"]
Accepts one of the following:
"text_editor_code_execution_create_result"
class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
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"]
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"]
type: Literal["text_editor_code_execution_tool_result"]
Accepts one of the following:
"text_editor_code_execution_tool_result"
class BetaMCPToolUseBlock: …
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"]
type: Literal["mcp_tool_use"]
Accepts one of the following:
"mcp_tool_use"
class BetaMCPToolResultBlock: …
class BetaMCPToolResultBlock: …
Accepts one of the following:
ContentUnionMember0 = str
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
is_error: bool
tool_use_id: str
type: Literal["mcp_tool_result"]
type: Literal["mcp_tool_result"]
Accepts one of the following:
"mcp_tool_result"
class BetaContainerUploadBlock: …Response model for a file uploaded to the container.
class BetaContainerUploadBlock: …
Response model for a file uploaded to the container.
file_id: str
type: Literal["container_upload"]
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.
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.
applied_edits: List[AppliedEdit]
List of context management edits that were applied.
Accepts one of the following:
class BetaClearToolUses20250919EditResponse: …
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.
type: Literal["clear_tool_uses_20250919"]
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
class BetaClearThinking20251015EditResponse: …
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.
type: Literal["clear_thinking_20251015"]
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
Accepts one of the following:
UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]The model that will complete your prompt.
See models for additional details and options.
claude-3-7-sonnet-latest - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-7-sonnet-20250219 - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-5-haiku-latest - Fastest and most compact model for near-instant 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
UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]
The model that will complete your prompt.
See models for additional details and options.
claude-3-7-sonnet-latest- Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-7-sonnet-20250219- Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-5-haiku-latest- Fastest and most compact model for near-instant 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
Accepts one of the following:
"claude-3-7-sonnet-latest"
High-performance model with early extended thinking
"claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
"claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
"claude-3-5-haiku-20241022"
Our fastest model
"claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
"claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
"claude-sonnet-4-20250514"
High-performance model with extended thinking
"claude-sonnet-4-0"
High-performance model with extended thinking
"claude-4-sonnet-20250514"
High-performance model with extended thinking
"claude-sonnet-4-5"
Our best model for real-world agents and coding
"claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
"claude-opus-4-0"
Our most capable model
"claude-opus-4-20250514"
Our most capable model
"claude-4-opus-20250514"
Our most capable model
"claude-opus-4-1-20250805"
Our most capable model
"claude-3-opus-latest"
Excels at writing and complex tasks
"claude-3-opus-20240229"
Excels at writing and complex tasks
"claude-3-haiku-20240307"
Our previous most fast and cost-effective
UnionMember1 = str
role: Literal["assistant"]Conversational role of the generated message.
This will always be "assistant".
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.
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.
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".
type: Literal["message"]
Object type.
For Messages, this is always "message".
Accepts one of the following:
"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.
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
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.
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.
service_tier: Optional[Literal["standard", "priority", "batch"]]
If the request used the priority, standard, or batch tier.
Accepts one of the following:
"standard"
"priority"
"batch"
type: Literal["message_start"]
type: Literal["message_start"]
Accepts one of the following:
"message_start"
class BetaRawMessageDeltaEvent: …
class BetaRawMessageDeltaEvent: …
context_management: Optional[BetaContextManagementResponse]Information about context management strategies applied during the request
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.
applied_edits: List[AppliedEdit]
List of context management edits that were applied.
Accepts one of the following:
class BetaClearToolUses20250919EditResponse: …
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.
type: Literal["clear_tool_uses_20250919"]
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
class BetaClearThinking20251015EditResponse: …
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.
type: Literal["clear_thinking_20251015"]
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
delta: Delta
delta: Delta
container: Optional[BetaContainer]Information about the container used in the request (for the code execution tool)
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 loaded in the container
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)
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]
stop_reason: Optional[BetaStopReason]
Accepts one of the following:
"end_turn"
"max_tokens"
"stop_sequence"
"tool_use"
"pause_turn"
"refusal"
"model_context_window_exceeded"
stop_sequence: Optional[str]
type: Literal["message_delta"]
type: Literal["message_delta"]
Accepts one of the following:
"message_delta"
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.
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
cache_creation_input_tokens: Optional[int]
The cumulative number of input tokens used to create the cache entry.
minimum0
cache_read_input_tokens: Optional[int]
The cumulative number of input tokens read from the cache.
minimum0
input_tokens: Optional[int]
The cumulative number of input tokens which were used.
minimum0
output_tokens: int
The cumulative number of output tokens which were used.
server_tool_use: Optional[BetaServerToolUsage]The number of server tool requests.
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 BetaRawMessageStopEvent: …
class BetaRawMessageStopEvent: …
type: Literal["message_stop"]
type: Literal["message_stop"]
Accepts one of the following:
"message_stop"
class BetaRawContentBlockStartEvent: …
class BetaRawContentBlockStartEvent: …
content_block: ContentBlockResponse model for a file uploaded to the container.
content_block: ContentBlock
Response model for a file uploaded to the container.
Accepts one of the following:
class BetaTextBlock: …
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaThinkingBlock: …
class BetaThinkingBlock: …
signature: str
thinking: str
type: Literal["thinking"]
type: Literal["thinking"]
Accepts one of the following:
"thinking"
class BetaRedactedThinkingBlock: …
class BetaRedactedThinkingBlock: …
data: str
type: Literal["redacted_thinking"]
type: Literal["redacted_thinking"]
Accepts one of the following:
"redacted_thinking"
class BetaToolUseBlock: …
class BetaToolUseBlock: …
id: str
input: Dict[str, object]
name: str
minLength1
type: Literal["tool_use"]
type: Literal["tool_use"]
Accepts one of the following:
"tool_use"
class BetaServerToolUseBlock: …
class BetaServerToolUseBlock: …
id: str
input: Dict[str, object]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: Literal["server_tool_use"]
type: Literal["server_tool_use"]
Accepts one of the following:
"server_tool_use"
class BetaWebSearchToolResultBlock: …
class BetaWebSearchToolResultBlock: …
Accepts one of the following:
class BetaWebSearchToolResultError: …
class BetaWebSearchToolResultError: …
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"]
type: Literal["web_search_tool_result_error"]
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: str
page_age: Optional[str]
title: str
type: Literal["web_search_result"]
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"]
type: Literal["web_search_tool_result"]
Accepts one of the following:
"web_search_tool_result"
class BetaWebFetchToolResultBlock: …
class BetaWebFetchToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaWebFetchToolResultErrorBlock: …
class BetaWebFetchToolResultErrorBlock: …
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"]
type: Literal["web_fetch_tool_result_error"]
Accepts one of the following:
"web_fetch_tool_result_error"
class BetaWebFetchBlock: …
class BetaWebFetchBlock: …
citations: Optional[BetaCitationConfig]Citation configuration for the document
citations: Optional[BetaCitationConfig]
Citation configuration for the document
enabled: bool
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
title: Optional[str]
The title of the document
type: Literal["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"]
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"]
type: Literal["web_fetch_tool_result"]
Accepts one of the following:
"web_fetch_tool_result"
class BetaCodeExecutionToolResultBlock: …
class BetaCodeExecutionToolResultBlock: …
Accepts one of the following:
class BetaCodeExecutionToolResultError: …
class BetaCodeExecutionToolResultError: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
type: Literal["code_execution_tool_result_error"]
Accepts one of the following:
"code_execution_tool_result_error"
class BetaCodeExecutionResultBlock: …
class BetaCodeExecutionResultBlock: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
tool_use_id: str
type: Literal["code_execution_tool_result"]
type: Literal["code_execution_tool_result"]
Accepts one of the following:
"code_execution_tool_result"
class BetaBashCodeExecutionToolResultBlock: …
class BetaBashCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaBashCodeExecutionToolResultError: …
class BetaBashCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["bash_code_execution_tool_result_error"]
Accepts one of the following:
"bash_code_execution_tool_result_error"
class BetaBashCodeExecutionResultBlock: …
class BetaBashCodeExecutionResultBlock: …
file_id: str
type: Literal["bash_code_execution_output"]
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"]
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"]
type: Literal["bash_code_execution_tool_result"]
Accepts one of the following:
"bash_code_execution_tool_result"
class BetaTextEditorCodeExecutionToolResultBlock: …
class BetaTextEditorCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaTextEditorCodeExecutionToolResultError: …
class BetaTextEditorCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["text_editor_code_execution_tool_result_error"]
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
class BetaTextEditorCodeExecutionViewResultBlock: …
class BetaTextEditorCodeExecutionViewResultBlock: …
content: str
file_type: Literal["text", "image", "pdf"]
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"]
type: Literal["text_editor_code_execution_view_result"]
Accepts one of the following:
"text_editor_code_execution_view_result"
class BetaTextEditorCodeExecutionCreateResultBlock: …
class BetaTextEditorCodeExecutionCreateResultBlock: …
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
type: Literal["text_editor_code_execution_create_result"]
Accepts one of the following:
"text_editor_code_execution_create_result"
class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
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"]
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"]
type: Literal["text_editor_code_execution_tool_result"]
Accepts one of the following:
"text_editor_code_execution_tool_result"
class BetaMCPToolUseBlock: …
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"]
type: Literal["mcp_tool_use"]
Accepts one of the following:
"mcp_tool_use"
class BetaMCPToolResultBlock: …
class BetaMCPToolResultBlock: …
Accepts one of the following:
ContentUnionMember0 = str
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
is_error: bool
tool_use_id: str
type: Literal["mcp_tool_result"]
type: Literal["mcp_tool_result"]
Accepts one of the following:
"mcp_tool_result"
class BetaContainerUploadBlock: …Response model for a file uploaded to the container.
class BetaContainerUploadBlock: …
Response model for a file uploaded to the container.
file_id: str
type: Literal["container_upload"]
type: Literal["container_upload"]
Accepts one of the following:
"container_upload"
index: int
type: Literal["content_block_start"]
type: Literal["content_block_start"]
Accepts one of the following:
"content_block_start"
class BetaRawContentBlockDeltaEvent: …
class BetaRawContentBlockDeltaEvent: …
Accepts one of the following:
class BetaTextDelta: …
class BetaTextDelta: …
text: str
type: Literal["text_delta"]
type: Literal["text_delta"]
Accepts one of the following:
"text_delta"
class BetaInputJSONDelta: …
class BetaInputJSONDelta: …
partial_json: str
type: Literal["input_json_delta"]
type: Literal["input_json_delta"]
Accepts one of the following:
"input_json_delta"
class BetaCitationsDelta: …
class BetaCitationsDelta: …
citation: Citation
citation: Citation
Accepts one of the following:
class BetaCitationCharLocation: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
type: Literal["citations_delta"]
type: Literal["citations_delta"]
Accepts one of the following:
"citations_delta"
class BetaThinkingDelta: …
class BetaThinkingDelta: …
thinking: str
type: Literal["thinking_delta"]
type: Literal["thinking_delta"]
Accepts one of the following:
"thinking_delta"
class BetaSignatureDelta: …
class BetaSignatureDelta: …
signature: str
type: Literal["signature_delta"]
type: Literal["signature_delta"]
Accepts one of the following:
"signature_delta"
index: int
type: Literal["content_block_delta"]
type: Literal["content_block_delta"]
Accepts one of the following:
"content_block_delta"
class BetaRawContentBlockStopEvent: …
class BetaRawContentBlockStopEvent: …
index: int
type: Literal["content_block_stop"]
type: Literal["content_block_stop"]
Accepts one of the following:
"content_block_stop"
class BetaRedactedThinkingBlock: …
class BetaRedactedThinkingBlock: …
data: str
type: Literal["redacted_thinking"]
type: Literal["redacted_thinking"]
Accepts one of the following:
"redacted_thinking"
class BetaRedactedThinkingBlockParam: …
class BetaRedactedThinkingBlockParam: …
data: str
type: Literal["redacted_thinking"]
type: Literal["redacted_thinking"]
Accepts one of the following:
"redacted_thinking"
class BetaRequestDocumentBlock: …
class BetaRequestDocumentBlock: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaContentBlockSource: …
class BetaContentBlockSource: …
Accepts one of the following:
ContentUnionMember0 = str
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
type: Literal["content"]
type: Literal["content"]
Accepts one of the following:
"content"
class BetaURLPDFSource: …
class BetaURLPDFSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileDocumentSource: …
class BetaFileDocumentSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["document"]
type: Literal["document"]
Accepts one of the following:
"document"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]
citations: Optional[BetaCitationsConfigParam]
enabled: Optional[bool]
context: Optional[str]
minLength1
title: Optional[str]
maxLength500
minLength1
class BetaRequestMCPServerToolConfiguration: …
class BetaRequestMCPServerToolConfiguration: …
allowed_tools: Optional[List[str]]
enabled: Optional[bool]
class BetaRequestMCPServerURLDefinition: …
class BetaRequestMCPServerURLDefinition: …
name: str
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
authorization_token: Optional[str]
tool_configuration: Optional[BetaRequestMCPServerToolConfiguration]
tool_configuration: Optional[BetaRequestMCPServerToolConfiguration]
allowed_tools: Optional[List[str]]
enabled: Optional[bool]
class BetaRequestMCPToolResultBlockParam: …
class BetaRequestMCPToolResultBlockParam: …
tool_use_id: str
type: Literal["mcp_tool_result"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
ContentUnionMember0 = str
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
is_error: Optional[bool]
class BetaSearchResultBlockParam: …
class BetaSearchResultBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
source: str
title: str
type: Literal["search_result"]
type: Literal["search_result"]
Accepts one of the following:
"search_result"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]
citations: Optional[BetaCitationsConfigParam]
enabled: Optional[bool]
class BetaServerToolUsage: …
class BetaServerToolUsage: …
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 BetaServerToolUseBlock: …
class BetaServerToolUseBlock: …
id: str
input: Dict[str, object]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: Literal["server_tool_use"]
type: Literal["server_tool_use"]
Accepts one of the following:
"server_tool_use"
class BetaServerToolUseBlockParam: …
class BetaServerToolUseBlockParam: …
id: str
input: Dict[str, object]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: Literal["server_tool_use"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaSignatureDelta: …
class BetaSignatureDelta: …
signature: str
type: Literal["signature_delta"]
type: Literal["signature_delta"]
Accepts one of the following:
"signature_delta"
class BetaSkill: …A skill that was loaded in a container (response model).
class BetaSkill: …
A skill that was loaded in a container (response model).
skill_id: str
Skill ID
maxLength64
minLength1
type: Literal["anthropic", "custom"]Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
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 BetaSkillParams: …Specification for a skill to be loaded in a container (request model).
class BetaSkillParams: …
Specification for a skill to be loaded in a container (request model).
skill_id: str
Skill ID
maxLength64
minLength1
type: Literal["anthropic", "custom"]Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
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
BetaStopReason = Literal["end_turn", "max_tokens", "stop_sequence", 4 more]
BetaStopReason = Literal["end_turn", "max_tokens", "stop_sequence", 4 more]
Accepts one of the following:
"end_turn"
"max_tokens"
"stop_sequence"
"tool_use"
"pause_turn"
"refusal"
"model_context_window_exceeded"
class BetaTextBlock: …
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
Accepts one of the following:
class BetaCitationCharLocation: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaTextDelta: …
class BetaTextDelta: …
text: str
type: Literal["text_delta"]
type: Literal["text_delta"]
Accepts one of the following:
"text_delta"
class BetaTextEditorCodeExecutionCreateResultBlock: …
class BetaTextEditorCodeExecutionCreateResultBlock: …
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
type: Literal["text_editor_code_execution_create_result"]
Accepts one of the following:
"text_editor_code_execution_create_result"
class BetaTextEditorCodeExecutionCreateResultBlockParam: …
class BetaTextEditorCodeExecutionCreateResultBlockParam: …
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
type: Literal["text_editor_code_execution_create_result"]
Accepts one of the following:
"text_editor_code_execution_create_result"
class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
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"]
type: Literal["text_editor_code_execution_str_replace_result"]
Accepts one of the following:
"text_editor_code_execution_str_replace_result"
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam: …
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam: …
type: Literal["text_editor_code_execution_str_replace_result"]
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]
class BetaTextEditorCodeExecutionToolResultBlock: …
class BetaTextEditorCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaTextEditorCodeExecutionToolResultError: …
class BetaTextEditorCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["text_editor_code_execution_tool_result_error"]
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
class BetaTextEditorCodeExecutionViewResultBlock: …
class BetaTextEditorCodeExecutionViewResultBlock: …
content: str
file_type: Literal["text", "image", "pdf"]
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"]
type: Literal["text_editor_code_execution_view_result"]
Accepts one of the following:
"text_editor_code_execution_view_result"
class BetaTextEditorCodeExecutionCreateResultBlock: …
class BetaTextEditorCodeExecutionCreateResultBlock: …
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
type: Literal["text_editor_code_execution_create_result"]
Accepts one of the following:
"text_editor_code_execution_create_result"
class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
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"]
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"]
type: Literal["text_editor_code_execution_tool_result"]
Accepts one of the following:
"text_editor_code_execution_tool_result"
class BetaTextEditorCodeExecutionToolResultBlockParam: …
class BetaTextEditorCodeExecutionToolResultBlockParam: …
content: Content
content: Content
Accepts one of the following:
class BetaTextEditorCodeExecutionToolResultErrorParam: …
class BetaTextEditorCodeExecutionToolResultErrorParam: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
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: …
class BetaTextEditorCodeExecutionViewResultBlockParam: …
content: str
file_type: Literal["text", "image", "pdf"]
file_type: Literal["text", "image", "pdf"]
Accepts one of the following:
"text"
"image"
"pdf"
type: Literal["text_editor_code_execution_view_result"]
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: …
class BetaTextEditorCodeExecutionCreateResultBlockParam: …
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
type: Literal["text_editor_code_execution_create_result"]
Accepts one of the following:
"text_editor_code_execution_create_result"
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam: …
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam: …
type: Literal["text_editor_code_execution_str_replace_result"]
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"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaTextEditorCodeExecutionToolResultError: …
class BetaTextEditorCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["text_editor_code_execution_tool_result_error"]
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
class BetaTextEditorCodeExecutionToolResultErrorParam: …
class BetaTextEditorCodeExecutionToolResultErrorParam: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
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 BetaTextEditorCodeExecutionViewResultBlock: …
class BetaTextEditorCodeExecutionViewResultBlock: …
content: str
file_type: Literal["text", "image", "pdf"]
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"]
type: Literal["text_editor_code_execution_view_result"]
Accepts one of the following:
"text_editor_code_execution_view_result"
class BetaTextEditorCodeExecutionViewResultBlockParam: …
class BetaTextEditorCodeExecutionViewResultBlockParam: …
content: str
file_type: Literal["text", "image", "pdf"]
file_type: Literal["text", "image", "pdf"]
Accepts one of the following:
"text"
"image"
"pdf"
type: Literal["text_editor_code_execution_view_result"]
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 BetaThinkingBlock: …
class BetaThinkingBlock: …
signature: str
thinking: str
type: Literal["thinking"]
type: Literal["thinking"]
Accepts one of the following:
"thinking"
class BetaThinkingBlockParam: …
class BetaThinkingBlockParam: …
signature: str
thinking: str
type: Literal["thinking"]
type: Literal["thinking"]
Accepts one of the following:
"thinking"
class BetaThinkingConfigDisabled: …
class BetaThinkingConfigDisabled: …
type: Literal["disabled"]
type: Literal["disabled"]
Accepts one of the following:
"disabled"
class BetaThinkingConfigEnabled: …
class BetaThinkingConfigEnabled: …
budget_tokens: int
Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.
Must be ≥1024 and less than max_tokens.
See extended thinking for details.
minimum1024
type: Literal["enabled"]
type: Literal["enabled"]
Accepts one of the following:
"enabled"
Configuration for enabling Claude's extended thinking.
When enabled, responses include thinking content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your max_tokens limit.
See extended thinking for details.
Configuration for enabling Claude's extended thinking.
When enabled, responses include thinking content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your max_tokens limit.
See extended thinking for details.
Accepts one of the following:
class BetaThinkingConfigEnabled: …
class BetaThinkingConfigEnabled: …
budget_tokens: int
Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.
Must be ≥1024 and less than max_tokens.
See extended thinking for details.
minimum1024
type: Literal["enabled"]
type: Literal["enabled"]
Accepts one of the following:
"enabled"
class BetaThinkingConfigDisabled: …
class BetaThinkingConfigDisabled: …
type: Literal["disabled"]
type: Literal["disabled"]
Accepts one of the following:
"disabled"
class BetaThinkingDelta: …
class BetaThinkingDelta: …
thinking: str
type: Literal["thinking_delta"]
type: Literal["thinking_delta"]
Accepts one of the following:
"thinking_delta"
class BetaThinkingTurns: …
class BetaThinkingTurns: …
type: Literal["thinking_turns"]
type: Literal["thinking_turns"]
Accepts one of the following:
"thinking_turns"
value: int
minimum1
class BetaTool: …
class BetaTool: …
input_schema: InputSchemaJSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
input_schema: InputSchema
JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
type: Literal["object"]
type: Literal["object"]
Accepts one of the following:
"object"
properties: Optional[Dict[str, object]]
required: Optional[List[str]]
name: str
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
maxLength128
minLength1
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
description: Optional[str]
Description of what this tool does.
Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.
type: Optional[Literal["custom"]]
type: Optional[Literal["custom"]]
Accepts one of the following:
"custom"
class BetaToolBash20241022: …
class BetaToolBash20241022: …
name: Literal["bash"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["bash"]
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"bash"
type: Literal["bash_20241022"]
type: Literal["bash_20241022"]
Accepts one of the following:
"bash_20241022"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaToolBash20250124: …
class BetaToolBash20250124: …
name: Literal["bash"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["bash"]
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"bash"
type: Literal["bash_20250124"]
type: Literal["bash_20250124"]
Accepts one of the following:
"bash_20250124"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.
How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.
Accepts one of the following:
class BetaToolChoiceAuto: …The model will automatically decide whether to use tools.
class BetaToolChoiceAuto: …
The model will automatically decide whether to use tools.
type: Literal["auto"]
type: Literal["auto"]
Accepts one of the following:
"auto"
disable_parallel_tool_use: Optional[bool]
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output at most one tool use.
class BetaToolChoiceAny: …The model will use any available tools.
class BetaToolChoiceAny: …
The model will use any available tools.
type: Literal["any"]
type: Literal["any"]
Accepts one of the following:
"any"
disable_parallel_tool_use: Optional[bool]
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
class BetaToolChoiceTool: …The model will use the specified tool with tool_choice.name.
class BetaToolChoiceTool: …
The model will use the specified tool with tool_choice.name.
name: str
The name of the tool to use.
type: Literal["tool"]
type: Literal["tool"]
Accepts one of the following:
"tool"
disable_parallel_tool_use: Optional[bool]
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
class BetaToolChoiceNone: …The model will not be allowed to use tools.
class BetaToolChoiceNone: …
The model will not be allowed to use tools.
type: Literal["none"]
type: Literal["none"]
Accepts one of the following:
"none"
class BetaToolChoiceAny: …The model will use any available tools.
class BetaToolChoiceAny: …
The model will use any available tools.
type: Literal["any"]
type: Literal["any"]
Accepts one of the following:
"any"
disable_parallel_tool_use: Optional[bool]
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
class BetaToolChoiceAuto: …The model will automatically decide whether to use tools.
class BetaToolChoiceAuto: …
The model will automatically decide whether to use tools.
type: Literal["auto"]
type: Literal["auto"]
Accepts one of the following:
"auto"
disable_parallel_tool_use: Optional[bool]
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output at most one tool use.
class BetaToolChoiceNone: …The model will not be allowed to use tools.
class BetaToolChoiceNone: …
The model will not be allowed to use tools.
type: Literal["none"]
type: Literal["none"]
Accepts one of the following:
"none"
class BetaToolChoiceTool: …The model will use the specified tool with tool_choice.name.
class BetaToolChoiceTool: …
The model will use the specified tool with tool_choice.name.
name: str
The name of the tool to use.
type: Literal["tool"]
type: Literal["tool"]
Accepts one of the following:
"tool"
disable_parallel_tool_use: Optional[bool]
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
class BetaToolComputerUse20241022: …
class BetaToolComputerUse20241022: …
display_height_px: int
The height of the display in pixels.
minimum1
display_width_px: int
The width of the display in pixels.
minimum1
name: Literal["computer"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["computer"]
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:
"computer"
type: Literal["computer_20241022"]
type: Literal["computer_20241022"]
Accepts one of the following:
"computer_20241022"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
display_number: Optional[int]
The X11 display number (e.g. 0, 1) for the display.
minimum0
class BetaToolComputerUse20250124: …
class BetaToolComputerUse20250124: …
display_height_px: int
The height of the display in pixels.
minimum1
display_width_px: int
The width of the display in pixels.
minimum1
name: Literal["computer"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["computer"]
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:
"computer"
type: Literal["computer_20250124"]
type: Literal["computer_20250124"]
Accepts one of the following:
"computer_20250124"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
display_number: Optional[int]
The X11 display number (e.g. 0, 1) for the display.
minimum0
class BetaToolResultBlockParam: …
class BetaToolResultBlockParam: …
tool_use_id: str
type: Literal["tool_result"]
type: Literal["tool_result"]
Accepts one of the following:
"tool_result"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
content: Optional[Union[str, List[Content], null]]
content: Optional[Union[str, List[Content], null]]
Accepts one of the following:
ContentUnionMember0 = str
Content = List[Content]
Content = List[Content]
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaSearchResultBlockParam: …
class BetaSearchResultBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
source: str
title: str
type: Literal["search_result"]
type: Literal["search_result"]
Accepts one of the following:
"search_result"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]
citations: Optional[BetaCitationsConfigParam]
enabled: Optional[bool]
class BetaRequestDocumentBlock: …
class BetaRequestDocumentBlock: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaContentBlockSource: …
class BetaContentBlockSource: …
Accepts one of the following:
ContentUnionMember0 = str
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
type: Literal["content"]
type: Literal["content"]
Accepts one of the following:
"content"
class BetaURLPDFSource: …
class BetaURLPDFSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileDocumentSource: …
class BetaFileDocumentSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["document"]
type: Literal["document"]
Accepts one of the following:
"document"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]
citations: Optional[BetaCitationsConfigParam]
enabled: Optional[bool]
context: Optional[str]
minLength1
title: Optional[str]
maxLength500
minLength1
is_error: Optional[bool]
class BetaToolTextEditor20241022: …
class BetaToolTextEditor20241022: …
name: Literal["str_replace_editor"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["str_replace_editor"]
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"str_replace_editor"
type: Literal["text_editor_20241022"]
type: Literal["text_editor_20241022"]
Accepts one of the following:
"text_editor_20241022"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaToolTextEditor20250124: …
class BetaToolTextEditor20250124: …
name: Literal["str_replace_editor"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["str_replace_editor"]
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"str_replace_editor"
type: Literal["text_editor_20250124"]
type: Literal["text_editor_20250124"]
Accepts one of the following:
"text_editor_20250124"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaToolTextEditor20250429: …
class BetaToolTextEditor20250429: …
name: Literal["str_replace_based_edit_tool"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["str_replace_based_edit_tool"]
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"str_replace_based_edit_tool"
type: Literal["text_editor_20250429"]
type: Literal["text_editor_20250429"]
Accepts one of the following:
"text_editor_20250429"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaToolTextEditor20250728: …
class BetaToolTextEditor20250728: …
name: Literal["str_replace_based_edit_tool"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["str_replace_based_edit_tool"]
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"str_replace_based_edit_tool"
type: Literal["text_editor_20250728"]
type: Literal["text_editor_20250728"]
Accepts one of the following:
"text_editor_20250728"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
max_characters: Optional[int]
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
minimum1
Accepts one of the following:
class BetaTool: …
class BetaTool: …
input_schema: InputSchemaJSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
input_schema: InputSchema
JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
type: Literal["object"]
type: Literal["object"]
Accepts one of the following:
"object"
properties: Optional[Dict[str, object]]
required: Optional[List[str]]
name: str
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
maxLength128
minLength1
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
description: Optional[str]
Description of what this tool does.
Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.
type: Optional[Literal["custom"]]
type: Optional[Literal["custom"]]
Accepts one of the following:
"custom"
class BetaToolBash20241022: …
class BetaToolBash20241022: …
name: Literal["bash"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["bash"]
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"bash"
type: Literal["bash_20241022"]
type: Literal["bash_20241022"]
Accepts one of the following:
"bash_20241022"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaToolBash20250124: …
class BetaToolBash20250124: …
name: Literal["bash"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["bash"]
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"bash"
type: Literal["bash_20250124"]
type: Literal["bash_20250124"]
Accepts one of the following:
"bash_20250124"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaCodeExecutionTool20250522: …
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.
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"]
type: Literal["code_execution_20250522"]
Accepts one of the following:
"code_execution_20250522"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaCodeExecutionTool20250825: …
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.
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"]
type: Literal["code_execution_20250825"]
Accepts one of the following:
"code_execution_20250825"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaToolComputerUse20241022: …
class BetaToolComputerUse20241022: …
display_height_px: int
The height of the display in pixels.
minimum1
display_width_px: int
The width of the display in pixels.
minimum1
name: Literal["computer"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["computer"]
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:
"computer"
type: Literal["computer_20241022"]
type: Literal["computer_20241022"]
Accepts one of the following:
"computer_20241022"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
display_number: Optional[int]
The X11 display number (e.g. 0, 1) for the display.
minimum0
class BetaMemoryTool20250818: …
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.
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"]
type: Literal["memory_20250818"]
Accepts one of the following:
"memory_20250818"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaToolComputerUse20250124: …
class BetaToolComputerUse20250124: …
display_height_px: int
The height of the display in pixels.
minimum1
display_width_px: int
The width of the display in pixels.
minimum1
name: Literal["computer"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["computer"]
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:
"computer"
type: Literal["computer_20250124"]
type: Literal["computer_20250124"]
Accepts one of the following:
"computer_20250124"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
display_number: Optional[int]
The X11 display number (e.g. 0, 1) for the display.
minimum0
class BetaToolTextEditor20241022: …
class BetaToolTextEditor20241022: …
name: Literal["str_replace_editor"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["str_replace_editor"]
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"str_replace_editor"
type: Literal["text_editor_20241022"]
type: Literal["text_editor_20241022"]
Accepts one of the following:
"text_editor_20241022"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaToolTextEditor20250124: …
class BetaToolTextEditor20250124: …
name: Literal["str_replace_editor"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["str_replace_editor"]
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"str_replace_editor"
type: Literal["text_editor_20250124"]
type: Literal["text_editor_20250124"]
Accepts one of the following:
"text_editor_20250124"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaToolTextEditor20250429: …
class BetaToolTextEditor20250429: …
name: Literal["str_replace_based_edit_tool"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["str_replace_based_edit_tool"]
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"str_replace_based_edit_tool"
type: Literal["text_editor_20250429"]
type: Literal["text_editor_20250429"]
Accepts one of the following:
"text_editor_20250429"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaToolTextEditor20250728: …
class BetaToolTextEditor20250728: …
name: Literal["str_replace_based_edit_tool"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["str_replace_based_edit_tool"]
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"str_replace_based_edit_tool"
type: Literal["text_editor_20250728"]
type: Literal["text_editor_20250728"]
Accepts one of the following:
"text_editor_20250728"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
max_characters: Optional[int]
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
minimum1
class BetaWebSearchTool20250305: …
class BetaWebSearchTool20250305: …
name: Literal["web_search"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["web_search"]
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"web_search"
type: Literal["web_search_20250305"]
type: Literal["web_search_20250305"]
Accepts one of the following:
"web_search_20250305"
allowed_domains: Optional[List[str]]
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
blocked_domains: Optional[List[str]]
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
max_uses: Optional[int]
Maximum number of times the tool can be used in the API request.
exclusiveMinimum0
user_location: Optional[UserLocation]Parameters for the user's location. Used to provide more relevant search results.
user_location: Optional[UserLocation]
Parameters for the user's location. Used to provide more relevant search results.
type: Literal["approximate"]
type: Literal["approximate"]
Accepts one of the following:
"approximate"
city: Optional[str]
The city of the user.
maxLength255
minLength1
region: Optional[str]
The region of the user.
maxLength255
minLength1
class BetaWebFetchTool20250910: …
class BetaWebFetchTool20250910: …
name: Literal["web_fetch"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["web_fetch"]
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"web_fetch"
type: Literal["web_fetch_20250910"]
type: Literal["web_fetch_20250910"]
Accepts one of the following:
"web_fetch_20250910"
allowed_domains: Optional[List[str]]
List of domains to allow fetching from
blocked_domains: Optional[List[str]]
List of domains to block fetching from
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]Citations configuration for fetched documents. Citations are disabled by default.
citations: Optional[BetaCitationsConfigParam]
Citations configuration for fetched documents. Citations are disabled by default.
enabled: Optional[bool]
max_content_tokens: Optional[int]
Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
exclusiveMinimum0
max_uses: Optional[int]
Maximum number of times the tool can be used in the API request.
exclusiveMinimum0
class BetaToolUseBlock: …
class BetaToolUseBlock: …
id: str
input: Dict[str, object]
name: str
minLength1
type: Literal["tool_use"]
type: Literal["tool_use"]
Accepts one of the following:
"tool_use"
class BetaToolUseBlockParam: …
class BetaToolUseBlockParam: …
id: str
input: Dict[str, object]
name: str
maxLength200
minLength1
type: Literal["tool_use"]
type: Literal["tool_use"]
Accepts one of the following:
"tool_use"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaToolUsesKeep: …
class BetaToolUsesKeep: …
type: Literal["tool_uses"]
type: Literal["tool_uses"]
Accepts one of the following:
"tool_uses"
value: int
minimum0
class BetaToolUsesTrigger: …
class BetaToolUsesTrigger: …
type: Literal["tool_uses"]
type: Literal["tool_uses"]
Accepts one of the following:
"tool_uses"
value: int
minimum1
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaURLPDFSource: …
class BetaURLPDFSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaUsage: …
class BetaUsage: …
cache_creation: Optional[BetaCacheCreation]Breakdown of cached tokens by TTL
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.
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.
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 BetaWebFetchBlock: …
class BetaWebFetchBlock: …
citations: Optional[BetaCitationConfig]Citation configuration for the document
citations: Optional[BetaCitationConfig]
Citation configuration for the document
enabled: bool
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
title: Optional[str]
The title of the document
type: Literal["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"]
type: Literal["web_fetch_result"]
Accepts one of the following:
"web_fetch_result"
url: str
Fetched content URL
class BetaWebFetchBlockParam: …
class BetaWebFetchBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaContentBlockSource: …
class BetaContentBlockSource: …
Accepts one of the following:
ContentUnionMember0 = str
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
type: Literal["content"]
type: Literal["content"]
Accepts one of the following:
"content"
class BetaURLPDFSource: …
class BetaURLPDFSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileDocumentSource: …
class BetaFileDocumentSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["document"]
type: Literal["document"]
Accepts one of the following:
"document"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]
citations: Optional[BetaCitationsConfigParam]
enabled: Optional[bool]
context: Optional[str]
minLength1
title: Optional[str]
maxLength500
minLength1
type: Literal["web_fetch_result"]
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
class BetaWebFetchTool20250910: …
class BetaWebFetchTool20250910: …
name: Literal["web_fetch"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["web_fetch"]
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"web_fetch"
type: Literal["web_fetch_20250910"]
type: Literal["web_fetch_20250910"]
Accepts one of the following:
"web_fetch_20250910"
allowed_domains: Optional[List[str]]
List of domains to allow fetching from
blocked_domains: Optional[List[str]]
List of domains to block fetching from
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]Citations configuration for fetched documents. Citations are disabled by default.
citations: Optional[BetaCitationsConfigParam]
Citations configuration for fetched documents. Citations are disabled by default.
enabled: Optional[bool]
max_content_tokens: Optional[int]
Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
exclusiveMinimum0
max_uses: Optional[int]
Maximum number of times the tool can be used in the API request.
exclusiveMinimum0
class BetaWebFetchToolResultBlock: …
class BetaWebFetchToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaWebFetchToolResultErrorBlock: …
class BetaWebFetchToolResultErrorBlock: …
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"]
type: Literal["web_fetch_tool_result_error"]
Accepts one of the following:
"web_fetch_tool_result_error"
class BetaWebFetchBlock: …
class BetaWebFetchBlock: …
citations: Optional[BetaCitationConfig]Citation configuration for the document
citations: Optional[BetaCitationConfig]
Citation configuration for the document
enabled: bool
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
title: Optional[str]
The title of the document
type: Literal["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"]
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"]
type: Literal["web_fetch_tool_result"]
Accepts one of the following:
"web_fetch_tool_result"
class BetaWebFetchToolResultBlockParam: …
class BetaWebFetchToolResultBlockParam: …
content: Content
content: Content
Accepts one of the following:
class BetaWebFetchToolResultErrorBlockParam: …
class BetaWebFetchToolResultErrorBlockParam: …
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"]
type: Literal["web_fetch_tool_result_error"]
Accepts one of the following:
"web_fetch_tool_result_error"
class BetaWebFetchBlockParam: …
class BetaWebFetchBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaContentBlockSource: …
class BetaContentBlockSource: …
Accepts one of the following:
ContentUnionMember0 = str
Accepts one of the following:
class BetaTextBlockParam: …
class BetaTextBlockParam: …
text: str
minLength1
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
class BetaCitationCharLocationParam: …
class BetaCitationCharLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocationParam: …
class BetaCitationPageLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocationParam: …
class BetaCitationContentBlockLocationParam: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength255
minLength1
end_block_index: int
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationWebSearchResultLocationParam: …
class BetaCitationWebSearchResultLocationParam: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
maxLength2048
minLength1
class BetaCitationSearchResultLocationParam: …
class BetaCitationSearchResultLocationParam: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
class BetaImageBlockParam: …
class BetaImageBlockParam: …
source: Source
source: Source
Accepts one of the following:
class BetaBase64ImageSource: …
class BetaBase64ImageSource: …
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
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"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaURLImageSource: …
class BetaURLImageSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileImageSource: …
class BetaFileImageSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["image"]
type: Literal["image"]
Accepts one of the following:
"image"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
type: Literal["content"]
type: Literal["content"]
Accepts one of the following:
"content"
class BetaURLPDFSource: …
class BetaURLPDFSource: …
type: Literal["url"]
type: Literal["url"]
Accepts one of the following:
"url"
url: str
class BetaFileDocumentSource: …
class BetaFileDocumentSource: …
file_id: str
type: Literal["file"]
type: Literal["file"]
Accepts one of the following:
"file"
type: Literal["document"]
type: Literal["document"]
Accepts one of the following:
"document"
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
citations: Optional[BetaCitationsConfigParam]
citations: Optional[BetaCitationsConfigParam]
enabled: Optional[bool]
context: Optional[str]
minLength1
title: Optional[str]
maxLength500
minLength1
type: Literal["web_fetch_result"]
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"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
class BetaWebFetchToolResultErrorBlock: …
class BetaWebFetchToolResultErrorBlock: …
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"]
type: Literal["web_fetch_tool_result_error"]
Accepts one of the following:
"web_fetch_tool_result_error"
class BetaWebFetchToolResultErrorBlockParam: …
class BetaWebFetchToolResultErrorBlockParam: …
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"]
type: Literal["web_fetch_tool_result_error"]
Accepts one of the following:
"web_fetch_tool_result_error"
BetaWebFetchToolResultErrorCode = Literal["invalid_tool_input", "url_too_long", "url_not_allowed", 5 more]
BetaWebFetchToolResultErrorCode = Literal["invalid_tool_input", "url_too_long", "url_not_allowed", 5 more]
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"
class BetaWebSearchResultBlock: …
class BetaWebSearchResultBlock: …
encrypted_content: str
page_age: Optional[str]
title: str
type: Literal["web_search_result"]
type: Literal["web_search_result"]
Accepts one of the following:
"web_search_result"
url: str
class BetaWebSearchResultBlockParam: …
class BetaWebSearchResultBlockParam: …
encrypted_content: str
title: str
type: Literal["web_search_result"]
type: Literal["web_search_result"]
Accepts one of the following:
"web_search_result"
url: str
page_age: Optional[str]
class BetaWebSearchTool20250305: …
class BetaWebSearchTool20250305: …
name: Literal["web_search"]Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
name: Literal["web_search"]
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Accepts one of the following:
"web_search"
type: Literal["web_search_20250305"]
type: Literal["web_search_20250305"]
Accepts one of the following:
"web_search_20250305"
allowed_domains: Optional[List[str]]
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
blocked_domains: Optional[List[str]]
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
cache_control: Optional[BetaCacheControlEphemeral]Create a cache control breakpoint at this content block.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
max_uses: Optional[int]
Maximum number of times the tool can be used in the API request.
exclusiveMinimum0
user_location: Optional[UserLocation]Parameters for the user's location. Used to provide more relevant search results.
user_location: Optional[UserLocation]
Parameters for the user's location. Used to provide more relevant search results.
type: Literal["approximate"]
type: Literal["approximate"]
Accepts one of the following:
"approximate"
city: Optional[str]
The city of the user.
maxLength255
minLength1
region: Optional[str]
The region of the user.
maxLength255
minLength1
class BetaWebSearchToolRequestError: …
class BetaWebSearchToolRequestError: …
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"]
type: Literal["web_search_tool_result_error"]
Accepts one of the following:
"web_search_tool_result_error"
class BetaWebSearchToolResultBlock: …
class BetaWebSearchToolResultBlock: …
Accepts one of the following:
class BetaWebSearchToolResultError: …
class BetaWebSearchToolResultError: …
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"]
type: Literal["web_search_tool_result_error"]
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: str
page_age: Optional[str]
title: str
type: Literal["web_search_result"]
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"]
type: Literal["web_search_tool_result"]
Accepts one of the following:
"web_search_tool_result"
Accepts one of the following:
class BetaWebSearchToolResultError: …
class BetaWebSearchToolResultError: …
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"]
type: Literal["web_search_tool_result_error"]
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: str
page_age: Optional[str]
title: str
type: Literal["web_search_result"]
type: Literal["web_search_result"]
Accepts one of the following:
"web_search_result"
url: str
class BetaWebSearchToolResultBlockParam: …
class BetaWebSearchToolResultBlockParam: …
Accepts one of the following:
encrypted_content: str
title: str
type: Literal["web_search_result"]
type: Literal["web_search_result"]
Accepts one of the following:
"web_search_result"
url: str
page_age: Optional[str]
class BetaWebSearchToolRequestError: …
class BetaWebSearchToolRequestError: …
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"]
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"]
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.
cache_control: Optional[BetaCacheControlEphemeral]
Create a cache control breakpoint at this content block.
type: Literal["ephemeral"]
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 minutes1h: 1 hour
Defaults to 5m.
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.
Accepts one of the following:
"5m"
"1h"
Accepts one of the following:
encrypted_content: str
title: str
type: Literal["web_search_result"]
type: Literal["web_search_result"]
Accepts one of the following:
"web_search_result"
url: str
page_age: Optional[str]
class BetaWebSearchToolRequestError: …
class BetaWebSearchToolRequestError: …
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"]
type: Literal["web_search_tool_result_error"]
Accepts one of the following:
"web_search_tool_result_error"
class BetaWebSearchToolResultError: …
class BetaWebSearchToolResultError: …
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"]
type: Literal["web_search_tool_result_error"]
Accepts one of the following:
"web_search_tool_result_error"
BetaWebSearchToolResultErrorCode = Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
BetaWebSearchToolResultErrorCode = Literal["invalid_tool_input", "unavailable", "max_uses_exceeded", 2 more]
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
BetaMessagesBatches
Cancel a Message Batch
beta.messages.batches.cancel(strmessage_batch_id, BatchCancelParams**kwargs) -> BetaMessageBatch
post/v1/messages/batches/{message_batch_id}/cancel?beta=true
Create a Message Batch
beta.messages.batches.create(BatchCreateParams**kwargs) -> BetaMessageBatch
post/v1/messages/batches?beta=true
Delete a Message Batch
beta.messages.batches.delete(strmessage_batch_id, BatchDeleteParams**kwargs) -> BetaDeletedMessageBatch
delete/v1/messages/batches/{message_batch_id}?beta=true
List Message Batches
beta.messages.batches.list(BatchListParams**kwargs) -> SyncPage[BetaMessageBatch]
get/v1/messages/batches?beta=true
Retrieve Message Batch results
beta.messages.batches.results(strmessage_batch_id, BatchResultsParams**kwargs) -> BetaMessageBatchIndividualResponse
get/v1/messages/batches/{message_batch_id}/results?beta=true
Retrieve a Message Batch
beta.messages.batches.retrieve(strmessage_batch_id, BatchRetrieveParams**kwargs) -> BetaMessageBatch
get/v1/messages/batches/{message_batch_id}?beta=true
ModelsExpand Collapse
class BetaDeletedMessageBatch: …
class BetaDeletedMessageBatch: …
id: str
ID of the Message Batch.
type: Literal["message_batch_deleted"]Deleted object type.
For Message Batches, this is always "message_batch_deleted".
type: Literal["message_batch_deleted"]
Deleted object type.
For Message Batches, this is always "message_batch_deleted".
Accepts one of the following:
"message_batch_deleted"
class BetaMessageBatch: …
class BetaMessageBatch: …
id: str
Unique object identifier.
The format and length of IDs may change over time.
archived_at: Optional[datetime]
RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable.
formatdate-time
cancel_initiated_at: Optional[datetime]
RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated.
formatdate-time
created_at: datetime
RFC 3339 datetime string representing the time at which the Message Batch was created.
formatdate-time
ended_at: Optional[datetime]
RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends.
Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired.
formatdate-time
expires_at: datetime
RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.
formatdate-time
processing_status: Literal["in_progress", "canceling", "ended"]Processing status of the Message Batch.
processing_status: Literal["in_progress", "canceling", "ended"]
Processing status of the Message Batch.
Accepts one of the following:
"in_progress"
"canceling"
"ended"
Tallies requests within the Message Batch, categorized by their status.
Requests start as processing and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch.
Tallies requests within the Message Batch, categorized by their status.
Requests start as processing and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch.
canceled: int
Number of requests in the Message Batch that have been canceled.
This is zero until processing of the entire Message Batch has ended.
errored: int
Number of requests in the Message Batch that encountered an error.
This is zero until processing of the entire Message Batch has ended.
expired: int
Number of requests in the Message Batch that have expired.
This is zero until processing of the entire Message Batch has ended.
processing: int
Number of requests in the Message Batch that are processing.
succeeded: int
Number of requests in the Message Batch that have completed successfully.
This is zero until processing of the entire Message Batch has ended.
results_url: Optional[str]
URL to a .jsonl file containing the results of the Message Batch requests. Specified only once processing ends.
Results in the file are not guaranteed to be in the same order as requests. Use the custom_id field to match results to requests.
type: Literal["message_batch"]Object type.
For Message Batches, this is always "message_batch".
type: Literal["message_batch"]
Object type.
For Message Batches, this is always "message_batch".
Accepts one of the following:
"message_batch"
class BetaMessageBatchCanceledResult: …
class BetaMessageBatchCanceledResult: …
type: Literal["canceled"]
type: Literal["canceled"]
Accepts one of the following:
"canceled"
class BetaMessageBatchErroredResult: …
class BetaMessageBatchErroredResult: …
Accepts one of the following:
class BetaInvalidRequestError: …
class BetaInvalidRequestError: …
message: str
type: Literal["invalid_request_error"]
type: Literal["invalid_request_error"]
Accepts one of the following:
"invalid_request_error"
class BetaAuthenticationError: …
class BetaAuthenticationError: …
message: str
type: Literal["authentication_error"]
type: Literal["authentication_error"]
Accepts one of the following:
"authentication_error"
class BetaBillingError: …
class BetaBillingError: …
message: str
type: Literal["billing_error"]
type: Literal["billing_error"]
Accepts one of the following:
"billing_error"
class BetaPermissionError: …
class BetaPermissionError: …
message: str
type: Literal["permission_error"]
type: Literal["permission_error"]
Accepts one of the following:
"permission_error"
class BetaNotFoundError: …
class BetaNotFoundError: …
message: str
type: Literal["not_found_error"]
type: Literal["not_found_error"]
Accepts one of the following:
"not_found_error"
class BetaRateLimitError: …
class BetaRateLimitError: …
message: str
type: Literal["rate_limit_error"]
type: Literal["rate_limit_error"]
Accepts one of the following:
"rate_limit_error"
class BetaGatewayTimeoutError: …
class BetaGatewayTimeoutError: …
message: str
type: Literal["timeout_error"]
type: Literal["timeout_error"]
Accepts one of the following:
"timeout_error"
class BetaAPIError: …
class BetaAPIError: …
message: str
type: Literal["api_error"]
type: Literal["api_error"]
Accepts one of the following:
"api_error"
class BetaOverloadedError: …
class BetaOverloadedError: …
message: str
type: Literal["overloaded_error"]
type: Literal["overloaded_error"]
Accepts one of the following:
"overloaded_error"
request_id: Optional[str]
type: Literal["error"]
type: Literal["error"]
Accepts one of the following:
"error"
type: Literal["errored"]
type: Literal["errored"]
Accepts one of the following:
"errored"
class BetaMessageBatchExpiredResult: …
class BetaMessageBatchExpiredResult: …
type: Literal["expired"]
type: Literal["expired"]
Accepts one of the following:
"expired"
class BetaMessageBatchIndividualResponse: …This is a single line in the response .jsonl file and does not represent the response as a whole.
class BetaMessageBatchIndividualResponse: …
This is a single line in the response .jsonl file and does not represent the response as a whole.
custom_id: str
Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order.
Must be unique for each request within the Message Batch.
Processing result for this request.
Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.
Processing result for this request.
Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.
Accepts one of the following:
class BetaMessageBatchSucceededResult: …
class BetaMessageBatchSucceededResult: …
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)
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 loaded in the container
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)
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 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)"}]
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: …
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaThinkingBlock: …
class BetaThinkingBlock: …
signature: str
thinking: str
type: Literal["thinking"]
type: Literal["thinking"]
Accepts one of the following:
"thinking"
class BetaRedactedThinkingBlock: …
class BetaRedactedThinkingBlock: …
data: str
type: Literal["redacted_thinking"]
type: Literal["redacted_thinking"]
Accepts one of the following:
"redacted_thinking"
class BetaToolUseBlock: …
class BetaToolUseBlock: …
id: str
input: Dict[str, object]
name: str
minLength1
type: Literal["tool_use"]
type: Literal["tool_use"]
Accepts one of the following:
"tool_use"
class BetaServerToolUseBlock: …
class BetaServerToolUseBlock: …
id: str
input: Dict[str, object]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: Literal["server_tool_use"]
type: Literal["server_tool_use"]
Accepts one of the following:
"server_tool_use"
class BetaWebSearchToolResultBlock: …
class BetaWebSearchToolResultBlock: …
Accepts one of the following:
class BetaWebSearchToolResultError: …
class BetaWebSearchToolResultError: …
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"]
type: Literal["web_search_tool_result_error"]
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: str
page_age: Optional[str]
title: str
type: Literal["web_search_result"]
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"]
type: Literal["web_search_tool_result"]
Accepts one of the following:
"web_search_tool_result"
class BetaWebFetchToolResultBlock: …
class BetaWebFetchToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaWebFetchToolResultErrorBlock: …
class BetaWebFetchToolResultErrorBlock: …
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"]
type: Literal["web_fetch_tool_result_error"]
Accepts one of the following:
"web_fetch_tool_result_error"
class BetaWebFetchBlock: …
class BetaWebFetchBlock: …
citations: Optional[BetaCitationConfig]Citation configuration for the document
citations: Optional[BetaCitationConfig]
Citation configuration for the document
enabled: bool
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
title: Optional[str]
The title of the document
type: Literal["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"]
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"]
type: Literal["web_fetch_tool_result"]
Accepts one of the following:
"web_fetch_tool_result"
class BetaCodeExecutionToolResultBlock: …
class BetaCodeExecutionToolResultBlock: …
Accepts one of the following:
class BetaCodeExecutionToolResultError: …
class BetaCodeExecutionToolResultError: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
type: Literal["code_execution_tool_result_error"]
Accepts one of the following:
"code_execution_tool_result_error"
class BetaCodeExecutionResultBlock: …
class BetaCodeExecutionResultBlock: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
tool_use_id: str
type: Literal["code_execution_tool_result"]
type: Literal["code_execution_tool_result"]
Accepts one of the following:
"code_execution_tool_result"
class BetaBashCodeExecutionToolResultBlock: …
class BetaBashCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaBashCodeExecutionToolResultError: …
class BetaBashCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["bash_code_execution_tool_result_error"]
Accepts one of the following:
"bash_code_execution_tool_result_error"
class BetaBashCodeExecutionResultBlock: …
class BetaBashCodeExecutionResultBlock: …
file_id: str
type: Literal["bash_code_execution_output"]
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"]
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"]
type: Literal["bash_code_execution_tool_result"]
Accepts one of the following:
"bash_code_execution_tool_result"
class BetaTextEditorCodeExecutionToolResultBlock: …
class BetaTextEditorCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaTextEditorCodeExecutionToolResultError: …
class BetaTextEditorCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["text_editor_code_execution_tool_result_error"]
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
class BetaTextEditorCodeExecutionViewResultBlock: …
class BetaTextEditorCodeExecutionViewResultBlock: …
content: str
file_type: Literal["text", "image", "pdf"]
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"]
type: Literal["text_editor_code_execution_view_result"]
Accepts one of the following:
"text_editor_code_execution_view_result"
class BetaTextEditorCodeExecutionCreateResultBlock: …
class BetaTextEditorCodeExecutionCreateResultBlock: …
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
type: Literal["text_editor_code_execution_create_result"]
Accepts one of the following:
"text_editor_code_execution_create_result"
class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
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"]
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"]
type: Literal["text_editor_code_execution_tool_result"]
Accepts one of the following:
"text_editor_code_execution_tool_result"
class BetaMCPToolUseBlock: …
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"]
type: Literal["mcp_tool_use"]
Accepts one of the following:
"mcp_tool_use"
class BetaMCPToolResultBlock: …
class BetaMCPToolResultBlock: …
Accepts one of the following:
ContentUnionMember0 = str
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
is_error: bool
tool_use_id: str
type: Literal["mcp_tool_result"]
type: Literal["mcp_tool_result"]
Accepts one of the following:
"mcp_tool_result"
class BetaContainerUploadBlock: …Response model for a file uploaded to the container.
class BetaContainerUploadBlock: …
Response model for a file uploaded to the container.
file_id: str
type: Literal["container_upload"]
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.
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.
applied_edits: List[AppliedEdit]
List of context management edits that were applied.
Accepts one of the following:
class BetaClearToolUses20250919EditResponse: …
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.
type: Literal["clear_tool_uses_20250919"]
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
class BetaClearThinking20251015EditResponse: …
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.
type: Literal["clear_thinking_20251015"]
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
Accepts one of the following:
UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]The model that will complete your prompt.
See models for additional details and options.
claude-3-7-sonnet-latest - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-7-sonnet-20250219 - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-5-haiku-latest - Fastest and most compact model for near-instant 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
UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]
The model that will complete your prompt.
See models for additional details and options.
claude-3-7-sonnet-latest- Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-7-sonnet-20250219- Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-5-haiku-latest- Fastest and most compact model for near-instant 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
Accepts one of the following:
"claude-3-7-sonnet-latest"
High-performance model with early extended thinking
"claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
"claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
"claude-3-5-haiku-20241022"
Our fastest model
"claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
"claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
"claude-sonnet-4-20250514"
High-performance model with extended thinking
"claude-sonnet-4-0"
High-performance model with extended thinking
"claude-4-sonnet-20250514"
High-performance model with extended thinking
"claude-sonnet-4-5"
Our best model for real-world agents and coding
"claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
"claude-opus-4-0"
Our most capable model
"claude-opus-4-20250514"
Our most capable model
"claude-4-opus-20250514"
Our most capable model
"claude-opus-4-1-20250805"
Our most capable model
"claude-3-opus-latest"
Excels at writing and complex tasks
"claude-3-opus-20240229"
Excels at writing and complex tasks
"claude-3-haiku-20240307"
Our previous most fast and cost-effective
UnionMember1 = str
role: Literal["assistant"]Conversational role of the generated message.
This will always be "assistant".
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.
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.
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".
type: Literal["message"]
Object type.
For Messages, this is always "message".
Accepts one of the following:
"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.
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
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.
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.
service_tier: Optional[Literal["standard", "priority", "batch"]]
If the request used the priority, standard, or batch tier.
Accepts one of the following:
"standard"
"priority"
"batch"
type: Literal["succeeded"]
type: Literal["succeeded"]
Accepts one of the following:
"succeeded"
class BetaMessageBatchErroredResult: …
class BetaMessageBatchErroredResult: …
Accepts one of the following:
class BetaInvalidRequestError: …
class BetaInvalidRequestError: …
message: str
type: Literal["invalid_request_error"]
type: Literal["invalid_request_error"]
Accepts one of the following:
"invalid_request_error"
class BetaAuthenticationError: …
class BetaAuthenticationError: …
message: str
type: Literal["authentication_error"]
type: Literal["authentication_error"]
Accepts one of the following:
"authentication_error"
class BetaBillingError: …
class BetaBillingError: …
message: str
type: Literal["billing_error"]
type: Literal["billing_error"]
Accepts one of the following:
"billing_error"
class BetaPermissionError: …
class BetaPermissionError: …
message: str
type: Literal["permission_error"]
type: Literal["permission_error"]
Accepts one of the following:
"permission_error"
class BetaNotFoundError: …
class BetaNotFoundError: …
message: str
type: Literal["not_found_error"]
type: Literal["not_found_error"]
Accepts one of the following:
"not_found_error"
class BetaRateLimitError: …
class BetaRateLimitError: …
message: str
type: Literal["rate_limit_error"]
type: Literal["rate_limit_error"]
Accepts one of the following:
"rate_limit_error"
class BetaGatewayTimeoutError: …
class BetaGatewayTimeoutError: …
message: str
type: Literal["timeout_error"]
type: Literal["timeout_error"]
Accepts one of the following:
"timeout_error"
class BetaAPIError: …
class BetaAPIError: …
message: str
type: Literal["api_error"]
type: Literal["api_error"]
Accepts one of the following:
"api_error"
class BetaOverloadedError: …
class BetaOverloadedError: …
message: str
type: Literal["overloaded_error"]
type: Literal["overloaded_error"]
Accepts one of the following:
"overloaded_error"
request_id: Optional[str]
type: Literal["error"]
type: Literal["error"]
Accepts one of the following:
"error"
type: Literal["errored"]
type: Literal["errored"]
Accepts one of the following:
"errored"
class BetaMessageBatchCanceledResult: …
class BetaMessageBatchCanceledResult: …
type: Literal["canceled"]
type: Literal["canceled"]
Accepts one of the following:
"canceled"
class BetaMessageBatchExpiredResult: …
class BetaMessageBatchExpiredResult: …
type: Literal["expired"]
type: Literal["expired"]
Accepts one of the following:
"expired"
class BetaMessageBatchRequestCounts: …
class BetaMessageBatchRequestCounts: …
canceled: int
Number of requests in the Message Batch that have been canceled.
This is zero until processing of the entire Message Batch has ended.
errored: int
Number of requests in the Message Batch that encountered an error.
This is zero until processing of the entire Message Batch has ended.
expired: int
Number of requests in the Message Batch that have expired.
This is zero until processing of the entire Message Batch has ended.
processing: int
Number of requests in the Message Batch that are processing.
succeeded: int
Number of requests in the Message Batch that have completed successfully.
This is zero until processing of the entire Message Batch has ended.
Processing result for this request.
Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.
Processing result for this request.
Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.
Accepts one of the following:
class BetaMessageBatchSucceededResult: …
class BetaMessageBatchSucceededResult: …
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)
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 loaded in the container
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)
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 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)"}]
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: …
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaThinkingBlock: …
class BetaThinkingBlock: …
signature: str
thinking: str
type: Literal["thinking"]
type: Literal["thinking"]
Accepts one of the following:
"thinking"
class BetaRedactedThinkingBlock: …
class BetaRedactedThinkingBlock: …
data: str
type: Literal["redacted_thinking"]
type: Literal["redacted_thinking"]
Accepts one of the following:
"redacted_thinking"
class BetaToolUseBlock: …
class BetaToolUseBlock: …
id: str
input: Dict[str, object]
name: str
minLength1
type: Literal["tool_use"]
type: Literal["tool_use"]
Accepts one of the following:
"tool_use"
class BetaServerToolUseBlock: …
class BetaServerToolUseBlock: …
id: str
input: Dict[str, object]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: Literal["server_tool_use"]
type: Literal["server_tool_use"]
Accepts one of the following:
"server_tool_use"
class BetaWebSearchToolResultBlock: …
class BetaWebSearchToolResultBlock: …
Accepts one of the following:
class BetaWebSearchToolResultError: …
class BetaWebSearchToolResultError: …
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"]
type: Literal["web_search_tool_result_error"]
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: str
page_age: Optional[str]
title: str
type: Literal["web_search_result"]
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"]
type: Literal["web_search_tool_result"]
Accepts one of the following:
"web_search_tool_result"
class BetaWebFetchToolResultBlock: …
class BetaWebFetchToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaWebFetchToolResultErrorBlock: …
class BetaWebFetchToolResultErrorBlock: …
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"]
type: Literal["web_fetch_tool_result_error"]
Accepts one of the following:
"web_fetch_tool_result_error"
class BetaWebFetchBlock: …
class BetaWebFetchBlock: …
citations: Optional[BetaCitationConfig]Citation configuration for the document
citations: Optional[BetaCitationConfig]
Citation configuration for the document
enabled: bool
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
title: Optional[str]
The title of the document
type: Literal["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"]
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"]
type: Literal["web_fetch_tool_result"]
Accepts one of the following:
"web_fetch_tool_result"
class BetaCodeExecutionToolResultBlock: …
class BetaCodeExecutionToolResultBlock: …
Accepts one of the following:
class BetaCodeExecutionToolResultError: …
class BetaCodeExecutionToolResultError: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
type: Literal["code_execution_tool_result_error"]
Accepts one of the following:
"code_execution_tool_result_error"
class BetaCodeExecutionResultBlock: …
class BetaCodeExecutionResultBlock: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
tool_use_id: str
type: Literal["code_execution_tool_result"]
type: Literal["code_execution_tool_result"]
Accepts one of the following:
"code_execution_tool_result"
class BetaBashCodeExecutionToolResultBlock: …
class BetaBashCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaBashCodeExecutionToolResultError: …
class BetaBashCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["bash_code_execution_tool_result_error"]
Accepts one of the following:
"bash_code_execution_tool_result_error"
class BetaBashCodeExecutionResultBlock: …
class BetaBashCodeExecutionResultBlock: …
file_id: str
type: Literal["bash_code_execution_output"]
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"]
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"]
type: Literal["bash_code_execution_tool_result"]
Accepts one of the following:
"bash_code_execution_tool_result"
class BetaTextEditorCodeExecutionToolResultBlock: …
class BetaTextEditorCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaTextEditorCodeExecutionToolResultError: …
class BetaTextEditorCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["text_editor_code_execution_tool_result_error"]
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
class BetaTextEditorCodeExecutionViewResultBlock: …
class BetaTextEditorCodeExecutionViewResultBlock: …
content: str
file_type: Literal["text", "image", "pdf"]
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"]
type: Literal["text_editor_code_execution_view_result"]
Accepts one of the following:
"text_editor_code_execution_view_result"
class BetaTextEditorCodeExecutionCreateResultBlock: …
class BetaTextEditorCodeExecutionCreateResultBlock: …
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
type: Literal["text_editor_code_execution_create_result"]
Accepts one of the following:
"text_editor_code_execution_create_result"
class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
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"]
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"]
type: Literal["text_editor_code_execution_tool_result"]
Accepts one of the following:
"text_editor_code_execution_tool_result"
class BetaMCPToolUseBlock: …
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"]
type: Literal["mcp_tool_use"]
Accepts one of the following:
"mcp_tool_use"
class BetaMCPToolResultBlock: …
class BetaMCPToolResultBlock: …
Accepts one of the following:
ContentUnionMember0 = str
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
is_error: bool
tool_use_id: str
type: Literal["mcp_tool_result"]
type: Literal["mcp_tool_result"]
Accepts one of the following:
"mcp_tool_result"
class BetaContainerUploadBlock: …Response model for a file uploaded to the container.
class BetaContainerUploadBlock: …
Response model for a file uploaded to the container.
file_id: str
type: Literal["container_upload"]
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.
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.
applied_edits: List[AppliedEdit]
List of context management edits that were applied.
Accepts one of the following:
class BetaClearToolUses20250919EditResponse: …
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.
type: Literal["clear_tool_uses_20250919"]
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
class BetaClearThinking20251015EditResponse: …
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.
type: Literal["clear_thinking_20251015"]
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
Accepts one of the following:
UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]The model that will complete your prompt.
See models for additional details and options.
claude-3-7-sonnet-latest - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-7-sonnet-20250219 - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-5-haiku-latest - Fastest and most compact model for near-instant 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
UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]
The model that will complete your prompt.
See models for additional details and options.
claude-3-7-sonnet-latest- Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-7-sonnet-20250219- Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-5-haiku-latest- Fastest and most compact model for near-instant 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
Accepts one of the following:
"claude-3-7-sonnet-latest"
High-performance model with early extended thinking
"claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
"claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
"claude-3-5-haiku-20241022"
Our fastest model
"claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
"claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
"claude-sonnet-4-20250514"
High-performance model with extended thinking
"claude-sonnet-4-0"
High-performance model with extended thinking
"claude-4-sonnet-20250514"
High-performance model with extended thinking
"claude-sonnet-4-5"
Our best model for real-world agents and coding
"claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
"claude-opus-4-0"
Our most capable model
"claude-opus-4-20250514"
Our most capable model
"claude-4-opus-20250514"
Our most capable model
"claude-opus-4-1-20250805"
Our most capable model
"claude-3-opus-latest"
Excels at writing and complex tasks
"claude-3-opus-20240229"
Excels at writing and complex tasks
"claude-3-haiku-20240307"
Our previous most fast and cost-effective
UnionMember1 = str
role: Literal["assistant"]Conversational role of the generated message.
This will always be "assistant".
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.
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.
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".
type: Literal["message"]
Object type.
For Messages, this is always "message".
Accepts one of the following:
"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.
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
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.
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.
service_tier: Optional[Literal["standard", "priority", "batch"]]
If the request used the priority, standard, or batch tier.
Accepts one of the following:
"standard"
"priority"
"batch"
type: Literal["succeeded"]
type: Literal["succeeded"]
Accepts one of the following:
"succeeded"
class BetaMessageBatchErroredResult: …
class BetaMessageBatchErroredResult: …
Accepts one of the following:
class BetaInvalidRequestError: …
class BetaInvalidRequestError: …
message: str
type: Literal["invalid_request_error"]
type: Literal["invalid_request_error"]
Accepts one of the following:
"invalid_request_error"
class BetaAuthenticationError: …
class BetaAuthenticationError: …
message: str
type: Literal["authentication_error"]
type: Literal["authentication_error"]
Accepts one of the following:
"authentication_error"
class BetaBillingError: …
class BetaBillingError: …
message: str
type: Literal["billing_error"]
type: Literal["billing_error"]
Accepts one of the following:
"billing_error"
class BetaPermissionError: …
class BetaPermissionError: …
message: str
type: Literal["permission_error"]
type: Literal["permission_error"]
Accepts one of the following:
"permission_error"
class BetaNotFoundError: …
class BetaNotFoundError: …
message: str
type: Literal["not_found_error"]
type: Literal["not_found_error"]
Accepts one of the following:
"not_found_error"
class BetaRateLimitError: …
class BetaRateLimitError: …
message: str
type: Literal["rate_limit_error"]
type: Literal["rate_limit_error"]
Accepts one of the following:
"rate_limit_error"
class BetaGatewayTimeoutError: …
class BetaGatewayTimeoutError: …
message: str
type: Literal["timeout_error"]
type: Literal["timeout_error"]
Accepts one of the following:
"timeout_error"
class BetaAPIError: …
class BetaAPIError: …
message: str
type: Literal["api_error"]
type: Literal["api_error"]
Accepts one of the following:
"api_error"
class BetaOverloadedError: …
class BetaOverloadedError: …
message: str
type: Literal["overloaded_error"]
type: Literal["overloaded_error"]
Accepts one of the following:
"overloaded_error"
request_id: Optional[str]
type: Literal["error"]
type: Literal["error"]
Accepts one of the following:
"error"
type: Literal["errored"]
type: Literal["errored"]
Accepts one of the following:
"errored"
class BetaMessageBatchCanceledResult: …
class BetaMessageBatchCanceledResult: …
type: Literal["canceled"]
type: Literal["canceled"]
Accepts one of the following:
"canceled"
class BetaMessageBatchExpiredResult: …
class BetaMessageBatchExpiredResult: …
type: Literal["expired"]
type: Literal["expired"]
Accepts one of the following:
"expired"
class BetaMessageBatchSucceededResult: …
class BetaMessageBatchSucceededResult: …
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)
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 loaded in the container
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)
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 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)"}]
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: …
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
class BetaThinkingBlock: …
class BetaThinkingBlock: …
signature: str
thinking: str
type: Literal["thinking"]
type: Literal["thinking"]
Accepts one of the following:
"thinking"
class BetaRedactedThinkingBlock: …
class BetaRedactedThinkingBlock: …
data: str
type: Literal["redacted_thinking"]
type: Literal["redacted_thinking"]
Accepts one of the following:
"redacted_thinking"
class BetaToolUseBlock: …
class BetaToolUseBlock: …
id: str
input: Dict[str, object]
name: str
minLength1
type: Literal["tool_use"]
type: Literal["tool_use"]
Accepts one of the following:
"tool_use"
class BetaServerToolUseBlock: …
class BetaServerToolUseBlock: …
id: str
input: Dict[str, object]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
name: Literal["web_search", "web_fetch", "code_execution", 2 more]
Accepts one of the following:
"web_search"
"web_fetch"
"code_execution"
"bash_code_execution"
"text_editor_code_execution"
type: Literal["server_tool_use"]
type: Literal["server_tool_use"]
Accepts one of the following:
"server_tool_use"
class BetaWebSearchToolResultBlock: …
class BetaWebSearchToolResultBlock: …
Accepts one of the following:
class BetaWebSearchToolResultError: …
class BetaWebSearchToolResultError: …
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"]
type: Literal["web_search_tool_result_error"]
Accepts one of the following:
"web_search_tool_result_error"
encrypted_content: str
page_age: Optional[str]
title: str
type: Literal["web_search_result"]
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"]
type: Literal["web_search_tool_result"]
Accepts one of the following:
"web_search_tool_result"
class BetaWebFetchToolResultBlock: …
class BetaWebFetchToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaWebFetchToolResultErrorBlock: …
class BetaWebFetchToolResultErrorBlock: …
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"]
type: Literal["web_fetch_tool_result_error"]
Accepts one of the following:
"web_fetch_tool_result_error"
class BetaWebFetchBlock: …
class BetaWebFetchBlock: …
citations: Optional[BetaCitationConfig]Citation configuration for the document
citations: Optional[BetaCitationConfig]
Citation configuration for the document
enabled: bool
source: Source
source: Source
Accepts one of the following:
class BetaBase64PDFSource: …
class BetaBase64PDFSource: …
data: str
formatbyte
media_type: Literal["application/pdf"]
media_type: Literal["application/pdf"]
Accepts one of the following:
"application/pdf"
type: Literal["base64"]
type: Literal["base64"]
Accepts one of the following:
"base64"
class BetaPlainTextSource: …
class BetaPlainTextSource: …
data: str
media_type: Literal["text/plain"]
media_type: Literal["text/plain"]
Accepts one of the following:
"text/plain"
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
title: Optional[str]
The title of the document
type: Literal["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"]
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"]
type: Literal["web_fetch_tool_result"]
Accepts one of the following:
"web_fetch_tool_result"
class BetaCodeExecutionToolResultBlock: …
class BetaCodeExecutionToolResultBlock: …
Accepts one of the following:
class BetaCodeExecutionToolResultError: …
class BetaCodeExecutionToolResultError: …
Accepts one of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
type: Literal["code_execution_tool_result_error"]
Accepts one of the following:
"code_execution_tool_result_error"
class BetaCodeExecutionResultBlock: …
class BetaCodeExecutionResultBlock: …
file_id: str
type: Literal["code_execution_output"]
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"]
type: Literal["code_execution_result"]
Accepts one of the following:
"code_execution_result"
tool_use_id: str
type: Literal["code_execution_tool_result"]
type: Literal["code_execution_tool_result"]
Accepts one of the following:
"code_execution_tool_result"
class BetaBashCodeExecutionToolResultBlock: …
class BetaBashCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaBashCodeExecutionToolResultError: …
class BetaBashCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["bash_code_execution_tool_result_error"]
Accepts one of the following:
"bash_code_execution_tool_result_error"
class BetaBashCodeExecutionResultBlock: …
class BetaBashCodeExecutionResultBlock: …
file_id: str
type: Literal["bash_code_execution_output"]
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"]
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"]
type: Literal["bash_code_execution_tool_result"]
Accepts one of the following:
"bash_code_execution_tool_result"
class BetaTextEditorCodeExecutionToolResultBlock: …
class BetaTextEditorCodeExecutionToolResultBlock: …
content: Content
content: Content
Accepts one of the following:
class BetaTextEditorCodeExecutionToolResultError: …
class BetaTextEditorCodeExecutionToolResultError: …
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", 2 more]
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"]
type: Literal["text_editor_code_execution_tool_result_error"]
Accepts one of the following:
"text_editor_code_execution_tool_result_error"
class BetaTextEditorCodeExecutionViewResultBlock: …
class BetaTextEditorCodeExecutionViewResultBlock: …
content: str
file_type: Literal["text", "image", "pdf"]
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"]
type: Literal["text_editor_code_execution_view_result"]
Accepts one of the following:
"text_editor_code_execution_view_result"
class BetaTextEditorCodeExecutionCreateResultBlock: …
class BetaTextEditorCodeExecutionCreateResultBlock: …
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
type: Literal["text_editor_code_execution_create_result"]
Accepts one of the following:
"text_editor_code_execution_create_result"
class BetaTextEditorCodeExecutionStrReplaceResultBlock: …
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"]
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"]
type: Literal["text_editor_code_execution_tool_result"]
Accepts one of the following:
"text_editor_code_execution_tool_result"
class BetaMCPToolUseBlock: …
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"]
type: Literal["mcp_tool_use"]
Accepts one of the following:
"mcp_tool_use"
class BetaMCPToolResultBlock: …
class BetaMCPToolResultBlock: …
Accepts one of the following:
ContentUnionMember0 = str
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.
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: …
class BetaCitationCharLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
type: Literal["char_location"]
Accepts one of the following:
"char_location"
class BetaCitationPageLocation: …
class BetaCitationPageLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
type: Literal["page_location"]
Accepts one of the following:
"page_location"
class BetaCitationContentBlockLocation: …
class BetaCitationContentBlockLocation: …
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_block_index: int
file_id: Optional[str]
start_block_index: int
minimum0
type: Literal["content_block_location"]
type: Literal["content_block_location"]
Accepts one of the following:
"content_block_location"
class BetaCitationsWebSearchResultLocation: …
class BetaCitationsWebSearchResultLocation: …
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
type: Literal["web_search_result_location"]
Accepts one of the following:
"web_search_result_location"
url: str
class BetaCitationSearchResultLocation: …
class BetaCitationSearchResultLocation: …
cited_text: str
end_block_index: int
search_result_index: int
minimum0
source: str
start_block_index: int
minimum0
title: Optional[str]
type: Literal["search_result_location"]
type: Literal["search_result_location"]
Accepts one of the following:
"search_result_location"
text: str
maxLength5000000
minLength0
type: Literal["text"]
type: Literal["text"]
Accepts one of the following:
"text"
is_error: bool
tool_use_id: str
type: Literal["mcp_tool_result"]
type: Literal["mcp_tool_result"]
Accepts one of the following:
"mcp_tool_result"
class BetaContainerUploadBlock: …Response model for a file uploaded to the container.
class BetaContainerUploadBlock: …
Response model for a file uploaded to the container.
file_id: str
type: Literal["container_upload"]
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.
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.
applied_edits: List[AppliedEdit]
List of context management edits that were applied.
Accepts one of the following:
class BetaClearToolUses20250919EditResponse: …
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.
type: Literal["clear_tool_uses_20250919"]
The type of context management edit applied.
Accepts one of the following:
"clear_tool_uses_20250919"
class BetaClearThinking20251015EditResponse: …
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.
type: Literal["clear_thinking_20251015"]
The type of context management edit applied.
Accepts one of the following:
"clear_thinking_20251015"
Accepts one of the following:
UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]The model that will complete your prompt.
See models for additional details and options.
claude-3-7-sonnet-latest - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-7-sonnet-20250219 - Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-5-haiku-latest - Fastest and most compact model for near-instant 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
UnionMember0 = Literal["claude-3-7-sonnet-latest", "claude-3-7-sonnet-20250219", "claude-3-5-haiku-latest", 15 more]
The model that will complete your prompt.
See models for additional details and options.
claude-3-7-sonnet-latest- Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-7-sonnet-20250219- Deprecated: Will reach end-of-life on February 19th, 2026. Please migrate to a newer model. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.claude-3-5-haiku-latest- Fastest and most compact model for near-instant 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
Accepts one of the following:
"claude-3-7-sonnet-latest"
High-performance model with early extended thinking
"claude-3-7-sonnet-20250219"
High-performance model with early extended thinking
"claude-3-5-haiku-latest"
Fastest and most compact model for near-instant responsiveness
"claude-3-5-haiku-20241022"
Our fastest model
"claude-haiku-4-5"
Hybrid model, capable of near-instant responses and extended thinking
"claude-haiku-4-5-20251001"
Hybrid model, capable of near-instant responses and extended thinking
"claude-sonnet-4-20250514"
High-performance model with extended thinking
"claude-sonnet-4-0"
High-performance model with extended thinking
"claude-4-sonnet-20250514"
High-performance model with extended thinking
"claude-sonnet-4-5"
Our best model for real-world agents and coding
"claude-sonnet-4-5-20250929"
Our best model for real-world agents and coding
"claude-opus-4-0"
Our most capable model
"claude-opus-4-20250514"
Our most capable model
"claude-4-opus-20250514"
Our most capable model
"claude-opus-4-1-20250805"
Our most capable model
"claude-3-opus-latest"
Excels at writing and complex tasks
"claude-3-opus-20240229"
Excels at writing and complex tasks
"claude-3-haiku-20240307"
Our previous most fast and cost-effective
UnionMember1 = str
role: Literal["assistant"]Conversational role of the generated message.
This will always be "assistant".
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.
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.
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".
type: Literal["message"]
Object type.
For Messages, this is always "message".
Accepts one of the following:
"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.
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
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.
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.
service_tier: Optional[Literal["standard", "priority", "batch"]]
If the request used the priority, standard, or batch tier.
Accepts one of the following:
"standard"
"priority"
"batch"
type: Literal["succeeded"]
type: Literal["succeeded"]
Accepts one of the following:
"succeeded"
BetaModels
List Models
beta.models.list(ModelListParams**kwargs) -> SyncPage[BetaModelInfo]
get/v1/models?beta=true
Get a Model
beta.models.retrieve(strmodel_id, ModelRetrieveParams**kwargs) -> BetaModelInfo
get/v1/models/{model_id}?beta=true
ModelsExpand Collapse
class BetaModelInfo: …
class BetaModelInfo: …
id: str
Unique model identifier.
created_at: datetime
RFC 3339 datetime string representing the time at which the model was released. May be set to an epoch value if the release date is unknown.
formatdate-time
display_name: str
A human-readable name for the model.
type: Literal["model"]Object type.
For Models, this is always "model".
type: Literal["model"]
Object type.
For Models, this is always "model".
Accepts one of the following:
"model"
BetaSkills
Create Skill
beta.skills.create(SkillCreateParams**kwargs) -> SkillCreateResponse
post/v1/skills?beta=true
Delete Skill
beta.skills.delete(strskill_id, SkillDeleteParams**kwargs) -> SkillDeleteResponse
delete/v1/skills/{skill_id}?beta=true
List Skills
beta.skills.list(SkillListParams**kwargs) -> SyncPageCursor[SkillListResponse]
get/v1/skills?beta=true
Get Skill
beta.skills.retrieve(strskill_id, SkillRetrieveParams**kwargs) -> SkillRetrieveResponse
get/v1/skills/{skill_id}?beta=true
BetaSkillsVersions
Create Skill Version
beta.skills.versions.create(strskill_id, VersionCreateParams**kwargs) -> VersionCreateResponse
post/v1/skills/{skill_id}/versions?beta=true
Delete Skill Version
beta.skills.versions.delete(strversion, VersionDeleteParams**kwargs) -> VersionDeleteResponse
delete/v1/skills/{skill_id}/versions/{version}?beta=true
List Skill Versions
beta.skills.versions.list(strskill_id, VersionListParams**kwargs) -> SyncPageCursor[VersionListResponse]
get/v1/skills/{skill_id}/versions?beta=true
Get Skill Version
beta.skills.versions.retrieve(strversion, VersionRetrieveParams**kwargs) -> VersionRetrieveResponse
get/v1/skills/{skill_id}/versions/{version}?beta=true